twilio-ruby 6.8.0 → 7.10.7

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

@@ -21,12 +21,14 @@ module Twilio
                 class CallContext < InstanceContext
 
                      class PaymentList < ListResource
+                
                     ##
                     # Initialize the PaymentList
                     # @param [Version] version Version that contains the resource
                     # @return [PaymentList] PaymentList
                     def initialize(version, account_sid: nil, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid, call_sid: call_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Payments.json"
@@ -50,24 +52,28 @@ module Twilio
                     # @param [String] timeout The number of seconds that <Pay> should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is `5`, maximum is `600`.
                     # @param [TokenType] token_type 
                     # @param [String] valid_card_types Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex`
+                    # @param [String] require_matching_inputs A comma-separated list of payment information fields that require the caller to enter the same value twice for confirmation. Supported values are `payment-card-number`, `expiration-date`, `security-code`, and `postal-code`.
+                    # @param [String] confirmation Whether to prompt the caller to confirm their payment information before submitting to the payment gateway. If `true`, the caller will hear the last 4 digits of their card or account number and must press 1 to confirm or 2 to cancel. Default is `false`.
                     # @return [PaymentInstance] Created PaymentInstance
                     def create(
-                        idempotency_key: nil, 
-                        status_callback: nil, 
-                        bank_account_type: :unset, 
-                        charge_amount: :unset, 
-                        currency: :unset, 
-                        description: :unset, 
-                        input: :unset, 
-                        min_postal_code_length: :unset, 
-                        parameter: :unset, 
-                        payment_connector: :unset, 
-                        payment_method: :unset, 
-                        postal_code: :unset, 
-                        security_code: :unset, 
-                        timeout: :unset, 
-                        token_type: :unset, 
-                        valid_card_types: :unset
+                      idempotency_key: nil, 
+                      status_callback: nil, 
+                      bank_account_type: :unset, 
+                      charge_amount: :unset, 
+                      currency: :unset, 
+                      description: :unset, 
+                      input: :unset, 
+                      min_postal_code_length: :unset, 
+                      parameter: :unset, 
+                      payment_connector: :unset, 
+                      payment_method: :unset, 
+                      postal_code: :unset, 
+                      security_code: :unset, 
+                      timeout: :unset, 
+                      token_type: :unset, 
+                      valid_card_types: :unset, 
+                      require_matching_inputs: :unset, 
+                      confirmation: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -87,9 +93,17 @@ module Twilio
                             'Timeout' => timeout,
                             'TokenType' => token_type,
                             'ValidCardTypes' => valid_card_types,
+                            'RequireMatchingInputs' => require_matching_inputs,
+                            'Confirmation' => confirmation,
                         })
 
