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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 333

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'],
        'subscriber_opt_in' => payload['subscriber_opt_in'],
        'age_gated' => payload['age_gated'],
        'direct_lending' => payload['direct_lending'],
        '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'],
        'errors' => payload['errors'],
    }

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

Instance Method Details

#account_sid ⇒ String 



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

def 
    @properties['account_sid']
end

#age_gated ⇒ Boolean 



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

def age_gated
    @properties['age_gated']
end

#brand_registration_sid ⇒ String 



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

def brand_registration_sid
    @properties['brand_registration_sid']
end

#campaign_id ⇒ String 



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

def campaign_id
    @properties['campaign_id']
end

#campaign_status ⇒ String 



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

def campaign_status
    @properties['campaign_status']
end

#context ⇒ UsAppToPersonContext

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



377
378
379
380
381
382
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 377

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

#date_created ⇒ Time 



524
525
526
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 524

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



530
531
532
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 530

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UsAppToPersonInstance



555
556
557
558
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 555

def delete

    context.delete
end

#description ⇒ String 



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

def description
    @properties['description']
end

#direct_lending ⇒ Boolean 



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

def direct_lending
    @properties['direct_lending']
end

#errors ⇒ Array<Hash> 



548
549
550
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 548

def errors
    @properties['errors']
end

#fetch ⇒ UsAppToPersonInstance

Fetch the UsAppToPersonInstance



563
564
565
566
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 563

def fetch

    context.fetch
end

#has_embedded_links ⇒ Boolean 



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

def has_embedded_links
    @properties['has_embedded_links']
end

#has_embedded_phone ⇒ Boolean 



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

def has_embedded_phone
    @properties['has_embedded_phone']
end

#help_keywords ⇒ Array<String> 



518
519
520
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 518

def help_keywords
    @properties['help_keywords']
end

#help_message ⇒ String 



500
501
502
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 500

def help_message
    @properties['help_message']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



608
609
610
611
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 608

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

#is_externally_registered ⇒ Boolean 



470
471
472
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 470

def is_externally_registered
    @properties['is_externally_registered']
end

#message_flow ⇒ String 



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

def message_flow
    @properties['message_flow']
end

#message_samples ⇒ Array<String> 



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

def message_samples
    @properties['message_samples']
end

#messaging_service_sid ⇒ String 



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

def messaging_service_sid
    @properties['messaging_service_sid']
end

#mock ⇒ Boolean 



542
543
544
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 542

def mock
    @properties['mock']
end

#opt_in_keywords ⇒ Array<String> 



506
507
508
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 506

def opt_in_keywords
    @properties['opt_in_keywords']
end

#opt_in_message ⇒ String 



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

def opt_in_message
    @properties['opt_in_message']
end

#opt_out_keywords ⇒ Array<String> 



512
513
514
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 512

def opt_out_keywords
    @properties['opt_out_keywords']
end

#opt_out_message ⇒ String 



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

def opt_out_message
    @properties['opt_out_message']
end

#rate_limits ⇒ Hash 



476
477
478
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 476

def rate_limits
    @properties['rate_limits']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#subscriber_opt_in ⇒ Boolean 



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

def subscriber_opt_in
    @properties['subscriber_opt_in']
end

#to_s ⇒ Object

Provide a user friendly representation



601
602
603
604
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 601

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

#update(has_embedded_links: nil, has_embedded_phone: nil, message_samples: nil, message_flow: nil, description: nil, age_gated: nil, direct_lending: nil) ⇒ UsAppToPersonInstance

Update the UsAppToPersonInstance



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 578

def update(
    has_embedded_links: nil, 
    has_embedded_phone: nil, 
    message_samples: nil, 
    message_flow: nil, 
    description: nil, 
    age_gated: nil, 
    direct_lending: nil
)

    context.update(
        has_embedded_links: has_embedded_links, 
        has_embedded_phone: has_embedded_phone, 
        message_samples: message_samples, 
        message_flow: message_flow, 
        description: description, 
        age_gated: age_gated, 
        direct_lending: direct_lending, 
    )
end

#url ⇒ String 



536
537
538
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 536

def url
    @properties['url']
end

#us_app_to_person_usecase ⇒ String 



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

def us_app_to_person_usecase
    @properties['us_app_to_person_usecase']
end