Class: Twilio::REST::Messaging::V1::ServiceContext::DestinationAlphaSenderInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ DestinationAlphaSenderInstance

Initialize the DestinationAlphaSenderInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this DestinationAlphaSender resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 484

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'alpha_sender' => payload['alpha_sender'],
        'capabilities' => payload['capabilities'],
        'url' => payload['url'],
        'iso_country_code' => payload['iso_country_code'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the AlphaSender resource.

Returns:



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

def 
    @properties['account_sid']
end

#alpha_sender ⇒ String

Returns The Alphanumeric Sender ID string.

Returns:

  • (String) —

    The Alphanumeric Sender ID string.



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

def alpha_sender
    @properties['alpha_sender']
end

#capabilities ⇒ Array<String>

Returns An array of values that describe whether the number can receive calls or messages. Can be: SMS.

Returns:

  • (Array<String>) —

    An array of values that describe whether the number can receive calls or messages. Can be: SMS.



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

def capabilities
    @properties['capabilities']
end

#context ⇒ DestinationAlphaSenderContext

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

Returns:



510
511
512
513
514
515
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 510

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DestinationAlphaSenderInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



574
575
576
577
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 574

def delete

    context.delete
end

#fetch ⇒ DestinationAlphaSenderInstance

Fetch the DestinationAlphaSenderInstance

Returns:



582
583
584
585
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 582

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



596
597
598
599
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 596

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

#iso_country_code ⇒ String

Returns The Two Character ISO Country Code the Alphanumeric Sender ID will be used for. For Default Alpha Senders that work across countries, this value will be an empty string.

Returns:

  • (String) —

    The Two Character ISO Country Code the Alphanumeric Sender ID will be used for. For Default Alpha Senders that work across countries, this value will be an empty string



567
568
569
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 567

def iso_country_code
    @properties['iso_country_code']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the AlphaSender resource.

Returns:

  • (String) —

    The unique string that we created to identify the AlphaSender resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



589
590
591
592
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 589

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

#url ⇒ String

Returns The absolute URL of the AlphaSender resource.

Returns:

  • (String) —

    The absolute URL of the AlphaSender resource.



561
562
563
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 561

def url
    @properties['url']
end