stripe 18.1.0 → 18.2.0.pre.alpha.1

data/lib/stripe/resources/v2/core/claimable_sandbox.rb

@@ -0,0 +1,105 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      # A claimable sandbox represents a Stripe sandbox that is anonymous.
+      # When it is created, it can be prefilled with specific metadata, such as email, name, or country.
+      # Claimable sandboxes can be claimed through a URL. When a user claims a sandbox through this URL,
+      # it will prompt them to create a new Stripe account. Or, it will allow them to claim this sandbox in their
+      # existing Stripe account.
+      # Claimable sandboxes have 60 days to be claimed. After this expiration time has passed,
+      # if the sandbox is not claimed, it will be deleted.
+      class ClaimableSandbox < APIResource
+        OBJECT_NAME = "v2.core.claimable_sandbox"
+        def self.object_name
+          "v2.core.claimable_sandbox"
+        end
+
+        class Prefill < ::Stripe::StripeObject
+          # Country in which the account holder resides, or in which the business is legally established.
+          # Use two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_reader :country
+          # Email that this sandbox is meant to be claimed by. Stripe will
+          # send an email to this email address before the sandbox expires.
+          attr_reader :email
+          # Name for the sandbox.
+          attr_reader :name
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SandboxDetails < ::Stripe::StripeObject
+          class ApiKeys < ::Stripe::StripeObject
+            # Used to communicate with [Stripe's MCP server](https://docs.stripe.com/mcp).
+            # This allows LLM agents to securely operate on a Stripe account.
+            attr_reader :mcp
+            # Publicly accessible in a web or mobile app client-side code.
+            attr_reader :publishable
+            # Should be stored securely in server-side code (such as an environment variable).
+            attr_reader :secret
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The sandbox's Stripe account ID.
+          attr_reader :account
+          # Keys that can be used to set up an integration for this sandbox and operate on the account. This will be present only in the create response, and will be null in subsequent retrieve responses.
+          attr_reader :api_keys
+          # The livemode sandbox Stripe account ID. This field is only set if the user activates their sandbox
+          # and chooses to install your platform's Stripe App in their live account.
+          attr_reader :owner_account
+
+          def self.inner_class_types
+            @inner_class_types = { api_keys: ApiKeys }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # URL for user to claim sandbox into their existing Stripe account.
+        # The value will be null if the sandbox status is `claimed` or `expired`.
+        attr_reader :claim_url
+        # The timestamp the sandbox was claimed. The value will be null if the sandbox status is not `claimed`.
+        attr_reader :claimed_at
+        # When the sandbox is created.
+        attr_reader :created
+        # The timestamp the sandbox will expire. The value will be null if the sandbox is `claimed`.
+        attr_reader :expires_at
+        # Unique identifier for the Claimable sandbox.
+        attr_reader :id
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Values prefilled during the creation of the sandbox. When a user claims the sandbox, they will be able to update these values.
+        attr_reader :prefill
+        # Data about the Stripe sandbox object.
+        attr_reader :sandbox_details
+        # Status of the sandbox. One of `unclaimed`, `expired`, `claimed`.
+        attr_reader :status
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+
+        def self.inner_class_types
+          @inner_class_types = { prefill: Prefill, sandbox_details: SandboxDetails }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/core/event.rb

@@ -13,13 +13,62 @@ module Stripe
 
         class Reason < ::Stripe::StripeObject
           class Request < ::Stripe::StripeObject
+            class Client < ::Stripe::StripeObject
+              class ApiKey < ::Stripe::StripeObject
+                # The ID of the API key.
+                attr_reader :id
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+
+              class DashboardUser < ::Stripe::StripeObject
+                # The email of the dashboard user.
+                attr_reader :email
+                # The IP address of the user.
+                attr_reader :ip_address
+                # The machine identifier of the user.
+                attr_reader :machine_identifier
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # The type of the client.
+              attr_reader :type
+              # API key that triggered the event.
+              attr_reader :api_key
+              # Dashboard user that triggered the event.
+              attr_reader :dashboard_user
+              # Stripe action that triggered the event.
+              attr_reader :stripe_action
+
+              def self.inner_class_types
+                @inner_class_types = { api_key: ApiKey, dashboard_user: DashboardUser }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The client details that made the request.
+            attr_reader :client
             # ID of the API request that caused the event.
             attr_reader :id
             # The idempotency key transmitted during the request.
             attr_reader :idempotency_key
 
             def self.inner_class_types
