twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb

@@ -20,12 +20,14 @@ module Twilio
                 class RegulatoryComplianceList < ListResource
 
                      class SupportingDocumentList < ListResource
+                
                     ##
                     # Initialize the SupportingDocumentList
                     # @param [Version] version Version that contains the resource
                     # @return [SupportingDocumentList] SupportingDocumentList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/RegulatoryCompliance/SupportingDocuments"
@@ -38,9 +40,9 @@ module Twilio
                     # @param [Object] attributes The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
                     # @return [SupportingDocumentInstance] Created SupportingDocumentInstance
                     def create(
-                        friendly_name: nil, 
-                        type: nil, 
-                        attributes: :unset
+                      friendly_name: nil, 
+                      type: nil, 
+                      attributes: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -49,13 +51,56 @@ module Twilio
                             'Attributes' => Twilio.serialize_object(attributes),
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         SupportingDocumentInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the SupportingDocumentInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the resource.
+                    # @param [String] type The type of the Supporting Document.
+                    # @param [Object] attributes The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
+                    # @return [SupportingDocumentInstance] Created SupportingDocumentInstance
+                    def create_with_metadata(
+                      friendly_name: nil, 
+                      type: nil, 
+                      attributes: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Type' => type,
+                            'Attributes' => Twilio.serialize_object(attributes),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        supporting_document_instance = SupportingDocumentInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SupportingDocumentInstanceMetadata.new(
+                            @version,
+                            supporting_document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists SupportingDocumentInstance records from the API as a list.
@@ -92,7 +137,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 SupportingDocumentPageMetadata 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)
+
+                        SupportingDocumentPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -104,9 +175,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
 
                     ##
@@ -116,14 +191,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 SupportingDocumentInstance
-                    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)
 
                         SupportingDocumentPage.new(@version, response, @solution)
                     end
@@ -158,6 +236,7 @@ module Twilio
                     # @return [SupportingDocumentContext] SupportingDocumentContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -170,7 +249,31 @@ module Twilio
                     # @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 SupportingDocumentInstanceMetadata
+                    # @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)
+                          supportingDocument_instance = SupportingDocumentInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SupportingDocumentInstanceMetadata.new(@version, supportingDocument_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -178,7 +281,13 @@ module Twilio
                     # @return [SupportingDocumentInstance] Fetched SupportingDocumentInstance
                     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)
                         SupportingDocumentInstance.new(
                             @version,
                             payload,
@@ -186,14 +295,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SupportingDocumentInstanceMetadata
+                    # @return [SupportingDocumentInstance] Fetched SupportingDocumentInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        supporting_document_instance = SupportingDocumentInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SupportingDocumentInstanceMetadata.new(
+                            @version,
+                            supporting_document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the SupportingDocumentInstance
                     # @param [String] friendly_name The string that you assigned to describe the resource.
                     # @param [Object] attributes The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
                     # @return [SupportingDocumentInstance] Updated SupportingDocumentInstance
                     def update(
-                        friendly_name: :unset, 
-                        attributes: :unset
+                      friendly_name: :unset, 
+                      attributes: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -201,7 +335,13 @@ module Twilio
                             'Attributes' => Twilio.serialize_object(attributes),
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         SupportingDocumentInstance.new(
                             @version,
                             payload,
@@ -209,6 +349,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the SupportingDocumentInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the resource.
+                    # @param [Object] attributes The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
+                    # @return [SupportingDocumentInstance] Updated SupportingDocumentInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      attributes: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Attributes' => Twilio.serialize_object(attributes),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        supporting_document_instance = SupportingDocumentInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SupportingDocumentInstanceMetadata.new(
+                            @version,
+                            supporting_document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -225,6 +400,53 @@ module Twilio
                     end
                 end
 
+                class SupportingDocumentInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SupportingDocumentInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SupportingDocumentInstance] supporting_document_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 [SupportingDocumentInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, supporting_document_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @supporting_document_instance = supporting_document_instance
+                    end
+
+                    def supporting_document
+                        @supporting_document_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SupportingDocumentInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SupportingDocumentListResponse < InstanceListResource
+                    # @param [Array<SupportingDocumentInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @supporting_document_instance = payload.body[key].map do |data|
+                        SupportingDocumentInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def supporting_document_instance
+                          @instance
+                      end
+                  end
+
                 class SupportingDocumentPage < Page
                     ##
                     # Initialize the SupportingDocumentPage
@@ -234,6 +456,7 @@ module Twilio
                     # @return [SupportingDocumentPage] SupportingDocumentPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -253,6 +476,66 @@ module Twilio
                         '<Twilio.Numbers.V2.SupportingDocumentPage>'
                     end
                 end
+
+                class SupportingDocumentPageMetadata < PageMetadata
+                    attr_reader :supporting_document_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @supporting_document_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @supporting_document_page << SupportingDocumentListResponse.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
+                        @supporting_document_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class SupportingDocumentListResponse < InstanceListResource
+
+                    # @param [Array<SupportingDocumentInstance>] 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
+                      @supporting_document = data_list.map do |data|
+                        SupportingDocumentInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def supporting_document
+                        @supporting_document
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SupportingDocumentInstance < InstanceResource
                     ##
                     # Initialize the SupportingDocumentInstance
@@ -266,6 +549,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -274,6 +558,7 @@ module Twilio
                             'mime_type' => payload['mime_type'],
                             'status' => payload['status'],
                             'failure_reason' => payload['failure_reason'],
+                            'errors' => payload['errors'],
                             'type' => payload['type'],
                             'attributes' => payload['attributes'],
                             'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
@@ -333,6 +618,12 @@ module Twilio
                         @properties['failure_reason']
                     end
                     
+                    ##
+                    # @return [Array<Hash>] A list of errors that occurred during the registering RC Bundle
+                    def errors
+                        @properties['errors']
+                    end
+                    
                     ##
                     # @return [String] The type of the Supporting Document.
                     def type
@@ -385,8 +676,8 @@ module Twilio
                     # @param [Object] attributes The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
                     # @return [SupportingDocumentInstance] Updated SupportingDocumentInstance
                     def update(
-                        friendly_name: :unset, 
-                        attributes: :unset
+                      friendly_name: :unset, 
+                      attributes: :unset
                     )
 
                         context.update(