stripe 19.4.0 → 19.5.0.pre.alpha.2

data/lib/stripe/params/crypto/deposit_address_list_params.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    class DepositAddressListParams < ::Stripe::RequestParams
+      # Only return the deposit address matching this on-chain address.
+      attr_accessor :address
+      # Only return deposit addresses scoped to this [Customer](https://docs.stripe.com/api/customers/object).
+      attr_accessor :customer
+      # Only return deposit addresses belonging to this customer account.
+      attr_accessor :customer_account
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # Only return deposit addresses for this blockchain network.
+      attr_accessor :network
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(
+        address: nil,
+        customer: nil,
+        customer_account: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        network: nil,
+        starting_after: nil
+      )
+        @address = address
+        @customer = customer
+        @customer_account = customer_account
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @network = network
+        @starting_after = starting_after
+      end
+    end
+  end
+end

data/lib/stripe/params/crypto/deposit_address_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    class DepositAddressRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/crypto/onramp_session_checkout_params.rb

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    class OnrampSessionCheckoutParams < ::Stripe::RequestParams
+      class MandateData < ::Stripe::RequestParams
+        class CustomerAcceptance < ::Stripe::RequestParams
+          class Offline < ::Stripe::RequestParams; end
+
+          class Online < ::Stripe::RequestParams
+            # The IP address from which the Mandate was accepted by the customer.
+            attr_accessor :ip_address
+            # The user agent of the browser from which the Mandate was accepted by the customer.
+            attr_accessor :user_agent
+
+            def initialize(ip_address: nil, user_agent: nil)
+              @ip_address = ip_address
+              @user_agent = user_agent
+            end
+          end
+          # The time at which the customer accepted the Mandate.
+          attr_accessor :accepted_at
+          # If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
+          attr_accessor :offline
+          # If this is a Mandate accepted online, this hash contains details about the online acceptance.
+          attr_accessor :online
+          # The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
+          attr_accessor :type
+
+          def initialize(accepted_at: nil, offline: nil, online: nil, type: nil)
+            @accepted_at = accepted_at
+            @offline = offline
+            @online = online
+            @type = type
+          end
+        end
+        # This hash contains details about the customer acceptance of the Mandate.
+        attr_accessor :customer_acceptance
+
+        def initialize(customer_acceptance: nil)
+          @customer_acceptance = customer_acceptance
+        end
+      end
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # This hash contains details about the mandate to create
+      attr_accessor :mandate_data
+
+      def initialize(expand: nil, mandate_data: nil)
+        @expand = expand
+        @mandate_data = mandate_data
+      end
+    end
+  end
+end

data/lib/stripe/params/crypto/onramp_session_create_params.rb

