## # This code was generated by # ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ # | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ # | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ # # Twilio - Api # This is the public Twilio REST API. # # NOTE: This class is auto generated by OpenAPI Generator. # https://openapi-generator.tech # Do not edit the class manually. # module Twilio module REST class Api < ApiBase class V2010 < Version class AccountContext < InstanceContext class RecordingList < ListResource ## # Initialize the RecordingList # @param [Version] version Version that contains the resource # @return [RecordingList] RecordingList def initialize(version, account_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid } @uri = "/Accounts/#{@solution[:account_sid]}/Recordings.json" 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 Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date. # @param [Time] date_created_before Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date. # @param [Time] date_created_after Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date. # @param [String] call_sid The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read. # @param [String] conference_sid The Conference SID that identifies the conference associated with the recording to read. # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days. # @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: :unset, date_created_before: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, include_soft_deleted: :unset, limit: nil, page_size: nil) self.stream( date_created: date_created, date_created_before: date_created_before, date_created_after: date_created_after, call_sid: call_sid, conference_sid: conference_sid, include_soft_deleted: include_soft_deleted, limit: limit, page_size: page_size ).entries end ## # Streams Instance 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 Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date. # @param [Time] date_created_before Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date. # @param [Time] date_created_after Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date. # @param [String] call_sid The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read. # @param [String] conference_sid The Conference SID that identifies the conference associated with the recording to read. # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days. # @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: :unset, date_created_before: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, include_soft_deleted: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( date_created: date_created, date_created_before: date_created_before, date_created_after: date_created_after, call_sid: call_sid, conference_sid: conference_sid, include_soft_deleted: include_soft_deleted, 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 Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date. # @param [Time] date_created_before Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date. # @param [Time] date_created_after Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date. # @param [String] call_sid The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read. # @param [String] conference_sid The Conference SID that identifies the conference associated with the recording to read. # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days. # @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: :unset, date_created_before: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, include_soft_deleted: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created), 'DateCreated<' => Twilio.serialize_iso8601_datetime(date_created_before), 'DateCreated>' => Twilio.serialize_iso8601_datetime(date_created_after), 'CallSid' => call_sid, 'ConferenceSid' => conference_sid, 'IncludeSoftDeleted' => include_soft_deleted, '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 '#' 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] sid The Twilio-provided string that uniquely identifies the Recording resource to fetch. # @return [RecordingContext] RecordingContext def initialize(version, account_sid, sid) super(version) # Path Solution @solution = { account_sid: account_sid, sid: sid, } @uri = "/Accounts/#{@solution[:account_sid]}/Recordings/#{@solution[:sid]}.json" # Dependents @add_on_results = nil @transcriptions = nil end ## # Delete the RecordingInstance # @return [Boolean] True if delete succeeds, false otherwise def delete @version.delete('DELETE', @uri) end ## # Fetch the RecordingInstance # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days. # @return [RecordingInstance] Fetched RecordingInstance def fetch( include_soft_deleted: :unset ) params = Twilio::Values.of({ 'IncludeSoftDeleted' => include_soft_deleted, }) payload = @version.fetch('GET', @uri, params: params) RecordingInstance.new( @version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], ) end ## # Access the add_on_results # @return [AddOnResultList] # @return [AddOnResultContext] if sid was passed. def add_on_results(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return AddOnResultContext.new(@version, @solution[:account_sid], @solution[:sid],sid ) end unless @add_on_results @add_on_results = AddOnResultList.new( @version, account_sid: @solution[:account_sid], reference_sid: @solution[:sid], ) end @add_on_results end ## # Access the transcriptions # @return [TranscriptionList] # @return [TranscriptionContext] if sid was passed. def transcriptions(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return TranscriptionContext.new(@version, @solution[:account_sid], @solution[:sid],sid ) end unless @transcriptions @transcriptions = TranscriptionList.new( @version, account_sid: @solution[:account_sid], recording_sid: @solution[:sid], ) end @transcriptions end ## # Provide a user friendly representation def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" end ## # Provide a detailed, user friendly representation def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" 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]) end ## # Provide a user friendly representation def to_s '' 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 this Recording # resource. # @param [String] sid The SID of the Call resource to fetch. # @return [RecordingInstance] RecordingInstance def initialize(version, payload , account_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'], 'price_unit' => payload['price_unit'], 'status' => payload['status'], 'channels' => payload['channels'] == nil ? payload['channels'] : payload['channels'].to_i, 'source' => payload['source'], 'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i, 'uri' => payload['uri'], 'encryption_details' => payload['encryption_details'], 'subresource_uris' => payload['subresource_uris'], 'media_url' => payload['media_url'], } # Context @instance_context = nil @params = { 'account_sid' => account_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] CallContext for this CallInstance def context unless @instance_context @instance_context = RecordingContext.new(@version , @params['account_sid'], @params['sid']) end @instance_context end ## # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource. def account_sid @properties['account_sid'] end ## # @return [String] The API version used during the recording. def api_version @properties['api_version'] end ## # @return [String] The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Recording resource is associated with. This will always refer to the parent leg of a two-leg call. def call_sid @properties['call_sid'] end ## # @return [String] The Conference SID that identifies the conference associated with the recording, if a conference recording. def conference_sid @properties['conference_sid'] end ## # @return [Time] The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. def date_created @properties['date_created'] end ## # @return [Time] The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. def date_updated @properties['date_updated'] end ## # @return [Time] The start time of the recording in GMT and in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) 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 that we created to identify the Recording resource. def sid @properties['sid'] end ## # @return [String] The one-time cost of creating the recording in the `price_unit` currency. def price @properties['price'] end ## # @return [String] The currency used in the `price` property. Example: `USD`. def price_unit @properties['price_unit'] end ## # @return [Status] def status @properties['status'] end ## # @return [String] The number of channels in the final recording file. Can be: `1` or `2`. You can split a call with two legs into two separate recording channels if you record using [TwiML Dial](https://www.twilio.com/docs/voice/twiml/dial#record) or the [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls#manage-your-outbound-call). def channels @properties['channels'] end ## # @return [Source] def source @properties['source'] end ## # @return [String] The error code that describes why the recording is `absent`. The error code is described in our [Error Dictionary](https://www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`. def error_code @properties['error_code'] 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 if it was encrypted using [Call Recording Encryption](https://www.twilio.com/docs/voice/tutorials/voice-recording-encryption) feature. def encryption_details @properties['encryption_details'] end ## # @return [Hash] A list of related resources identified by their relative URIs. def subresource_uris @properties['subresource_uris'] end ## # @return [String] The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file. def media_url @properties['media_url'] end ## # Delete the RecordingInstance # @return [Boolean] True if delete succeeds, false otherwise def delete context.delete end ## # Fetch the RecordingInstance # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days. # @return [RecordingInstance] Fetched RecordingInstance def fetch( include_soft_deleted: :unset ) context.fetch( include_soft_deleted: include_soft_deleted, ) end ## # Access the add_on_results # @return [add_on_results] add_on_results def add_on_results context.add_on_results end ## # Access the transcriptions # @return [transcriptions] transcriptions def transcriptions context.transcriptions end ## # Provide a user friendly representation def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "" end ## # Provide a detailed, user friendly representation def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "" end end end end end end end