-              @inner_class_types = {}
+              @inner_class_types = { client: Client }
             end
 
             def self.field_remappings

data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb

@@ -0,0 +1,134 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      module Vault
+        # Use the GBBankAccounts API to create and manage GB bank account objects
+        class GbBankAccount < APIResource
+          OBJECT_NAME = "v2.core.vault.gb_bank_account"
+          def self.object_name
+            "v2.core.vault.gb_bank_account"
+          end
+
+          class AlternativeReference < ::Stripe::StripeObject
+            # The ID of the alternative resource being referenced.
+            attr_reader :id
+            # The type of the alternative reference (e.g., external_account for V1 external accounts).
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class ConfirmationOfPayee < ::Stripe::StripeObject
+            class Result < ::Stripe::StripeObject
+              class Matched < ::Stripe::StripeObject
+                # The business type given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
+                # Closed enum.
+                attr_reader :business_type
+                # The name given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
+                attr_reader :name
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+
+              class Provided < ::Stripe::StripeObject
+                # The provided or Legal Entity business type to match against the CoP service. Closed enum.
+                attr_reader :business_type
+                # The provided or Legal Entity name to match against the CoP service.
+                attr_reader :name
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # When the CoP result was created.
+              attr_reader :created
+              # Whether or not the information of the bank account matches what you have provided. Closed enum.
+              attr_reader :match_result
+              # The fields that CoP service matched against. Only has value if MATCH or PARTIAL_MATCH, empty otherwise.
+              attr_reader :matched
+              # Human-readable message describing the match result.
+              attr_reader :message
+              # The fields that are matched against what the network has on file.
+              attr_reader :provided
+
+              def self.inner_class_types
+                @inner_class_types = { matched: Matched, provided: Provided }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The result of the Confirmation of Payee check, once the check has been initiated. Closed enum.
+            attr_reader :result
+            # The current state of Confirmation of Payee on this bank account. Closed enum.
+            attr_reader :status
+
+            def self.inner_class_types
+              @inner_class_types = { result: Result }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The alternative reference for this payout method, if it's a projected payout method.
+          attr_reader :alternative_reference
+          # Whether this bank account object was archived. Bank account objects can be archived through
+          # the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects
+          # cannot be used as outbound destinations and will not appear in the outbound destination list.
+          attr_reader :archived
+          # Closed Enum. The type of the bank account (checking or savings).
+          attr_reader :bank_account_type
+          # The name of the bank.
+          attr_reader :bank_name
+          # Information around the status of Confirmation of Payee matching done on this bank account.
+          # Confirmation of Payee is a name matching service that must be done before making OutboundPayments in the UK.
+          attr_reader :confirmation_of_payee
+          # Creation time.
+          attr_reader :created
+          # The ID of the GBBankAccount object.
+          attr_reader :id
+          # The last 4 digits of the account number or IBAN.
+          attr_reader :last4
+          # String representing the object's type. Objects of the same type share the same value of the object field.
+          attr_reader :object
+          # The Sort Code of the bank account.
+          attr_reader :sort_code
+          # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+          attr_reader :livemode
+
+          def self.inner_class_types
+            @inner_class_types = {
+              alternative_reference: AlternativeReference,
+              confirmation_of_payee: ConfirmationOfPayee,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/core/vault/us_bank_account.rb

@@ -0,0 +1,103 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      module Vault
+        # Use the USBankAccounts API to create and manage US bank accounts objects that you can use to receive funds. Note that these are not interchangeable with v1 Tokens.
+        class UsBankAccount < APIResource
+          OBJECT_NAME = "v2.core.vault.us_bank_account"
+          def self.object_name
+            "v2.core.vault.us_bank_account"
+          end
+
+          class AlternativeReference < ::Stripe::StripeObject
+            # The ID of the alternative resource being referenced.
+            attr_reader :id
+            # The type of the alternative reference (e.g., external_account for V1 external accounts).
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Verification < ::Stripe::StripeObject
+            class MicrodepositVerificationDetails < ::Stripe::StripeObject
+              # Time when microdeposits will expire and have to be re-sent.
+              attr_reader :expires
+              # Microdeposit type can be amounts or descriptor_type.
+              attr_reader :microdeposit_type
+              # Time when microdeposits were sent.
+              attr_reader :sent
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The microdeposit verification details if the status is awaiting verification.
+            attr_reader :microdeposit_verification_details
+            # The bank account verification status.
+            attr_reader :status
+
+            def self.inner_class_types
+              @inner_class_types = {
+                microdeposit_verification_details: MicrodepositVerificationDetails,
+              }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The alternative reference for this payout method, if it's a projected payout method.
+          attr_reader :alternative_reference
+          # Whether this USBankAccount object was archived.
+          attr_reader :archived
+          # Closed Enum. The type of bank account (checking or savings).
+          attr_reader :bank_account_type
+          # The name of the bank this bank account belongs to. This field is populated automatically by Stripe based on the routing number.
+          attr_reader :bank_name
+          # Creation time of the object.
+          attr_reader :created
+          # The fedwire routing number of the bank account.
+          attr_reader :fedwire_routing_number
+          # The ID of the Financial Connections Account used to create the bank account.
+          attr_reader :financial_connections_account
+          # The ID of the USBankAccount object.
+          attr_reader :id
+          # The last 4 digits of the account number.
+          attr_reader :last4
+          # String representing the object's type. Objects of the same type share the same value of the object field.
+          attr_reader :object
+          # The ACH routing number of the bank account.
+          attr_reader :routing_number
+          # The bank account verification details.
+          attr_reader :verification
+          # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+          attr_reader :livemode
+
+          def self.inner_class_types
+            @inner_class_types = {
+              alternative_reference: AlternativeReference,
+              verification: Verification,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/financial_address_credit_simulation.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class FinancialAddressCreditSimulation < APIResource
+      OBJECT_NAME = "financial_address_credit_simulation"
+      def self.object_name
+        "financial_address_credit_simulation"
+      end
+
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      attr_reader :object
+      # The status of the request, signifying whether a simulated credit was initiated.
+      attr_reader :status
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class FinancialAddressGeneratedMicrodeposits < APIResource
+      OBJECT_NAME = "financial_address_generated_microdeposits"
+      def self.object_name
+        "financial_address_generated_microdeposits"
+      end
+
+      class Amount < ::Stripe::StripeObject
+        # A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+        attr_reader :value
+        # 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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The amounts of the microdeposits that were generated.
+      attr_reader :amounts
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      attr_reader :object
+      # Closed Enum. The status of the request.
+      attr_reader :status
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+
+      def self.inner_class_types
+        @inner_class_types = { amounts: Amount }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/iam/api_key.rb

@@ -0,0 +1,129 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Iam
+      # An API key.
+      class ApiKey < APIResource
+        OBJECT_NAME = "v2.iam.api_key"
+        def self.object_name
+          "v2.iam.api_key"
+        end
+
+        class ManagedBy < ::Stripe::StripeObject
+          class Application < ::Stripe::StripeObject
+            # Identifier of the application.
+            attr_reader :id
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The type of entity.
+          attr_reader :type
+          # An application.
+          attr_reader :application
+
+          def self.inner_class_types
+            @inner_class_types = { application: Application }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class PublishableKey < ::Stripe::StripeObject
+          # The plaintext token for the API key.
+          attr_reader :token
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SecretKey < ::Stripe::StripeObject
+          class EncryptedSecret < ::Stripe::StripeObject
+            # The encrypted secret data in base64 format.
+            attr_reader :ciphertext
+            # The format of the encrypted secret (e.g., jwe_compact).
+            attr_reader :format
+            # The caller's identifier of the public key provided.
+            attr_reader :recipient_key_id
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The encrypted secret for the API key. Only included when a key is first created.
+          attr_reader :encrypted_secret
+          # Redacted version of the secret token for display purposes.
+          attr_reader :secret_token_redacted
+          # The plaintext token for the API key. Only included for testmode keys.
+          attr_reader :token
+
+          def self.inner_class_types
+            @inner_class_types = { encrypted_secret: EncryptedSecret }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Timestamp when the API key was created.
+        attr_reader :created
+        # Timestamp when the API key expires.
+        attr_reader :expires_at
+        # Unique identifier of the API key.
+        attr_reader :id
+        # List of IP addresses allowed to use this API key. Addresses use IPv4 protocol, and may be a CIDR range (e.g., [100.10.38.255, 100.10.38.0/24]).
+        attr_reader :ip_allowlist
+        # Timestamp when the API key was last used.
+        attr_reader :last_used
+        # Account that manages this API key (for keys managed by platforms).
+        attr_reader :managed_by
+        # Name of the API key.
+        attr_reader :name
+        # Note or description for the API key.
+        attr_reader :note
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Current status of the API key (e.g., active, expired).
+        attr_reader :status
+        # Type of the API key.
+        attr_reader :type
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # Token set for a publishable key.
+        attr_reader :publishable_key
+        # Token set for a secret key.
+        attr_reader :secret_key
+
+        def self.inner_class_types
+          @inner_class_types = {
+            managed_by: ManagedBy,
+            publishable_key: PublishableKey,
+            secret_key: SecretKey,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/money_management/adjustment.rb

@@ -0,0 +1,82 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Adjustments represent Stripe-initiated credits or debits to a user balance. They might be used to amend balances due to technical or operational error.
+      class Adjustment < APIResource
+        OBJECT_NAME = "v2.money_management.adjustment"
+        def self.object_name
+          "v2.money_management.adjustment"
+        end
+
+        class AdjustedFlow < ::Stripe::StripeObject
+          # Closed Enum. If applicable, the type of flow linked to this Adjustment. The field matching this value will contain the ID of the flow.
+          attr_reader :type
+          # If applicable, the ID of the Adjustment linked to this Adjustment.
+          attr_reader :adjustment
+          # If applicable, the ID of the InboundTransfer linked to this Adjustment.
+          attr_reader :inbound_transfer
+          # If applicable, the ID of the OutboundPayment linked to this Adjustment.
+          attr_reader :outbound_payment
+          # If applicable, the ID of the OutboundTransfer linked to this Adjustment.
+          attr_reader :outbound_transfer
+          # If applicable, the ID of the ReceivedCredit linked to this Adjustment.
+          attr_reader :received_credit
+          # If applicable, the ID of the ReceivedDebit linked to this Adjustment.
+          attr_reader :received_debit
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Amount < ::Stripe::StripeObject
+          # A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+          attr_reader :value
+          # 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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # If applicable, contains information about the original flow linked to this Adjustment.
+        attr_reader :adjusted_flow
+        # The amount of the Adjustment.
+        attr_reader :amount
+        # Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :created
+        # Description of the Adjustment and what it was used for.
+        attr_reader :description
+        # The FinancialAccount that this adjustment is for.
+        attr_reader :financial_account
+        # Unique identifier for the object.
+        attr_reader :id
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # A link to the Stripe-hosted receipt that is provided when money movement is considered regulated under Stripe’s money transmission licenses. The receipt link remains active for 60 days from the Adjustment creation date. After this period, the link will expire and the receipt url value will be null.
+        attr_reader :receipt_url
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+
+        def self.inner_class_types
+          @inner_class_types = { adjusted_flow: AdjustedFlow, amount: Amount }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end