@@ -0,0 +1,122 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    class OnrampSessionCreateParams < ::Stripe::RequestParams
+      class KycDetails < ::Stripe::RequestParams; end
+
+      class WalletAddresses < ::Stripe::RequestParams
+        class DestinationTags < ::Stripe::RequestParams
+          # Attribute for param field stellar
+          attr_accessor :stellar
+
+          def initialize(stellar: nil)
+            @stellar = stellar
+          end
+        end
+        # The end customer's crypto wallet destination tag (for each network) to use for this transaction. This only applies for tag-based assets such as XLM.
+        #
+        # * When left null, the user enters their wallet in the onramp UI.
+        attr_accessor :destination_tags
+
+        def initialize(destination_tags: nil)
+          @destination_tags = destination_tags
+        end
+      end
+      # The IP address of the customer the platform intends to onramp.
+      #
+      # If the user's IP is in a region we can't support, we return an `HTTP 400` with an appropriate error code.
+      #
+      # We support IPv4 and IPv6 addresses. Geographic supportability is checked again later in the onramp flow, which provides a way to hide the onramp option from ineligible users for a better user experience.
+      attr_accessor :customer_ip_address
+      # The default amount of crypto to exchange into.
+      #
+      # * When left null, a default value is computed if `source_amount`, `destination_currency`, and `destination_network` are set.
+      # * When set, both `destination_currency` and `destination_network` must also be set. All cryptocurrencies are supported to their full precisions (for example, 18 decimal places for `eth`). We validate and generate an error if the amount exceeds the supported precision based on the exchange currency. Setting `source_amount` is mutually exclusive with setting `destination_amount` (only one or the other is supported). Users can update the amount in the onramp UI.
+      attr_accessor :destination_amount
+      # The list of destination cryptocurrencies a user can choose from.
+      #
+      # * When left null, all supported cryptocurrencies are shown in the onramp UI subject to `destination_networks` if set.
+      # * When set, it must be a non-empty array where all values in the array are valid cryptocurrencies. You can use it to lock users to a specific cryptocurrency by passing a single value array. Users **cannot** override this parameter.
+      attr_accessor :destination_currencies
+      # The default destination cryptocurrency.
+      #
+      # * When left null, the first value of `destination_currencies` is selected.
+      # * When set, if `destination_currencies` is also set, the value of `destination_currency` must be present in that array. To lock a `destination_currency`, specify that value as the single value for `destination_currencies`. Users can select a different cryptocurrency in the onramp UI subject to `destination_currencies` if set.
+      attr_accessor :destination_currency
+      # The default destination crypto network.
+      #
+      # * When left null, the first value of `destination_networks` is selected.
+      # * When set, if `destination_networks` is also set, the value of `destination_network` must be present in that array. To lock a `destination_network`, specify that value as the single value for `destination_networks`. Users can select a different network in the onramp UI subject to `destination_networks` if set.
+      attr_accessor :destination_network
+      # The list of destination crypto networks user can choose from.
+      #
+      # * When left null, all supported crypto networks are shown in the onramp UI.
+      # * When set, it must be a non-empty array where values in the array are each a valid crypto network. It can be used to lock users to a specific network by passing a single value array. Users **cannot** override this parameter.
+      attr_accessor :destination_networks
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Pre-populate some of the required KYC information for the user if you've already collected it within your application.
+      #
+      # Related guide: [Using the API](https://docs.stripe.com/crypto/using-the-api#how-to-pre-populate-customer-information)
+      attr_accessor :kyc_details
+      # Whether or not to lock the suggested wallet address. If destination tags are provided, this will also lock the destination tags.
+      attr_accessor :lock_wallet_address
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # Speed at which the cryptocurrency is delivered to the wallet
+      # One of:
+      #  `instant` (default): crypto is delivered when payment is confirmed
+      #  `standard`: crypto is delivered when payment settles
+      attr_accessor :settlement_speed
+      # The default amount of fiat (in decimal) to exchange into crypto.
+      #
+      # * When left null, a default value is computed if `destination_amount` is set.
+      # * When set, setting `source_amount` is mutually exclusive with setting `destination_amount` (only one or the other is supported). We don't support fractional pennies. If fractional minor units of a currency are passed in, it generates an error. Users can update the value in the onramp UI.
+      attr_accessor :source_amount
+      # The default source fiat currency for the onramp session.
+      #
+      # * When left null, a default currency is selected based on user locale.
+      # * When set, it must be one of the fiat currencies supported by onramp. Users can still select a different currency in the onramp UI.
+      attr_accessor :source_currency
+      # The end customer's crypto wallet address (for each network) to use for this transaction.
+      #
+      # * When left null, the user enters their wallet in the onramp UI.
+      # * When set, the platform must set either `destination_networks` or `destination_network` and we perform address validation. Users can still select a different wallet in the onramp UI.
+      attr_accessor :wallet_addresses
+
+      def initialize(
+        customer_ip_address: nil,
+        destination_amount: nil,
+        destination_currencies: nil,
+        destination_currency: nil,
+        destination_network: nil,
+        destination_networks: nil,
+        expand: nil,
+        kyc_details: nil,
+        lock_wallet_address: nil,
+        metadata: nil,
+        settlement_speed: nil,
+        source_amount: nil,
+        source_currency: nil,
+        wallet_addresses: nil
+      )
+        @customer_ip_address = customer_ip_address
+        @destination_amount = destination_amount
+        @destination_currencies = destination_currencies
+        @destination_currency = destination_currency
+        @destination_network = destination_network
+        @destination_networks = destination_networks
+        @expand = expand
+        @kyc_details = kyc_details
+        @lock_wallet_address = lock_wallet_address
+        @metadata = metadata
+        @settlement_speed = settlement_speed
+        @source_amount = source_amount
+        @source_currency = source_currency
+        @wallet_addresses = wallet_addresses
+      end
+    end
+  end
+end

