stripe 19.3.0 → 19.4.0.pre.alpha.2

data/lib/stripe/resources/crypto/customer_payment_token.rb

@@ -0,0 +1,84 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    # A read-only representation of a user's PaymentMethod for use in Crypto On Ramp transactions.
+    class CustomerPaymentToken < APIResource
+      OBJECT_NAME = "crypto.payment_token"
+      def self.object_name
+        "crypto.payment_token"
+      end
+
+      class Card < ::Stripe::StripeObject
+        class Wallet < ::Stripe::StripeObject
+          # The type of the card wallet, one of `apple_pay` or `google_pay`.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
+        attr_reader :brand
+        # Two-digit number representing the card’s expiration month.
+        attr_reader :exp_month
+        # Four-digit number representing the card’s expiration year.
+        attr_reader :exp_year
+        # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
+        attr_reader :funding
+        # The last four digits of the card.
+        attr_reader :last4
+        # If this Card is part of a card wallet, this contains the details of the card wallet.
+        attr_reader :wallet
+
+        def self.inner_class_types
+          @inner_class_types = { wallet: Wallet }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class UsBankAccount < ::Stripe::StripeObject
+        # Account type: `checkings` or `savings`.
+        attr_reader :account_type
+        # The name of the bank.
+        attr_reader :bank_name
+        # Last four digits of the bank account number.
+        attr_reader :last4
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # A `card` PaymentToken, this hash contains details of the card PaymentToken.
+      attr_reader :card
+      # Unique identifier for the object.
+      attr_reader :id
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Type of the Payment Token.
+      attr_reader :type
+      # A `us_bank_account` PaymentToken, this hash contains details of the US bank account PaymentToken.
+      attr_reader :us_bank_account
+
+      def self.inner_class_types
+        @inner_class_types = { card: Card, us_bank_account: UsBankAccount }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/crypto/onramp_session.rb

