Class: Twilio::REST::Messaging::V1::ServiceContext::UsAppToPersonInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, messaging_service_sid: nil, sid: nil) ⇒ UsAppToPersonInstance

Initialize the UsAppToPersonInstance



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 279

def initialize(version, payload , messaging_service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'brand_registration_sid' => payload['brand_registration_sid'],
        'messaging_service_sid' => payload['messaging_service_sid'],
        'description' => payload['description'],
        'message_samples' => payload['message_samples'],
        'us_app_to_person_usecase' => payload['us_app_to_person_usecase'],
        'has_embedded_links' => payload['has_embedded_links'],
        'has_embedded_phone' => payload['has_embedded_phone'],
        'campaign_status' => payload['campaign_status'],
        'campaign_id' => payload['campaign_id'],
        'is_externally_registered' => payload['is_externally_registered'],
        'rate_limits' => payload['rate_limits'],
        'message_flow' => payload['message_flow'],
        'opt_in_message' => payload['opt_in_message'],
        'opt_out_message' => payload['opt_out_message'],
        'help_message' => payload['help_message'],
        'opt_in_keywords' => payload['opt_in_keywords'],
        'opt_out_keywords' => payload['opt_out_keywords'],
        'help_keywords' => payload['help_keywords'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'mock' => payload['mock'],
    }

    # Context
    @instance_context = nil
    @params = { 'messaging_service_sid' => messaging_service_sid  || @properties['messaging_service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sidString



334
335
336
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 334

def 
    @properties['account_sid']
end

#brand_registration_sidString



340
341
342
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 340

def brand_registration_sid
    @properties['brand_registration_sid']
end

#campaign_idString



388
389
390
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 388

def campaign_id
    @properties['campaign_id']
end

#campaign_statusString



382
383
384
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 382

def campaign_status
    @properties['campaign_status']
end

#contextUsAppToPersonContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



319
320
321
322
323
324
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 319

def context
    unless @instance_context
        @instance_context = UsAppToPersonContext.new(@version , @params['messaging_service_sid'], @params['sid'])
    end
    @instance_context
end

#date_createdTime



448
449
450
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 448

def date_created
    @properties['date_created']
end

#date_updatedTime



454
455
456
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 454

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the UsAppToPersonInstance



473
474
475
476
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 473

def delete

    context.delete
end

#descriptionString



352
353
354
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 352

def description
    @properties['description']
end

#fetchUsAppToPersonInstance

Fetch the UsAppToPersonInstance



481
482
483
484
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 481

def fetch

    context.fetch
end


370
371
372
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 370

def has_embedded_links
    @properties['has_embedded_links']
end

#has_embedded_phoneBoolean



376
377
378
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 376

def has_embedded_phone
    @properties['has_embedded_phone']
end

#help_keywordsArray<String>



442
443
444
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 442

def help_keywords
    @properties['help_keywords']
end

#help_messageString



424
425
426
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 424

def help_message
    @properties['help_message']
end

#inspectObject

Provide a detailed, user friendly representation



495
496
497
498
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 495

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V1.UsAppToPersonInstance #{values}>"
end

#is_externally_registeredBoolean



394
395
396
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 394

def is_externally_registered
    @properties['is_externally_registered']
end

#message_flowString



406
407
408
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 406

def message_flow
    @properties['message_flow']
end

#message_samplesArray<String>



358
359
360
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 358

def message_samples
    @properties['message_samples']
end

#messaging_service_sidString



346
347
348
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 346

def messaging_service_sid
    @properties['messaging_service_sid']
end

#mockBoolean



466
467
468
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 466

def mock
    @properties['mock']
end

#opt_in_keywordsArray<String>



430
431
432
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 430

def opt_in_keywords
    @properties['opt_in_keywords']
end

#opt_in_messageString



412
413
414
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 412

def opt_in_message
    @properties['opt_in_message']
end

#opt_out_keywordsArray<String>



436
437
438
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 436

def opt_out_keywords
    @properties['opt_out_keywords']
end

#opt_out_messageString



418
419
420
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 418

def opt_out_message
    @properties['opt_out_message']
end

#rate_limitsHash



400
401
402
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 400

def rate_limits
    @properties['rate_limits']
end

#sidString



328
329
330
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 328

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



488
489
490
491
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 488

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V1.UsAppToPersonInstance #{values}>"
end

#urlString



460
461
462
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 460

def url
    @properties['url']
end

#us_app_to_person_usecaseString



364
365
366
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 364

def us_app_to_person_usecase
    @properties['us_app_to_person_usecase']
end