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.



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 269

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:



309
310
311
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 309

def 
    @properties['account_sid']
end

#alpha_sender ⇒ String

Returns The Alphanumeric Sender ID string.

Returns:

  • (String) —

    The Alphanumeric Sender ID string.



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

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`.



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

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:



294
295
296
297
298
299
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 294

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:



321
322
323
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 321

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DestinationAlphaSenderInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ DestinationAlphaSenderInstance

Fetch the DestinationAlphaSenderInstance

Returns:



366
367
368
369
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 366

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



380
381
382
383
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 380

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



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

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:



315
316
317
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 315

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.



303
304
305
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 303

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



373
374
375
376
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb', line 373

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.



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

def url
    @properties['url']
end