@@ -0,0 +1,218 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    # A Crypto Onramp Session represents your customer's session as they purchase cryptocurrency through Stripe. Once payment is successful, Stripe will fulfill the delivery of cryptocurrency to your user's wallet and contain a reference to the crypto transaction ID.
+    #
+    # You can create an onramp session on your server and embed the widget on your frontend. Alternatively, you can redirect your users to the standalone hosted onramp.
+    #
+    # Related guide: [Integrate the onramp](https://docs.stripe.com/crypto/integrate-the-onramp)
+    class OnrampSession < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "crypto.onramp_session"
+      def self.object_name
+        "crypto.onramp_session"
+      end
+
+      class TransactionDetails < ::Stripe::StripeObject
+        class Fees < ::Stripe::StripeObject
+          # The cost associated with moving crypto from Stripe to the end consumer's wallet. e.g: for ETH, this is called 'gas fee', for BTC this is a 'miner's fee'.
+          attr_reader :network_fee_amount
+          # Fee for processing the transaction.
+          attr_reader :transaction_fee_amount
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class WalletAddresses < ::Stripe::StripeObject
+          class DestinationTags < ::Stripe::StripeObject
+            # A stellar destination tag
+            attr_reader :stellar
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # An avalanche address
+          attr_reader :avalanche
+          # A base address
+          attr_reader :base_network
+          # A bitcoin address
+          attr_reader :bitcoin
+          # The end customer's crypto wallet destination tag (for each network) to use for this transaction.
+          attr_reader :destination_tags
+          # An ethereum address
+          attr_reader :ethereum
+          # An optimism address
+          attr_reader :optimism
+          # A polygon address
+          attr_reader :polygon
+          # A solana address
+          attr_reader :solana
+          # A stellar address
+          attr_reader :stellar
+          # A worldchain address
+          attr_reader :worldchain
+
+          def self.inner_class_types
+            @inner_class_types = { destination_tags: DestinationTags }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The amount of crypto the customer will get deposited into their wallet
+        attr_reader :destination_amount
+        # If a platform wants to lock the currencies an session will support, they can add supported currencies to this array. If left null, the experience will allow selection of all supported destination currencies.
+        attr_reader :destination_currencies
+        # The selected `destination_currency` to convert the `source` to. This should be a crypto currency code. If `destination_currencies` is set, it must be a value in that array.
+        attr_reader :destination_currency
+        # The specific crypto network the `destination_currency` is settled on. If `destination_networks` is set, it must be a value in that array.
+        attr_reader :destination_network
+        # If a platform wants to lock the supported networks, they can do so through this array. If left null, the experience will allow selection of all supported networks.
+        attr_reader :destination_networks
+        # Details about the fees associated with this transaction
+        attr_reader :fees
+        # Whether or not to lock the suggested wallet address.
+        attr_reader :lock_wallet_address
+        # 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_reader :settlement_speed
+        # The amount of fiat we intend to onramp - excluding fees
+        attr_reader :source_amount
+        # A fiat currency code
+        attr_reader :source_currency
+        # The on-chain transaction hash (also referred to as transaction ID or tx_hash) of the transaction that was sent to the customer's wallet. The format varies by chain (e.g. `0xc257...1a95` on Ethereum, `5UB1...v3xZ` on Solana, or `a1b2...bf00` on Bitcoin). This will only be set if the session reaches `status=fulfillment_complete` and we've transferred the crypto successfully to the external wallet.
+        attr_reader :transaction_id
+        # The consumer's wallet address (where crypto will be sent to)
+        attr_reader :wallet_address
+        # The end customer's crypto wallet address (for each network) to use for this transaction.
+        attr_reader :wallet_addresses
+
+        def self.inner_class_types
+          @inner_class_types = { fees: Fees, wallet_addresses: WalletAddresses }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # A client secret that can be used to drive a single session using our embedded widget.
+      #
+      # Related guide: [Set up an onramp integration](https://docs.stripe.com/crypto/integrate-the-onramp)
+      attr_reader :client_secret
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if any user kyc details were provided during the creation of the onramp session. Otherwise, has the value `false`.
+      attr_reader :kyc_details_provided
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # 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.
+      attr_reader :metadata
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Redirect your users to the URL for a prebuilt frontend integration of the crypto onramp on the standalone hosted onramp.
+      #
+      # Related guide: [Mint a session with a redirect url](https://docs.stripe.com/crypto/standalone-hosted-onramp#mint-a-session-with-a-redirect-url)
+      attr_reader :redirect_url
+      # The status of the Onramp Session. One of = `{initialized, rejected, requires_payment, fulfillment_processing, fulfillment_complete}`
+      attr_reader :status
+      # Attribute for field transaction_details
+      attr_reader :transaction_details
+
+      # Completes a headless CryptoOnrampSession.
+      #
+      # This method will attempt to confirm the payment and execute the quote to deliver the crypto to the customer.
+      def checkout(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/crypto/onramp_sessions/%<id>s/checkout", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Completes a headless CryptoOnrampSession.
+      #
+      # This method will attempt to confirm the payment and execute the quote to deliver the crypto to the customer.
+      def self.checkout(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/crypto/onramp_sessions/%<id>s/checkout", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a CryptoOnrampSession object.
+      #
+      # After the CryptoOnrampSession is created, display the onramp session modal using the client_secret.
+      #
+      # Related guide: [Set up an onramp integration](https://docs.stripe.com/docs/crypto/integrate-the-onramp)
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/crypto/onramp_sessions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of onramp sessions that match the filter criteria. The onramp sessions are returned in sorted order, with the most recent onramp sessions appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/crypto/onramp_sessions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Refreshes an executable quote for a CryptoOnrampSession.
+      def quote(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/crypto/onramp_sessions/%<id>s/quote", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Refreshes an executable quote for a CryptoOnrampSession.
+      def self.quote(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/crypto/onramp_sessions/%<id>s/quote", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { transaction_details: TransactionDetails }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/crypto/onramp_transaction_limits.rb

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Crypto
+    # This object represents the limit for the remaining amount that the crypto customer can onramp.
+    class OnrampTransactionLimits < SingletonAPIResource
+      OBJECT_NAME = "crypto.onramp_transaction_limits"
+      def self.object_name
+        "crypto.onramp_transaction_limits"
+      end
+
+      # The ID of the crypto customer.
+      attr_reader :crypto_customer_id
+      # The remaining onramp limit for the crypto customer, separated by currency, payment method, and settlement speed.
+      #
+      # Limits are shown for currencies that correspond to the regions where the customer previously transacted. If the customer has no prior transactions, we return limits for all supported currencies.
+      attr_reader :limits
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/customer.rb

@@ -93,6 +93,19 @@ module Stripe
       end
     end
 
+    class Redaction < ::Stripe::StripeObject
+      # Indicates whether this object and its related objects have been redacted or not.
+      attr_reader :status
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class Shipping < ::Stripe::StripeObject
       class Address < ::Stripe::StripeObject
         # City, district, suburb, town, or village.
@@ -226,6 +239,8 @@ module Stripe
     attr_reader :phone
     # The customer's preferred locales (languages), ordered by preference.
     attr_reader :preferred_locales
+    # Redaction status of this customer. If not null, this customer is associated to a redaction job.
+    attr_reader :redaction
     # Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
     attr_reader :shipping
     # The customer's payment sources, if any.
@@ -438,6 +453,7 @@ module Stripe
       @inner_class_types = {
         address: Address,
         invoice_settings: InvoiceSettings,
+        redaction: Redaction,
         shipping: Shipping,
         tax: Tax,
       }

data/lib/stripe/resources/customer_session.rb

@@ -163,6 +163,39 @@ module Stripe
           @field_remappings = {}
         end
       end
+
+      class TaxIdElement < ::Stripe::StripeObject
+        class Features < ::Stripe::StripeObject
+          # 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_reader :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_reader :tax_id_save
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Whether the Tax ID Element is enabled.
+        attr_reader :enabled
+        # This hash defines whether the Tax ID Element supports certain features.
+        attr_reader :features
+
+        def self.inner_class_types
+          @inner_class_types = { features: Features }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
       # This hash contains whether the buy button is enabled.
       attr_reader :buy_button
       # This hash contains whether the customer sheet is enabled and the features it supports.
@@ -173,6 +206,8 @@ module Stripe
       attr_reader :payment_element
       # This hash contains whether the pricing table is enabled.
       attr_reader :pricing_table
+      # This hash contains whether the Tax ID Element is enabled and the features it supports.
+      attr_reader :tax_id_element
 
       def self.inner_class_types
         @inner_class_types = {
@@ -181,6 +216,7 @@ module Stripe
           mobile_payment_element: MobilePaymentElement,
           payment_element: PaymentElement,
           pricing_table: PricingTable,
+          tax_id_element: TaxIdElement,
         }
       end
 

data/lib/stripe/resources/delegated_checkout/order.rb

@@ -0,0 +1,142 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module DelegatedCheckout
+    # An order represents the post-checkout lifecycle of a delegated checkout purchase.
+    class Order < APIResource
+      OBJECT_NAME = "delegated_checkout.order"
+      def self.object_name
+        "delegated_checkout.order"
+      end
+
+      class LineItem < ::Stripe::StripeObject
+        class ProductDetails < ::Stripe::StripeObject
+          # The item description.
+          attr_reader :description
+          # The item images.
+          attr_reader :images
+          # The item title.
+          attr_reader :title
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Quantity < ::Stripe::StripeObject
+          # The current quantity.
+          attr_reader :current
+          # The ordered quantity.
+          attr_reader :ordered
+          # The shipped quantity.
+          attr_reader :shipped
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Totals < ::Stripe::StripeObject
+          # The base amount for the line item.
+          attr_reader :base_amount
+          # The discount amount for the line item.
+          attr_reader :discount
+          # The subtotal amount for the line item.
+          attr_reader :subtotal
+          # The tax amount for the line item.
+          attr_reader :tax
+          # The total amount for the line item.
+          attr_reader :total
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The order line item key.
+        attr_reader :key
+        # Attribute for field product_details
+        attr_reader :product_details
+        # Attribute for field quantity
+        attr_reader :quantity
+        # The SKU ID of the line item.
+        attr_reader :sku_id
+        # The totals for this line item.
+        attr_reader :totals
+        # The line item unit amount.
+        attr_reader :unit_amount
+
+        def self.inner_class_types
+          @inner_class_types = { product_details: ProductDetails, quantity: Quantity, totals: Totals }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Totals < ::Stripe::StripeObject
+        # The discount amount for the order.
+        attr_reader :discount
+        # The fulfillment amount for the order.
+        attr_reader :fulfillment
+        # The subtotal amount for the order.
+        attr_reader :subtotal
+        # The tax amount for the order.
+        attr_reader :tax
+        # The total amount for the order.
+        attr_reader :total
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+      # Unique identifier for the object.
+      attr_reader :id
+      # The latest order event for this order.
+      attr_reader :latest_order_event
+      # The line items in this order.
+      attr_reader :line_items
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The permalink URL for this order.
+      attr_reader :permalink_url
+      # The requested session associated with this order.
+      attr_reader :requested_session
+      # The seller reference for this order.
+      attr_reader :seller_reference
+      # The totals for this order.
+      attr_reader :totals
+
+      def self.inner_class_types
+        @inner_class_types = { line_items: LineItem, totals: Totals }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/delegated_checkout/order_event.rb

@@ -0,0 +1,118 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module DelegatedCheckout
+    # An order event represents a change to a delegated checkout order.
+    class OrderEvent < APIResource
+      OBJECT_NAME = "delegated_checkout.order_event"
+      def self.object_name
+        "delegated_checkout.order_event"
+      end
+
+      class Adjustment < ::Stripe::StripeObject
+        class LineItem < ::Stripe::StripeObject
+          # The line item key.
+          attr_reader :key
+          # The quantity associated with the order event.
+          attr_reader :quantity
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The amount associated with the adjustment.
+        attr_reader :amount
+        # The currency associated with the adjustment amount.
+        attr_reader :currency
+        # The description of the adjustment.
+        attr_reader :description
+        # The line items associated with the adjustment.
+        attr_reader :line_items
+        # The status of the adjustment.
+        attr_reader :status
+        # The type of adjustment.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { line_items: LineItem }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Fulfillment < ::Stripe::StripeObject
+        class LineItem < ::Stripe::StripeObject
+          # The line item key.
+          attr_reader :key
+          # The quantity associated with the order event.
+          attr_reader :quantity
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The carrier for the fulfillment.
+        attr_reader :carrier
+        # Time at which the fulfillment was delivered. Measured in seconds since the Unix epoch.
+        attr_reader :delivered_at
+        # The line items associated with the fulfillment.
+        attr_reader :line_items
+        # Time at which the fulfillment shipped. Measured in seconds since the Unix epoch.
+        attr_reader :shipped_at
+        # The status of the fulfillment.
+        attr_reader :status
+        # The tracking number for the fulfillment.
+        attr_reader :tracking_number
+        # The tracking URL for the fulfillment.
+        attr_reader :tracking_url
+
+        def self.inner_class_types
+          @inner_class_types = { line_items: LineItem }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The adjustment details for this order event.
+      attr_reader :adjustment
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The fulfillment details for this order event.
+      attr_reader :fulfillment
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Time at which this event occurred. Measured in seconds since the Unix epoch.
+      attr_reader :occurred_at
+      # The delegated checkout order associated with this order event.
+      attr_reader :order
+      # The requested session associated with this order event.
+      attr_reader :requested_session
+      # The type of order event.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { adjustment: Adjustment, fulfillment: Fulfillment }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end