Class: Twilio::REST::PreviewMessaging::V1::MessageInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/preview_messaging/v1/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ MessageInstance

Initialize the MessageInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/preview_messaging/v1/message.rb', line 175

def initialize(version, payload )
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'total_message_count' => payload['total_message_count'] == nil ? payload['total_message_count'] : payload['total_message_count'].to_i,
        'success_count' => payload['success_count'] == nil ? payload['success_count'] : payload['success_count'].to_i,
        'error_count' => payload['error_count'] == nil ? payload['error_count'] : payload['error_count'].to_i,
        'message_receipts' => payload['message_receipts'],
        'failed_message_receipts' => payload['failed_message_receipts'],
    }
end

Instance Method Details

#error_count ⇒ String

Returns The number of Messages unsuccessfully processed in the request.

Returns:

  • (String) —

    The number of Messages unsuccessfully processed in the request.



203
204
205
 
# File 'lib/twilio-ruby/rest/preview_messaging/v1/message.rb', line 203

def error_count
    @properties['error_count']
end

#failed_message_receipts ⇒ Array<MessagingV1FailedMessageReceipt>

Returns:

  • (Array<MessagingV1FailedMessageReceipt>) 


215
216
217
 
# File 'lib/twilio-ruby/rest/preview_messaging/v1/message.rb', line 215

def failed_message_receipts
    @properties['failed_message_receipts']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



227
228
229
 
# File 'lib/twilio-ruby/rest/preview_messaging/v1/message.rb', line 227

def inspect
    "<Twilio.PreviewMessaging.V1.MessageInstance>"
end

#message_receipts ⇒ Array<MessagingV1MessageReceipt>

Returns:

  • (Array<MessagingV1MessageReceipt>) 


209
210
211
 
# File 'lib/twilio-ruby/rest/preview_messaging/v1/message.rb', line 209

def message_receipts
    @properties['message_receipts']
end

#success_count ⇒ String

Returns The number of Messages successfully created.

Returns:

  • (String) —

    The number of Messages successfully created.



197
198
199
 
# File 'lib/twilio-ruby/rest/preview_messaging/v1/message.rb', line 197

def success_count
    @properties['success_count']
end

#to_s ⇒ Object

Provide a user friendly representation



221
222
223
 
# File 'lib/twilio-ruby/rest/preview_messaging/v1/message.rb', line 221

def to_s
    "<Twilio.PreviewMessaging.V1.MessageInstance>"
end

#total_message_count ⇒ String

Returns The number of Messages processed in the request, equal to the sum of success_count and error_count.

Returns:

  • (String) —

    The number of Messages processed in the request, equal to the sum of success_count and error_count.



191
192
193
 
# File 'lib/twilio-ruby/rest/preview_messaging/v1/message.rb', line 191

def total_message_count
    @properties['total_message_count']
end