twilio-ruby 7.9.1 → 7.10.0

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [SupportingDocumentTypeList] SupportingDocumentTypeList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/RegulatoryCompliance/SupportingDocumentTypes"
@@ -71,6 +72,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists SupportingDocumentTypePageMetadata 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)
+
+                        SupportingDocumentTypePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields SupportingDocumentTypeInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -92,7 +115,7 @@ 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 SupportingDocumentTypeInstance
-                    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,
@@ -137,6 +160,7 @@ module Twilio
                     # @return [SupportingDocumentTypeContext] SupportingDocumentTypeContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -163,6 +187,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SupportingDocumentTypeInstanceMetadata
+                    # @return [SupportingDocumentTypeInstance] Fetched SupportingDocumentTypeInstance
+                    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_type_instance = SupportingDocumentTypeInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SupportingDocumentTypeInstanceMetadata.new(
+                            @version,
+                            supporting_document_type_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -179,6 +228,53 @@ module Twilio
                     end
                 end
 
+                class SupportingDocumentTypeInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SupportingDocumentTypeInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SupportingDocumentTypeInstance] supporting_document_type_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 [SupportingDocumentTypeInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, supporting_document_type_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @supporting_document_type_instance = supporting_document_type_instance
+                    end
+
+                    def supporting_document_type
+                        @supporting_document_type_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SupportingDocumentTypeInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SupportingDocumentTypeListResponse < InstanceListResource
+                    # @param [Array<SupportingDocumentTypeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @supporting_document_type_instance = payload.body[key].map do |data|
+                        SupportingDocumentTypeInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def supporting_document_type_instance
+                          @instance
+                      end
+                  end
+
                 class SupportingDocumentTypePage < Page
                     ##
                     # Initialize the SupportingDocumentTypePage
@@ -188,6 +284,7 @@ module Twilio
                     # @return [SupportingDocumentTypePage] SupportingDocumentTypePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -207,6 +304,66 @@ module Twilio
                         '<Twilio.Numbers.V2.SupportingDocumentTypePage>'
                     end
                 end
+
+                class SupportingDocumentTypePageMetadata < PageMetadata
+                    attr_reader :supporting_document_type_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @supporting_document_type_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @supporting_document_type_page << SupportingDocumentTypeListResponse.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_type_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class SupportingDocumentTypeListResponse < InstanceListResource
+
+                    # @param [Array<SupportingDocumentTypeInstance>] 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_type = data_list.map do |data|
+                        SupportingDocumentTypeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def supporting_document_type
+                        @supporting_document_type
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SupportingDocumentTypeInstance < InstanceResource
                     ##
                     # Initialize the SupportingDocumentTypeInstance
@@ -220,6 +377,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [RegulatoryComplianceList] RegulatoryComplianceList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/RegulatoryCompliance"
@@ -132,6 +133,7 @@ module Twilio
                     # @return [RegulatoryCompliancePage] RegulatoryCompliancePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -151,6 +153,66 @@ module Twilio
                         '<Twilio.Numbers.V2.RegulatoryCompliancePage>'
                     end
                 end
+
+                class RegulatoryCompliancePageMetadata < PageMetadata
+                    attr_reader :regulatory_compliance_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @regulatory_compliance_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @regulatory_compliance_page << RegulatoryComplianceListResponse.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
+                        @regulatory_compliance_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class RegulatoryComplianceListResponse < InstanceListResource
+
+                    # @param [Array<RegulatoryComplianceInstance>] 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
+                      @regulatory_compliance = data_list.map do |data|
+                        RegulatoryComplianceInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def regulatory_compliance
+                        @regulatory_compliance
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class RegulatoryComplianceInstance < InstanceResource
                     ##
                     # Initialize the RegulatoryComplianceInstance
@@ -164,6 +226,7 @@ module Twilio
                     def initialize(version )
                         super(version)
                         
+                        
                     end
 
                     

data/lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [HostedNumberOrderList] HostedNumberOrderList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/HostedNumbers/HostedNumberOrders"
@@ -103,6 +104,85 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the HostedNumberOrderInstanceMetadata
+                    # @param [String] phone_number The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format
+                    # @param [Boolean] sms_capability Used to specify that the SMS capability will be hosted on Twilio's platform.
+                    # @param [String] account_sid This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.
+                    # @param [String] friendly_name A 64 character string that is a human readable text that describes this resource.
+                    # @param [String] unique_name Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.
+                    # @param [Array[String]] cc_emails Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.
+                    # @param [String] sms_url The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.
+                    # @param [String] sms_method The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`.  This will be copied onto the IncomingPhoneNumber resource.
+                    # @param [String] sms_fallback_url A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.
+                    # @param [String] sms_fallback_method The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.
+                    # @param [String] status_callback_url Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.
+                    # @param [String] status_callback_method Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.
+                    # @param [String] sms_application_sid Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.
+                    # @param [String] address_sid Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
+                    # @param [String] email Optional. Email of the owner of this phone number that is being hosted.
+                    # @param [VerificationType] verification_type 
+                    # @param [String] verification_document_sid Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.
+                    # @return [HostedNumberOrderInstance] Created HostedNumberOrderInstance
+                    def create_with_metadata(
+                      phone_number: nil, 
+                      sms_capability: nil, 
+                      account_sid: :unset, 
+                      friendly_name: :unset, 
+                      unique_name: :unset, 
+                      cc_emails: :unset, 
+                      sms_url: :unset, 
+                      sms_method: :unset, 
+                      sms_fallback_url: :unset, 
+                      sms_fallback_method: :unset, 
+                      status_callback_url: :unset, 
+                      status_callback_method: :unset, 
+                      sms_application_sid: :unset, 
+                      address_sid: :unset, 
+                      email: :unset, 
+                      verification_type: :unset, 
+                      verification_document_sid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'phoneNumber' => phone_number,
+                            'smsCapability' => sms_capability,
+                            'accountSid' => account_sid,
+                            'friendlyName' => friendly_name,
+                            'uniqueName' => unique_name,
+                            'ccEmails' => Twilio.serialize_list(cc_emails) { |e| e },
+                            'smsUrl' => sms_url,
+                            'smsMethod' => sms_method,
+                            'smsFallbackUrl' => sms_fallback_url,
+                            'smsFallbackMethod' => sms_fallback_method,
+                            'statusCallbackUrl' => status_callback_url,
+                            'statusCallbackMethod' => status_callback_method,
+                            'smsApplicationSid' => sms_application_sid,
+                            'addressSid' => address_sid,
+                            'email' => email,
+                            'verificationType' => verification_type,
+                            'verificationDocumentSid' => verification_document_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        hosted_number_order_instance = HostedNumberOrderInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        HostedNumberOrderInstanceMetadata.new(
+                            @version,
+                            hosted_number_order_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -121,6 +201,7 @@ module Twilio
                     # @return [HostedNumberOrderPage] HostedNumberOrderPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -140,6 +221,66 @@ module Twilio
                         '<Twilio.Numbers.V3.HostedNumberOrderPage>'
                     end
                 end
+
+                class HostedNumberOrderPageMetadata < PageMetadata
+                    attr_reader :hosted_number_order_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @hosted_number_order_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @hosted_number_order_page << HostedNumberOrderListResponse.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
+                        @hosted_number_order_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V3PageMetadata>';
+                    end
+                end
+                class HostedNumberOrderListResponse < InstanceListResource
+
+                    # @param [Array<HostedNumberOrderInstance>] 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
+                      @hosted_number_order = data_list.map do |data|
+                        HostedNumberOrderInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def hosted_number_order
+                        @hosted_number_order
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class HostedNumberOrderInstance < InstanceResource
                     ##
                     # Initialize the HostedNumberOrderInstance
@@ -153,6 +294,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/oauth/v1/authorize.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [AuthorizeList] AuthorizeList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/authorize"
@@ -66,6 +67,48 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the AuthorizeInstanceMetadata
+                    # @param [String] response_type Response Type
+                    # @param [String] client_id The Client Identifier
+                    # @param [String] redirect_uri The url to which response will be redirected to
+                    # @param [String] scope The scope of the access request
+                    # @param [String] state An opaque value which can be used to maintain state between the request and callback
+                    # @return [AuthorizeInstance] Fetched AuthorizeInstance
+                    def fetch_with_metadata(
+                      response_type: :unset, 
+                      client_id: :unset, 
+                      redirect_uri: :unset, 
+                      scope: :unset, 
+                      state: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'ResponseType' => response_type,
+                            'ClientId' => client_id,
+                            'RedirectUri' => redirect_uri,
+                            'Scope' => scope,
+                            'State' => state,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        authorize_instance = AuthorizeInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        AuthorizeInstanceMetadata.new(
+                            @version,
+                            authorize_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -84,6 +127,7 @@ module Twilio
                     # @return [AuthorizePage] AuthorizePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -103,6 +147,66 @@ module Twilio
                         '<Twilio.Oauth.V1.AuthorizePage>'
                     end
                 end
+
+                class AuthorizePageMetadata < PageMetadata
+                    attr_reader :authorize_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @authorize_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @authorize_page << AuthorizeListResponse.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
+                        @authorize_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Oauth::V1PageMetadata>';
+                    end
+                end
+                class AuthorizeListResponse < InstanceListResource
+
+                    # @param [Array<AuthorizeInstance>] 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
+                      @authorize = data_list.map do |data|
+                        AuthorizeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def authorize
+                        @authorize
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class AuthorizeInstance < InstanceResource
                     ##
                     # Initialize the AuthorizeInstance
@@ -116,6 +220,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'redirect_to' => payload['redirect_to'],