Class: Twilio::REST::Api::V2010::AccountContext::RecordingContext::AddOnResultContext::PayloadContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload/data.rb

Defined Under Namespace

Classes: DataContext, DataInstance, DataInstanceMetadata, DataList, DataListResponse, DataPage, DataPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, reference_sid, add_on_result_sid, sid) ⇒ PayloadContext

Initialize the PayloadContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resource to fetch.

  • reference_sid (String) —

    The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.

  • add_on_result_sid (String) —

    The SID of the AddOnResult to which the payload to fetch belongs.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.



174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 174

def initialize(version, , reference_sid, add_on_result_sid, sid)
    super(version)
    

    # Path Solution
    @solution = { account_sid: , reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/Recordings/#{@solution[:reference_sid]}/AddOnResults/#{@solution[:add_on_result_sid]}/Payloads/#{@solution[:sid]}.json"

    # Dependents
    @data = nil
end

Instance Method Details

#data ⇒ DataList, DataContext

Access the data

Returns:



271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 271

def data
    DataContext.new(
            @version,
            @solution[:account_sid],
            @solution[:reference_sid],
            @solution[:add_on_result_sid],
            @solution[:sid]
            )
end

#delete ⇒ Boolean

Delete the PayloadInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



188
189
190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 188

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the PayloadInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 201

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      payload_instance = PayloadInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      PayloadInstanceMetadata.new(@version, payload_instance, response.headers, response.status_code)
end

#fetch ⇒ PayloadInstance

Fetch the PayloadInstance

Returns:



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 220

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    PayloadInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        reference_sid: @solution[:reference_sid],
        add_on_result_sid: @solution[:add_on_result_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ PayloadInstance

Fetch the PayloadInstanceMetadata

Returns:



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 242

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    payload_instance = PayloadInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        reference_sid: @solution[:reference_sid],
        add_on_result_sid: @solution[:add_on_result_sid],
        sid: @solution[:sid],
    )
    PayloadInstanceMetadata.new(
        @version,
        payload_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



290
291
292
293
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 290

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.PayloadContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



283
284
285
286
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 283

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.PayloadContext #{context}>"
end