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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 350

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 



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

def 
    @properties['account_sid']
end

#age_gated ⇒ Boolean 



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

def age_gated
    @properties['age_gated']
end

#brand_registration_sid ⇒ String 



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

def brand_registration_sid
    @properties['brand_registration_sid']
end

#campaign_id ⇒ String 



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

def campaign_id
    @properties['campaign_id']
end

#campaign_status ⇒ String 



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

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



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

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UsAppToPersonInstance



572
573
574
575
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 572

def delete

    context.delete
end

#description ⇒ String 



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

def description
    @properties['description']
end

#direct_lending ⇒ Boolean 



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

def direct_lending
    @properties['direct_lending']
end

#errors ⇒ Array<Hash> 



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

def errors
    @properties['errors']
end

#fetch ⇒ UsAppToPersonInstance

Fetch the UsAppToPersonInstance



580
581
582
583
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 580

def fetch

    context.fetch
end

#has_embedded_links ⇒ Boolean 



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

def has_embedded_links
    @properties['has_embedded_links']
end

#has_embedded_phone ⇒ Boolean 



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

def has_embedded_phone
    @properties['has_embedded_phone']
end

#help_keywords ⇒ Array<String> 



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

def help_keywords
    @properties['help_keywords']
end

#help_message ⇒ String 



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

def help_message
    @properties['help_message']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



625
626
627
628
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 625

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

#is_externally_registered ⇒ Boolean 



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

def is_externally_registered
    @properties['is_externally_registered']
end

#message_flow ⇒ String 



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

def message_flow
    @properties['message_flow']
end

#message_samples ⇒ Array<String> 



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

def message_samples
    @properties['message_samples']
end

#messaging_service_sid ⇒ String 



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

def messaging_service_sid
    @properties['messaging_service_sid']
end

#mock ⇒ Boolean 



559
560
561
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 559

def mock
    @properties['mock']
end

#opt_in_keywords ⇒ Array<String> 



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

def opt_in_keywords
    @properties['opt_in_keywords']
end

#opt_in_message ⇒ String 



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

def opt_in_message
    @properties['opt_in_message']
end

#opt_out_keywords ⇒ Array<String> 



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

def opt_out_keywords
    @properties['opt_out_keywords']
end

#opt_out_message ⇒ String 



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

def opt_out_message
    @properties['opt_out_message']
end

#rate_limits ⇒ Hash 



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

def rate_limits
    @properties['rate_limits']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#subscriber_opt_in ⇒ Boolean 



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

def subscriber_opt_in
    @properties['subscriber_opt_in']
end

#to_s ⇒ Object

Provide a user friendly representation



618
619
620
621
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 618

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



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 595

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 



553
554
555
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 553

def url
    @properties['url']
end

#us_app_to_person_usecase ⇒ String 



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

def us_app_to_person_usecase
    @properties['us_app_to_person_usecase']
end