Class: Twilio::REST::Conversations::V1::ConversationContext::MessageContext::DeliveryReceiptInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, conversation_sid: nil, message_sid: nil, sid: nil) ⇒ DeliveryReceiptInstance

Initialize the DeliveryReceiptInstance

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

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

    The SID of the Call resource to fetch.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 215

def initialize(version, payload , conversation_sid: nil, message_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'conversation_sid' => payload['conversation_sid'],
        'sid' => payload['sid'],
        'message_sid' => payload['message_sid'],
        'channel_message_sid' => payload['channel_message_sid'],
        'participant_sid' => payload['participant_sid'],
        'status' => payload['status'],
        'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
        '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 = { 'conversation_sid' => conversation_sid  || @properties['conversation_sid']  ,'message_sid' => message_sid  || @properties['message_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this participant.

Returns:



251
252
253
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 251

def 
    @properties['account_sid']
end

#channel_message_sid ⇒ String

Returns A messaging channel-specific identifier for the message delivered to participant e.g. ‘SMxx` for SMS, `WAxx` for Whatsapp etc.

Returns:

  • (String) —

    A messaging channel-specific identifier for the message delivered to participant e.g. ‘SMxx` for SMS, `WAxx` for Whatsapp etc.



275
276
277
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 275

def channel_message_sid
    @properties['channel_message_sid']
end

#context ⇒ DeliveryReceiptContext

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

Returns:



242
243
244
245
246
247
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 242

def context
    unless @instance_context
        @instance_context = DeliveryReceiptContext.new(@version , @params['conversation_sid'], @params['message_sid'], @params['sid'])
    end
    @instance_context
end

#conversation_sid ⇒ String

Returns The unique ID of the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for this message.

Returns:



257
258
259
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 257

def conversation_sid
    @properties['conversation_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



299
300
301
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 299

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated. ‘null` if the delivery receipt has not been updated.

Returns:

  • (Time) —

    The date that this resource was last updated. ‘null` if the delivery receipt has not been updated.



305
306
307
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 305

def date_updated
    @properties['date_updated']
end

#error_code ⇒ String

Returns The message [delivery error code](www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a ‘failed` status,.

Returns:



293
294
295
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 293

def error_code
    @properties['error_code']
end

#fetch ⇒ DeliveryReceiptInstance

Fetch the DeliveryReceiptInstance

Returns:



318
319
320
321
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 318

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



332
333
334
335
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 332

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

#message_sid ⇒ String

Returns The SID of the message within a [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.

Returns:



269
270
271
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 269

def message_sid
    @properties['message_sid']
end

#participant_sid ⇒ String

Returns The unique ID of the participant the delivery receipt belongs to.

Returns:

  • (String) —

    The unique ID of the participant the delivery receipt belongs to.



281
282
283
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 281

def participant_sid
    @properties['participant_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



263
264
265
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 263

def sid
    @properties['sid']
end

#status ⇒ DeliveryStatus

Returns:

  • (DeliveryStatus) 


287
288
289
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 287

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



325
326
327
328
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 325

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

#url ⇒ String

Returns An absolute API resource URL for this delivery receipt.

Returns:

  • (String) —

    An absolute API resource URL for this delivery receipt.



311
312
313
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb', line 311

def url
    @properties['url']
end