Class: Twilio::REST::Api::V2010::AccountContext::CallContext::RecordingList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, call_sid: nil) ⇒ RecordingList

Initialize the RecordingList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The SID of the Account that created the Recording resource.

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

    The SID of the Call the Recording resource is associated with.


26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 26

def initialize(version, account_sid: nil, call_sid: nil)
  super(version)

  # Path Solution
  @solution = {account_sid: , call_sid: call_sid}
  @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Recordings.json"
end

Instance Method Details

#create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset, recording_track: :unset) ⇒ RecordingInstance

Create the RecordingInstance

Parameters:

  • recording_status_callback_event (Array[String]) (defaults to: :unset) —

    The recording status events on which we should call the `recording_status_callback` URL. Can be: `in-progress`, `completed` and `absent` and the default is `completed`. Separate multiple event values with a space.

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

    The URL we should call using the `recording_status_callback_method` on each recording event specified in `recording_status_callback_event`. For more information, see RecordingStatusCallback parameters.

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

    The HTTP method we should use to call `recording_status_callback`. Can be: `GET` or `POST` and the default is `POST`.

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

    Whether to trim any leading and trailing silence in the recording. Can be: `trim-silence` or `do-not-trim` and the default is `do-not-trim`. `trim-silence` trims the silence from the beginning and end of the recording and `do-not-trim` does not.

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

    The number of channels used in the recording. Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties of the call into one channel. `dual` records each party of a 2-party call into separate channels.

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

    The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio.

Returns:


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 61

def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset, recording_track: :unset)
  data = Twilio::Values.of({
      'RecordingStatusCallbackEvent' => Twilio.serialize_list(recording_status_callback_event) { |e| e },
      'RecordingStatusCallback' => recording_status_callback,
      'RecordingStatusCallbackMethod' => recording_status_callback_method,
      'Trim' => trim,
      'RecordingChannels' => recording_channels,
      'RecordingTrack' => recording_track,
  })

  payload = @version.create('POST', @uri, data: data)

  RecordingInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      call_sid: @solution[:call_sid],
  )
end

#each ⇒ Object

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


136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 136

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 RecordingInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of RecordingInstance


176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 176

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

#list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • date_created_before (Time) (defaults to: :unset) —

    The `YYYY-MM-DD` value of the resources to read

  • date_created (Time) (defaults to: :unset) —

    The `YYYY-MM-DD` value of the resources to read

  • date_created_after (Time) (defaults to: :unset) —

    The `YYYY-MM-DD` value of the resources to read

  • 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


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

def list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, limit: nil, page_size: nil)
  self.stream(
      date_created_before: date_created_before,
      date_created: date_created,
      date_created_after: date_created_after,
      limit: limit,
      page_size: page_size
  ).entries
end

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

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

Parameters:

  • date_created_before (Time) (defaults to: :unset) —

    The `YYYY-MM-DD` value of the resources to read

  • date_created (Time) (defaults to: :unset) —

    The `YYYY-MM-DD` value of the resources to read

  • date_created_after (Time) (defaults to: :unset) —

    The `YYYY-MM-DD` value of the resources to read

  • 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 RecordingInstance


156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 156

def page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'DateCreated<' => Twilio.serialize_iso8601_date(date_created_before),
      'DateCreated' => Twilio.serialize_iso8601_date(date_created),
      'DateCreated>' => Twilio.serialize_iso8601_date(date_created_after),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • date_created_before (Time) (defaults to: :unset) —

    The `YYYY-MM-DD` value of the resources to read

  • date_created (Time) (defaults to: :unset) —

    The `YYYY-MM-DD` value of the resources to read

  • date_created_after (Time) (defaults to: :unset) —

    The `YYYY-MM-DD` value of the resources to read

  • 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


119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 119

def stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      date_created_before: date_created_before,
      date_created: date_created,
      date_created_after: date_created_after,
      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


186
187
188
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/recording.rb', line 186

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