twilio-ruby 6.8.0 → 7.10.7

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

@@ -0,0 +1,343 @@
+##
+#    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 RecordingContext < InstanceContext
+                class AddOnResultContext < InstanceContext
+                class PayloadContext < InstanceContext
+
+                     class DataList < ListResource
+                
+                    ##
+                    # Initialize the DataList
+                    # @param [Version] version Version that contains the resource
+                    # @return [DataList] DataList
+                    def initialize(version, account_sid: nil, reference_sid: nil, add_on_result_sid: nil, payload_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: payload_sid }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Api.V2010.DataList>'
+                    end
+                end
+
+
+                class DataContext < InstanceContext
+                    ##
+                    # Initialize the DataContext
+                    # @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 AddOnResult Payload resource to fetch.
+                    # @param [String] reference_sid The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.
+                    # @param [String] add_on_result_sid The SID of the AddOnResult to which the payload to fetch belongs.
+                    # @param [String] payload_sid The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.
+                    # @return [DataContext] DataContext
+                    def initialize(version, account_sid, reference_sid, add_on_result_sid, payload_sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: payload_sid,  }
+                        @uri = "/Accounts/#{@solution[:account_sid]}/Recordings/#{@solution[:reference_sid]}/AddOnResults/#{@solution[:add_on_result_sid]}/Payloads/#{@solution[:payload_sid]}/Data.json"
+
+                        
+                    end
+                    ##
+                    # Fetch the DataInstance
+                    # @return [DataInstance] Fetched DataInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        DataInstance.new(
+                            @version,
+                            payload,
+                            account_sid: @solution[:account_sid],
+                            reference_sid: @solution[:reference_sid],
+                            add_on_result_sid: @solution[:add_on_result_sid],
+                            payload_sid: @solution[:payload_sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the DataInstanceMetadata
+                    # @return [DataInstance] Fetched DataInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        data_instance = DataInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            reference_sid: @solution[:reference_sid],
+                            add_on_result_sid: @solution[:add_on_result_sid],
+                            payload_sid: @solution[:payload_sid],
+                        )
+                        DataInstanceMetadata.new(
+                            @version,
+                            data_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Api.V2010.DataContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Api.V2010.DataContext #{context}>"
+                    end
+                end
+
+                class DataInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new DataInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}DataInstance] data_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [DataInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, data_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @data_instance = data_instance
+                    end
+
+                    def data
+                        @data_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.DataInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class DataListResponse < InstanceListResource
+                    # @param [Array<DataInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @data_instance = payload.body[key].map do |data|
+                        DataInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def data_instance
+                          @instance
+                      end
+                  end
+
+                class DataPage < Page
+                    ##
+                    # Initialize the DataPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [DataPage] DataPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of DataInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [DataInstance] DataInstance
+                    def get_instance(payload)
+                        DataInstance.new(@version, payload, account_sid: @solution[:account_sid], reference_sid: @solution[:reference_sid], add_on_result_sid: @solution[:add_on_result_sid], payload_sid: @solution[:payload_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Api.V2010.DataPage>'
+                    end
+                end
+
+                class DataPageMetadata < PageMetadata
+                    attr_reader :data_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @data_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @data_page << DataListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @data_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class DataListResponse < InstanceListResource
+
+                    # @param [Array<DataInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @data = data_list.map do |data|
+                        DataInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def data
+                        @data
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class DataInstance < InstanceResource
+                    ##
+                    # Initialize the DataInstance
+                    # @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 Data
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [DataInstance] DataInstance
+                    def initialize(version, payload , account_sid: nil, reference_sid: nil, add_on_result_sid: nil, payload_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'redirect_to' => payload['redirect_to'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'account_sid' => account_sid  ,'reference_sid' => reference_sid  || @properties['reference_sid']  ,'add_on_result_sid' => add_on_result_sid  || @properties['add_on_result_sid']  ,'payload_sid' => payload_sid  || @properties['payload_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 [DataContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = DataContext.new(@version , @params['account_sid'], @params['reference_sid'], @params['add_on_result_sid'], @params['payload_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The URL to redirect to to get the data returned by the AddOn that was previously stored.
+                    def redirect_to
+                        @properties['redirect_to']
+                    end
+                    
+                    ##
+                    # Fetch the DataInstance
+                    # @return [DataInstance] Fetched DataInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Api.V2010.DataInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Api.V2010.DataInstance #{values}>"
+                    end
+                end
+
+             end
+             end
+             end
+             end
+            end
+        end
+    end
+end
+
+

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

@@ -22,12 +22,14 @@ module Twilio
                 class AddOnResultContext < InstanceContext
 
                      class PayloadList < ListResource
+                
                     ##
                     # Initialize the PayloadList
                     # @param [Version] version Version that contains the resource
                     # @return [PayloadList] PayloadList
                     def initialize(version, account_sid: nil, reference_sid: nil, add_on_result_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: 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"
@@ -69,7 +71,33 @@ module Twilio
                         page = self.page(
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists PayloadPageMetadata records from the API as a list.
+                    # @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_with_metadata(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        PayloadPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -81,9 +109,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -93,14 +125,17 @@ module Twilio
                     # @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 PayloadInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         PayloadPage.new(@version, response, @solution)
                     end
@@ -138,19 +173,45 @@ module Twilio
                     # @return [PayloadContext] PayloadContext
                     def initialize(version, account_sid, reference_sid, add_on_result_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, sid: sid,  }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Recordings/#{@solution[:reference_sid]}/AddOnResults/#{@solution[:add_on_result_sid]}/Payloads/#{@solution[:sid]}.json"
 
-                        
+                        # Dependents
+                        @data = nil
                     end
                     ##
                     # Delete the PayloadInstance
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the PayloadInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          payload_instance = PayloadInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          PayloadInstanceMetadata.new(@version, payload_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -158,7 +219,13 @@ module Twilio
                     # @return [PayloadInstance] Fetched PayloadInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         PayloadInstance.new(
                             @version,
                             payload,
@@ -169,6 +236,47 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the PayloadInstanceMetadata
+                    # @return [PayloadInstance] Fetched PayloadInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        payload_instance = PayloadInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            reference_sid: @solution[:reference_sid],
+                            add_on_result_sid: @solution[:add_on_result_sid],
+                            sid: @solution[:sid],
+                        )
+                        PayloadInstanceMetadata.new(
+                            @version,
+                            payload_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Access the data
+                    # @return [DataList]
+                    # @return [DataContext]
+                    def data
+                        DataContext.new(
+                                @version,
+                                @solution[:account_sid],
+                                @solution[:reference_sid],
+                                @solution[:add_on_result_sid],
+                                @solution[:sid]
+                                )
+                    end
 
                     ##
                     # Provide a user friendly representation
@@ -185,6 +293,53 @@ module Twilio
                     end
                 end
 
+                class PayloadInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new PayloadInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}PayloadInstance] payload_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [PayloadInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, payload_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @payload_instance = payload_instance
+                    end
+
+                    def payload
+                        @payload_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.PayloadInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class PayloadListResponse < InstanceListResource
+                    # @param [Array<PayloadInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @payload_instance = payload.body[key].map do |data|
+                        PayloadInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def payload_instance
+                          @instance
+                      end
+                  end
+
                 class PayloadPage < Page
                     ##
                     # Initialize the PayloadPage
@@ -194,6 +349,7 @@ module Twilio
                     # @return [PayloadPage] PayloadPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -213,6 +369,66 @@ module Twilio
                         '<Twilio.Api.V2010.PayloadPage>'
                     end
                 end
+
+                class PayloadPageMetadata < PageMetadata
+                    attr_reader :payload_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @payload_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @payload_page << PayloadListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @payload_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class PayloadListResponse < InstanceListResource
+
+                    # @param [Array<PayloadInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @payload = data_list.map do |data|
+                        PayloadInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def payload
+                        @payload
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class PayloadInstance < InstanceResource
                     ##
                     # Initialize the PayloadInstance
@@ -226,6 +442,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, reference_sid: nil, add_on_result_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -339,6 +556,13 @@ module Twilio
                         context.fetch
                     end
 
+                    ##
+                    # Access the data
+                    # @return [data] data
+                    def data
+                        context.data
+                    end
+
                     ##
                     # Provide a user friendly representation
                     def to_s