data/lib/stripe/params/crypto/onramp_session_list_params.rb

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    class OnrampSessionListParams < ::Stripe::RequestParams
+      class Created < ::Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # Only return onramp sessions that were created during the given date interval.
+      attr_accessor :created
+      # The destination cryptocurrency to filter by.
+      attr_accessor :destination_currency
+      # The destination blockchain network to filter by.
+      attr_accessor :destination_network
+      # An object ID cursor for use in pagination.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit ranging from 1 to 100 (defaults to 10).
+      attr_accessor :limit
+      # An object ID cursor for use in pagination.
+      attr_accessor :starting_after
+      # The status of the Onramp Session. One of = `{initialized, rejected, requires_payment, fulfillment_processing, fulfillment_complete}`
+      attr_accessor :status
+
+      def initialize(
+        created: nil,
+        destination_currency: nil,
+        destination_network: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @created = created
+        @destination_currency = destination_currency
+        @destination_network = destination_network
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+  end
+end

data/lib/stripe/params/crypto/onramp_session_quote_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    class OnrampSessionQuoteParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/crypto/onramp_session_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    class OnrampSessionRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/crypto/onramp_transaction_limits_retrieve_params.rb

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    class OnrampTransactionLimitsRetrieveParams < ::Stripe::RequestParams
+      # The IP address of the customer requesting transaction limits. We support IPv4 and IPv6 addresses.
+      attr_accessor :customer_ip_address
+      # The destination blockchain network to use for limit calculations.
+      attr_accessor :destination_network
+      # The destination tag for the wallet address, if applicable for the network.
+      attr_accessor :destination_tag
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The wallet address to use for destination-specific limit calculations.
+      attr_accessor :wallet_address
+
+      def initialize(
+        customer_ip_address: nil,
+        destination_network: nil,
+        destination_tag: nil,
+        expand: nil,
+        wallet_address: nil
+      )
+        @customer_ip_address = customer_ip_address
+        @destination_network = destination_network
+        @destination_tag = destination_tag
+        @expand = expand
+        @wallet_address = wallet_address
+      end
+    end
+  end
+end

data/lib/stripe/params/customer_session_create_params.rb

@@ -144,6 +144,33 @@ module Stripe
           @enabled = enabled
         end
       end
+
+      class TaxIdElement < ::Stripe::RequestParams
+        class Features < ::Stripe::RequestParams
+          # Controls whether the Tax ID Element displays saved tax IDs for the customer. This parameter defaults to `disabled`.
+          #
+          # When enabled, the Tax ID Element will show existing tax IDs associated with the customer, allowing them to select from previously saved tax identification numbers.
+          attr_accessor :tax_id_redisplay
+          # Controls whether the Tax ID Element allows merchants to save new tax IDs for their customer. This parameter defaults to `disabled`.
+          #
+          # When enabled, customers can enter and save new tax identification numbers during the payment flow, which will be stored securely and associated with their customer object for future use.
+          attr_accessor :tax_id_save
+
+          def initialize(tax_id_redisplay: nil, tax_id_save: nil)
+            @tax_id_redisplay = tax_id_redisplay
+            @tax_id_save = tax_id_save
+          end
+        end
+        # Whether the Tax ID Element is enabled.
+        attr_accessor :enabled
+        # This hash defines whether the Tax ID Element supports certain features.
+        attr_accessor :features
+
+        def initialize(enabled: nil, features: nil)
+          @enabled = enabled
+          @features = features
+        end
+      end
       # Configuration for buy button.
       attr_accessor :buy_button
       # Configuration for the customer sheet.
@@ -154,19 +181,23 @@ module Stripe
       attr_accessor :payment_element
       # Configuration for the pricing table.
       attr_accessor :pricing_table
+      # Configuration for the Tax ID Element.
+      attr_accessor :tax_id_element
 
       def initialize(
         buy_button: nil,
         customer_sheet: nil,
         mobile_payment_element: nil,
         payment_element: nil,
-        pricing_table: nil
+        pricing_table: nil,
+        tax_id_element: nil
       )
         @buy_button = buy_button
         @customer_sheet = customer_sheet
         @mobile_payment_element = mobile_payment_element
         @payment_element = payment_element
         @pricing_table = pricing_table
+        @tax_id_element = tax_id_element
       end
     end
     # Configuration for each component. At least 1 component must be enabled.

data/lib/stripe/params/delegated_checkout/order_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module DelegatedCheckout
+    class OrderRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/delegated_checkout/requested_session_confirm_params.rb

@@ -0,0 +1,172 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module DelegatedCheckout
+    class RequestedSessionConfirmParams < ::Stripe::RequestParams
+      class AffiliateAttribution < ::Stripe::RequestParams
+        class Source < ::Stripe::RequestParams
+          # The platform where the attribution originated.
+          attr_accessor :platform
+          # The type of the attribution source.
+          attr_accessor :type
+          # The URL where the attribution originated.
+          attr_accessor :url
+
+          def initialize(platform: nil, type: nil, url: nil)
+            @platform = platform
+            @type = type
+            @url = url
+          end
+        end
+        # Agent-scoped campaign identifier.
+        attr_accessor :campaign_id
+        # Agent-scoped creative identifier.
+        attr_accessor :creative_id
+        # Timestamp when the attribution token expires.
+        attr_accessor :expires_at
+        # Agent-issued secret to validate the legitimacy of the source of this data.
+        attr_accessor :identification_token
+        # Timestamp for when the attribution token was issued.
+        attr_accessor :issued_at
+        # Identifier for the attribution agent / affiliate network namespace.
+        attr_accessor :provider
+        # Agent-scoped affiliate/publisher identifier.
+        attr_accessor :publisher_id
+        # Freeform key/value pairs for additional non-sensitive per-agent data.
+        attr_accessor :shared_metadata
+        # Context about where the attribution originated.
+        attr_accessor :source
+        # Agent-scoped sub-tracking identifier.
+        attr_accessor :sub_id
+        # Whether this is the first or last touchpoint.
+        attr_accessor :touchpoint
+
+        def initialize(
+          campaign_id: nil,
+          creative_id: nil,
+          expires_at: nil,
+          identification_token: nil,
+          issued_at: nil,
+          provider: nil,
+          publisher_id: nil,
+          shared_metadata: nil,
+          source: nil,
+          sub_id: nil,
+          touchpoint: nil
+        )
+          @campaign_id = campaign_id
+          @creative_id = creative_id
+          @expires_at = expires_at
+          @identification_token = identification_token
+          @issued_at = issued_at
+          @provider = provider
+          @publisher_id = publisher_id
+          @shared_metadata = shared_metadata
+          @source = source
+          @sub_id = sub_id
+          @touchpoint = touchpoint
+        end
+      end
+
+      class BuyerConsents < ::Stripe::RequestParams
+        class Marketing < ::Stripe::RequestParams
+          class Consent < ::Stripe::RequestParams
+            # The marketing consent channel.
+            attr_accessor :channel
+            # The consent status. Use 'granted' to indicate the buyer has opted in.
+            attr_accessor :status
+
+            def initialize(channel: nil, status: nil)
+              @channel = channel
+              @status = status
+            end
+          end
+          # The list of marketing consent entries.
+          attr_accessor :consents
+
+          def initialize(consents: nil)
+            @consents = consents
+          end
+        end
+        # The marketing consent data for the buyer.
+        attr_accessor :marketing
+
+        def initialize(marketing: nil)
+          @marketing = marketing
+        end
+      end
+
+      class RiskDetails < ::Stripe::RequestParams
+        class ClientDeviceMetadataDetails < ::Stripe::RequestParams
+          # The radar session.
+          attr_accessor :radar_session
+          # The referrer of the client device.
+          attr_accessor :referrer
+          # The remote IP address of the client device.
+          attr_accessor :remote_ip
+          # The time on page in milliseconds.
+          attr_accessor :time_on_page_ms
+          # The user agent of the client device.
+          attr_accessor :user_agent
+
+          def initialize(
+            radar_session: nil,
+            referrer: nil,
+            remote_ip: nil,
+            time_on_page_ms: nil,
+            user_agent: nil
+          )
+            @radar_session = radar_session
+            @referrer = referrer
+            @remote_ip = remote_ip
+            @time_on_page_ms = time_on_page_ms
+            @user_agent = user_agent
+          end
+        end
+        # The client device metadata details for this requested session.
+        attr_accessor :client_device_metadata_details
+
+        def initialize(client_device_metadata_details: nil)
+          @client_device_metadata_details = client_device_metadata_details
+        end
+      end
+      # Affiliate attribution data associated with this requested session.
+      attr_accessor :affiliate_attribution
+      # The buyer's consent choices for marketing communications.
+      attr_accessor :buyer_consents
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The metadata for this requested session.
+      attr_accessor :metadata
+      # The PaymentMethod to use with the requested session.
+      attr_accessor :payment_method
+      # The URL to redirect your customer back to after they authenticate or complete a payment action. Required for redirect-based payment methods such as Affirm or Klarna.
+      attr_accessor :return_url
+      # Risk details/signals associated with the requested session
+      attr_accessor :risk_details
+      # Set to true when using Stripe.js, iOS, or Android client-side SDKs to handle next actions.
+      attr_accessor :use_stripe_sdk
+
+      def initialize(
+        affiliate_attribution: nil,
+        buyer_consents: nil,
+        expand: nil,
+        metadata: nil,
+        payment_method: nil,
+        return_url: nil,
+        risk_details: nil,
+        use_stripe_sdk: nil
+      )
+        @affiliate_attribution = affiliate_attribution
+        @buyer_consents = buyer_consents
+        @expand = expand
+        @metadata = metadata
+        @payment_method = payment_method
+        @return_url = return_url
+        @risk_details = risk_details
+        @use_stripe_sdk = use_stripe_sdk
+      end
+    end
+  end
+end