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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb,
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: PayloadContext, PayloadInstance, PayloadInstanceMetadata, PayloadList, PayloadListResponse, PayloadPage, PayloadPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, reference_sid, sid) ⇒ AddOnResultContext

Initialize the AddOnResultContext

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 resource to fetch.

  • reference_sid (String) —

    The SID of the recording to which the result to fetch belongs.

  • sid (String) —

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



164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 164

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

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

    # Dependents
    @payloads = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the AddOnResultInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 178

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 AddOnResultInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 191

def delete_with_metadata

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

#fetch ⇒ AddOnResultInstance

Fetch the AddOnResultInstance

Returns:



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 210

def fetch

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

#fetch_with_metadata ⇒ AddOnResultInstance

Fetch the AddOnResultInstanceMetadata

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 231

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#payloads(sid = :unset) ⇒ PayloadList, PayloadContext

Access the payloads

Returns:

Raises:

  • (ArgumentError) 


259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 259

def payloads(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return PayloadContext.new(@version, @solution[:account_sid], @solution[:reference_sid], @solution[:sid],sid )
    end

    unless @payloads
        @payloads = PayloadList.new(
            @version, account_sid: @solution[:account_sid], reference_sid: @solution[:reference_sid], add_on_result_sid: @solution[:sid], )
    end

 @payloads
end

#to_s ⇒ Object

Provide a user friendly representation



277
278
279
280
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 277

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