Class: Twilio::REST::Messaging::V1::ServiceContext::ChannelSenderInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ChannelSenderInstance

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 ChannelSender resource.

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

    The SID of the Call resource to fetch.



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 214

def initialize(version, payload , messaging_service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'messaging_service_sid' => payload['messaging_service_sid'],
        'sid' => payload['sid'],
        'sender' => payload['sender'],
        'sender_type' => payload['sender_type'],
        'country_code' => payload['country_code'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

    # 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

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

Returns:



248
249
250
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 248

def 
    @properties['account_sid']
end

#context ⇒ ChannelSenderContext

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

Returns:



239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 239

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

#country_code ⇒ String

Returns The 2-character [ISO Country Code](www.iso.org/iso-3166-country-codes.html) of the number.

Returns:



278
279
280
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 278

def country_code
    @properties['country_code']
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:



284
285
286
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 284

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:



290
291
292
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 290

def date_updated
    @properties['date_updated']
end

#fetch ⇒ ChannelSenderInstance

Fetch the ChannelSenderInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



317
318
319
320
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 317

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

#messaging_service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/messaging/services) the resource is associated with.

Returns:



254
255
256
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 254

def messaging_service_sid
    @properties['messaging_service_sid']
end

#sender ⇒ String

Returns The unique string that identifies the sender e.g whatsapp:+123456XXXX.

Returns:

  • (String) —

    The unique string that identifies the sender e.g whatsapp:+123456XXXX.



266
267
268
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 266

def sender
    @properties['sender']
end

#sender_type ⇒ String

Returns A string value that identifies the sender type e.g WhatsApp, Messenger.

Returns:

  • (String) —

    A string value that identifies the sender type e.g WhatsApp, Messenger.



272
273
274
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 272

def sender_type
    @properties['sender_type']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



260
261
262
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 260

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



310
311
312
313
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 310

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

#url ⇒ String

Returns:

  • (String) 


296
297
298
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 296

def url
    @properties['url']
end