twilio-ruby 4.13.0 → 5.40.0

data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb

@@ -0,0 +1,510 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class CallContext < InstanceContext
+            class RecordingList < ListResource
+              ##
+              # Initialize the RecordingList
+              # @param [Version] version Version that contains the resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   Recording resource.
+              # @param [String] call_sid The SID of the
+              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) the Recording
+              #   resource is associated with.
+              # @return [RecordingList] RecordingList
+              def initialize(version, account_sid: nil, call_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, call_sid: call_sid}
+                @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Recordings.json"
+              end
+
+              ##
+              # Create the RecordingInstance
+              # @param [String] recording_status_callback_event 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.
+              # @param [String] recording_status_callback 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](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback).
+              # @param [String] recording_status_callback_method The HTTP method we should use
+              #   to call `recording_status_callback`. Can be: `GET` or `POST` and the default is
+              #   `POST`.
+              # @param [String] trim 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.
+              # @param [String] recording_channels 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.
+              # @return [RecordingInstance] Created RecordingInstance
+              def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :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,
+                })
+
+                payload = @version.create('POST', @uri, data: data)
+
+                RecordingInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # Lists RecordingInstance records from the API as a list.
+              # Unlike stream(), this operation is eager and will load `limit` records into
+              # memory before returning.
+              # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
+              # @param [Integer] limit Upper limit for the number of records to return. stream()
+              #    guarantees to never return more than limit.  Default is no limit
+              # @param [Integer] page_size 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)
+              # @return [Array] Array of up to limit results
+              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
+
+              ##
+              # Streams RecordingInstance records from the API as an Enumerable.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
+              # @param [Integer] limit Upper limit for the number of records to return. stream()
+              #    guarantees to never return more than limit. Default is no limit.
+              # @param [Integer] page_size 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)
+              # @return [Enumerable] Enumerable that will yield up to limit results
+              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
+
+              ##
+              # When passed a block, yields RecordingInstance records from the API.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              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
+
+              ##
+              # Retrieve a single page of RecordingInstance records from the API.
+              # Request is executed immediately.
+              # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
+              # @param [String] page_token PageToken provided by the API
+              # @param [Integer] page_number Page Number, this value is simply for client state
+              # @param [Integer] page_size Number of records to return, defaults to 50
+              # @return [Page] Page of RecordingInstance
+              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
+
+              ##
+              # Retrieve a single page of RecordingInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] target_url API-generated URL for the requested results page
+              # @return [Page] Page of RecordingInstance
+              def get_page(target_url)
+                response = @version.domain.request(
+                    'GET',
+                    target_url
+                )
+                RecordingPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Api.V2010.RecordingList>'
+              end
+            end
+
+            class RecordingPage < Page
+              ##
+              # Initialize the RecordingPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [RecordingPage] RecordingPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of RecordingInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [RecordingInstance] RecordingInstance
+              def get_instance(payload)
+                RecordingInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Api.V2010.RecordingPage>'
+              end
+            end
+
+            class RecordingContext < InstanceContext
+              ##
+              # Initialize the RecordingContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   Recording resource to fetch.
+              # @param [String] call_sid The
+              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource
+              #   to fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Recording resource to fetch.
+              # @return [RecordingContext] RecordingContext
+              def initialize(version, account_sid, call_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, call_sid: call_sid, sid: sid, }
+                @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Recordings/#{@solution[:sid]}.json"
+              end
+
+              ##
+              # Update the RecordingInstance
+              # @param [recording.Status] status The new status of the recording. Can be:
+              #   `stopped`, `paused`, `in-progress`.
+              # @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
+              #   or `silence` and the default is `silence`. `skip` does not record during the
+              #   pause period, while `silence` will replace the actual audio of the call with
+              #   silence during the pause period. This parameter only applies when setting
+              #   `status` is set to `paused`.
+              # @return [RecordingInstance] Updated RecordingInstance
+              def update(status: nil, pause_behavior: :unset)
+                data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
+
+                payload = @version.update('POST', @uri, data: data)
+
+                RecordingInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Fetch the RecordingInstance
+              # @return [RecordingInstance] Fetched RecordingInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                RecordingInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Delete the RecordingInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                 @version.delete('DELETE', @uri)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.RecordingContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.RecordingContext #{context}>"
+              end
+            end
+
+            class RecordingInstance < InstanceResource
+              ##
+              # Initialize the RecordingInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   Recording resource.
+              # @param [String] call_sid The SID of the
+              #   [Call](https://www.twilio.com/docs/voice/api/call-resource) the Recording
+              #   resource is associated with.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Recording resource to fetch.
+              # @return [RecordingInstance] RecordingInstance
+              def initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'api_version' => payload['api_version'],
+                    'call_sid' => payload['call_sid'],
+                    'conference_sid' => payload['conference_sid'],
+                    'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                    'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
+                    'duration' => payload['duration'],
+                    'sid' => payload['sid'],
+                    'price' => payload['price'].to_f,
+                    'uri' => payload['uri'],
+                    'encryption_details' => payload['encryption_details'],
+                    'price_unit' => payload['price_unit'],
+                    'status' => payload['status'],
+                    'channels' => payload['channels'].to_i,
+                    'source' => payload['source'],
+                    'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'account_sid' => account_sid, 'call_sid' => call_sid, 'sid' => sid || @properties['sid'], }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [RecordingContext] RecordingContext for this RecordingInstance
+              def context
+                unless @instance_context
+                  @instance_context = RecordingContext.new(
+                      @version,
+                      @params['account_sid'],
+                      @params['call_sid'],
+                      @params['sid'],
+                  )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the resource
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The API version used to make the recording
+              def api_version
+                @properties['api_version']
+              end
+
+              ##
+              # @return [String] The SID of the Call the resource is associated with
+              def call_sid
+                @properties['call_sid']
+              end
+
+              ##
+              # @return [String] The Conference SID that identifies the conference associated with the recording
+              def conference_sid
+                @properties['conference_sid']
+              end
+
+              ##
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # @return [Time] The start time of the recording, given in RFC 2822 format
+              def start_time
+                @properties['start_time']
+              end
+
+              ##
+              # @return [String] The length of the recording in seconds
+              def duration
+                @properties['duration']
+              end
+
+              ##
+              # @return [String] The unique string that identifies the resource
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [String] The one-time cost of creating the recording.
+              def price
+                @properties['price']
+              end
+
+              ##
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
+              def uri
+                @properties['uri']
+              end
+
+              ##
+              # @return [Hash] How to decrypt the recording.
+              def encryption_details
+                @properties['encryption_details']
+              end
+
+              ##
+              # @return [String] The currency used in the price property.
+              def price_unit
+                @properties['price_unit']
+              end
+
+              ##
+              # @return [recording.Status] The status of the recording
+              def status
+                @properties['status']
+              end
+
+              ##
+              # @return [String] The number of channels in the final recording file
+              def channels
+                @properties['channels']
+              end
+
+              ##
+              # @return [recording.Source] How the recording was created
+              def source
+                @properties['source']
+              end
+
+              ##
+              # @return [String] More information about why the recording is missing, if status is `absent`.
+              def error_code
+                @properties['error_code']
+              end
+
+              ##
+              # Update the RecordingInstance
+              # @param [recording.Status] status The new status of the recording. Can be:
+              #   `stopped`, `paused`, `in-progress`.
+              # @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
+              #   or `silence` and the default is `silence`. `skip` does not record during the
+              #   pause period, while `silence` will replace the actual audio of the call with
+              #   silence during the pause period. This parameter only applies when setting
+              #   `status` is set to `paused`.
+              # @return [RecordingInstance] Updated RecordingInstance
+              def update(status: nil, pause_behavior: :unset)
+                context.update(status: status, pause_behavior: pause_behavior, )
+              end
+
+              ##
+              # Fetch the RecordingInstance
+              # @return [RecordingInstance] Fetched RecordingInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Delete the RecordingInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                context.delete
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.RecordingInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.RecordingInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end