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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, reference_sid: nil, add_on_result_sid: nil) ⇒ PayloadList

Initialize the PayloadList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The SID of the Account that created the Recording AddOnResult Payload resource.

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

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

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

    The SID of the AddOnResult to which the payload belongs.


28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 28

def initialize(version, account_sid: nil, reference_sid: nil, add_on_result_sid: nil)
  super(version)

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

Instance Method Details

#each ⇒ Object

When passed a block, yields PayloadInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


78
79
80
81
82
83
84
85
86
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 78

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of PayloadInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of PayloadInstance


112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 112

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  PayloadPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists PayloadInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results


51
52
53
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 51

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of PayloadInstance records from the API. Request is executed immediately.

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of PayloadInstance


95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 95

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  PayloadPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams PayloadInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results


66
67
68
69
70
71
72
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 66

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation


122
123
124
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 122

def to_s
  '#<Twilio.Api.V2010.PayloadList>'
end