-                        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)
                         PaymentInstance.new(
                             @version,
                             payload,
@@ -98,6 +112,90 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the PaymentInstanceMetadata
+                    # @param [String] idempotency_key A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
+                    # @param [String] status_callback Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [expected StatusCallback values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback)
+                    # @param [BankAccountType] bank_account_type 
+                    # @param [Float] charge_amount A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with `currency` field. Leave blank or set to 0 to tokenize.
+                    # @param [String] currency The currency of the `charge_amount`, formatted as [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD` and all values allowed from the Pay Connector are accepted.
+                    # @param [String] description The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions.
+                    # @param [String] input A list of inputs that should be accepted. Currently only `dtmf` is supported. All digits captured during a pay session are redacted from the logs.
+                    # @param [String] min_postal_code_length A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits.
+                    # @param [Object] parameter A single-level JSON object used to pass custom parameters to payment processors. (Required for ACH payments). The information that has to be included here depends on the <Pay> Connector. [Read more](https://www.twilio.com/console/voice/pay-connectors).
+                    # @param [String] payment_connector This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about [<Pay> Connectors](https://www.twilio.com/console/voice/pay-connectors). The default value is `Default`.
+                    # @param [PaymentMethod] payment_method 
+                    # @param [Boolean] postal_code Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is `true`.
+                    # @param [Boolean] security_code Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is `true`.
+                    # @param [String] timeout The number of seconds that <Pay> should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is `5`, maximum is `600`.
+                    # @param [TokenType] token_type 
+                    # @param [String] valid_card_types Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex`
+                    # @param [String] require_matching_inputs A comma-separated list of payment information fields that require the caller to enter the same value twice for confirmation. Supported values are `payment-card-number`, `expiration-date`, `security-code`, and `postal-code`.
+                    # @param [String] confirmation Whether to prompt the caller to confirm their payment information before submitting to the payment gateway. If `true`, the caller will hear the last 4 digits of their card or account number and must press 1 to confirm or 2 to cancel. Default is `false`.
+                    # @return [PaymentInstance] Created PaymentInstance
+                    def create_with_metadata(
+                      idempotency_key: nil, 
+                      status_callback: nil, 
+                      bank_account_type: :unset, 
+                      charge_amount: :unset, 
+                      currency: :unset, 
+                      description: :unset, 
+                      input: :unset, 
+                      min_postal_code_length: :unset, 
+                      parameter: :unset, 
+                      payment_connector: :unset, 
+                      payment_method: :unset, 
+                      postal_code: :unset, 
+                      security_code: :unset, 
+                      timeout: :unset, 
+                      token_type: :unset, 
+                      valid_card_types: :unset, 
+                      require_matching_inputs: :unset, 
+                      confirmation: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'IdempotencyKey' => idempotency_key,
+                            'StatusCallback' => status_callback,
+                            'BankAccountType' => bank_account_type,
+                            'ChargeAmount' => charge_amount,
+                            'Currency' => currency,
+                            'Description' => description,
+                            'Input' => input,
+                            'MinPostalCodeLength' => min_postal_code_length,
+                            'Parameter' => Twilio.serialize_object(parameter),
+                            'PaymentConnector' => payment_connector,
+                            'PaymentMethod' => payment_method,
+                            'PostalCode' => postal_code,
+                            'SecurityCode' => security_code,
+                            'Timeout' => timeout,
+                            'TokenType' => token_type,
+                            'ValidCardTypes' => valid_card_types,
+                            'RequireMatchingInputs' => require_matching_inputs,
+                            'Confirmation' => confirmation,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        payment_instance = PaymentInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                        )
+                        PaymentInstanceMetadata.new(
+                            @version,
+                            payment_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -108,8 +206,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
                 class PaymentContext < InstanceContext
                     ##
                     # Initialize the PaymentContext
@@ -120,6 +216,7 @@ module Twilio
                     # @return [PaymentContext] PaymentContext
                     def initialize(version, account_sid, call_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, call_sid: call_sid, sid: sid,  }
@@ -135,10 +232,10 @@ module Twilio
                     # @param [Status] status 
                     # @return [PaymentInstance] Updated PaymentInstance
                     def update(
-                        idempotency_key: nil, 
-                        status_callback: nil, 
-                        capture: :unset, 
-                        status: :unset
+                      idempotency_key: nil, 
+                      status_callback: nil, 
+                      capture: :unset, 
+                      status: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -148,7 +245,13 @@ module Twilio
                             'Status' => status,
                         })
 
-                        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)
                         PaymentInstance.new(
                             @version,
                             payload,
@@ -158,6 +261,49 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the PaymentInstanceMetadata
+                    # @param [String] idempotency_key A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
+                    # @param [String] status_callback Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.
+                    # @param [Capture] capture 
+                    # @param [Status] status 
+                    # @return [PaymentInstance] Updated PaymentInstance
+                    def update_with_metadata(
+                      idempotency_key: nil, 
+                      status_callback: nil, 
+                      capture: :unset, 
+                      status: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'IdempotencyKey' => idempotency_key,
+                            'StatusCallback' => status_callback,
+                            'Capture' => capture,
+                            'Status' => status,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        payment_instance = PaymentInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                            sid: @solution[:sid],
+                        )
+                        PaymentInstanceMetadata.new(
+                            @version,
+                            payment_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -174,6 +320,53 @@ module Twilio
                     end
                 end
 
+                class PaymentInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new PaymentInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}PaymentInstance] payment_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 [PaymentInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, payment_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @payment_instance = payment_instance
+                    end
+
+                    def payment
+                        @payment_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.PaymentInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class PaymentListResponse < InstanceListResource
+                    # @param [Array<PaymentInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @payment_instance = payload.body[key].map do |data|
+                        PaymentInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def payment_instance
+                          @instance
+                      end
+                  end
+
                 class PaymentPage < Page
                     ##
                     # Initialize the PaymentPage
@@ -183,6 +376,7 @@ module Twilio
                     # @return [PaymentPage] PaymentPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -202,6 +396,66 @@ module Twilio
                         '<Twilio.Api.V2010.PaymentPage>'
                     end
                 end
+
+                class PaymentPageMetadata < PageMetadata
+                    attr_reader :payment_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @payment_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @payment_page << PaymentListResponse.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
+                        @payment_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class PaymentListResponse < InstanceListResource
+
+                    # @param [Array<PaymentInstance>] 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
+                      @payment = data_list.map do |data|
+                        PaymentInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def payment
+                        @payment
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class PaymentInstance < InstanceResource
                     ##
                     # Initialize the PaymentInstance
@@ -215,6 +469,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, call_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -285,10 +540,10 @@ module Twilio
                     # @param [Status] status 
                     # @return [PaymentInstance] Updated PaymentInstance
                     def update(
-                        idempotency_key: nil, 
-                        status_callback: nil, 
-                        capture: :unset, 
-                        status: :unset
+                      idempotency_key: nil, 
+                      status_callback: nil, 
+                      capture: :unset, 
+                      status: :unset
                     )
 
                         context.update(