stripe 17.2.0.pre.beta.1 → 17.3.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

@@ -39,20 +39,24 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # Before and after changes for the primary related object.
+        attr_reader :changes
         # Authentication context needed to fetch the event or related object.
         attr_reader :context
         # Time at which the object was created.
         attr_reader :created
         # Unique identifier for the event.
         attr_reader :id
+        # 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
         # String representing the object's type. Objects of the same type share the same value of the object field.
         attr_reader :object
         # Reason for the event.
         attr_reader :reason
         # The type of the event.
         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
+        # For interop events, this is the snapshot event ID.
+        attr_reader :v1_event_id
 
         def self.inner_class_types
           @inner_class_types = { reason: Reason }

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

@@ -178,6 +178,8 @@ module Stripe
         attr_reader :receipt_url
         # Details about the OutboundPayment notification settings for recipient.
         attr_reader :recipient_notification
+        # The recipient verification id for this OutboundPayment. Only required for countries with regulatory mandates to verify recipient names before OutboundPayment creation.
+        attr_reader :recipient_verification
         # The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). It will default to `STRIPE` if not set on the account settings.
         attr_reader :statement_descriptor
         # Closed Enum. Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`.

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

@@ -158,6 +158,8 @@ module Stripe
         attr_reader :object
         # A link to the Stripe-hosted receipt for this OutboundTransfer. The receipt link remains active for 60 days from the OutboundTransfer creation date. After this period, the link will expire and the receipt url value will be null.
         attr_reader :receipt_url
+        # The recipient verification id for this OutboundTransfer. Only required for countries with regulatory mandates to verify recipient names before OutboundTransfer creation.
+        attr_reader :recipient_verification
         # The description that appears on the receiving end for an OutboundTransfer (for example, bank statement for external bank transfer). It will default to `STRIPE` if not set on the account settings.
         attr_reader :statement_descriptor
         # Closed Enum. Current status of the OutboundTransfer: `processing`, `failed`, `posted`, `returned`, `canceled`.

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

@@ -75,6 +75,27 @@ module Stripe
             @field_remappings = {}
           end
         end
+
+        class CryptoWallet < ::Stripe::StripeObject
+          # Destination wallet address.
+          attr_reader :address
+          # Whether the crypto wallet was archived. Crypto wallets can be archived through the /archive API,
+          # and they will not be automatically archived by Stripe. Archived crypto wallets cannot be used as
+          # payout method and will not appear in the payout method list.
+          attr_reader :archived
+          # Optional field, required if network supports memos (only "stellar" currently).
+          attr_reader :memo
+          # Which rail is being used to make an outbound money movement to this wallet.
+          attr_reader :network
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
         # A set of available payout speeds for this payout method.
         attr_reader :available_payout_speeds
         # Created timestamp.
@@ -95,9 +116,16 @@ module Stripe
         attr_reader :bank_account
         # The PayoutMethodCard object details.
         attr_reader :card
+        # The PayoutMethodCryptoWallet object details.
+        attr_reader :crypto_wallet
 
         def self.inner_class_types
-          @inner_class_types = { usage_status: UsageStatus, bank_account: BankAccount, card: Card }
+          @inner_class_types = {
+            usage_status: UsageStatus,
+            bank_account: BankAccount,
+            card: Card,
+            crypto_wallet: CryptoWallet,
+          }
         end
 
         def self.field_remappings

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

@@ -187,6 +187,8 @@ module Stripe
         attr_reader :created
         # Freeform string set by originator of the ReceivedCredit.
         attr_reader :description
+        # The amount and currency of the original/external credit request.
+        attr_reader :external_amount
         # Financial Account ID on which funds for ReceivedCredit were received.
         attr_reader :financial_account
         # Unique identifier for the ReceivedCredit.

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

@@ -76,6 +76,8 @@ module Stripe
           end
           # The Financial Address that was debited.
           attr_reader :financial_address
+          # Open Enum. Indicates the origin type through which this debit was initiated.
+          attr_reader :origin_type
           # Open Enum. The type of the payment method used to originate the debit.
           attr_reader :payment_method_type
           # The statement descriptor set by the originator of the debit.
@@ -98,6 +100,8 @@ module Stripe
         attr_reader :created
         # Freeform string sent by the originator of the ReceivedDebit.
         attr_reader :description
+        # The amount and currency of the original/external debit request.
+        attr_reader :external_amount
         # Financial Account on which funds for ReceivedDebit were debited.
         attr_reader :financial_account
         # Unique identifier for the ReceivedDebit.

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

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # RecipientVerification represents a verification of recipient you intend to send funds to.
+      class RecipientVerification < APIResource
+        OBJECT_NAME = "v2.money_management.recipient_verification"
+        def self.object_name
+          "v2.money_management.recipient_verification"
+        end
+
+        class MatchResultDetails < ::Stripe::StripeObject
+          # The account name associated with the bank account as provided by the VoP provider, only present if there is a match or close match.
+          attr_reader :matched_name
+          # A message describing the match result.
+          attr_reader :message
+          # The name associated with the provided recipient.
+          attr_reader :provided_name
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusTransitions < ::Stripe::StripeObject
+          # Timestamp describing when a RecipientVerification changed status to `acknowledged`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :acknowledged_at
+          # Timestamp describing when a RecipientVerification changed status to `consumed`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :consumed_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The OBP/OBT ID that consumed this verification, present if one is successfully created.
+        attr_reader :consumed_by
+        # Time at which the RecipientVerification 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
+        # Time at which the RecipientVerification expires, 5 minutes after the creation.
+        # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :expires_at
+        # The ID of the RecipientVerification.
+        attr_reader :id
+        # Closed Enum. Match level of the RecipientVerification: `match`, `close_match`, `no_match`, `unavailable`.
+        attr_reader :match_result
+        # Details for the match result.
+        attr_reader :match_result_details
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Closed Enum. Current status of the RecipientVerification: `verified`, `consumed`, `expired`, `awaiting_acknowledgement`, `acknowledged`.
+        attr_reader :status
+        # Hash containing timestamps of when the object transitioned to a particular status.
+        attr_reader :status_transitions
+        # 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 = {
+            match_result_details: MatchResultDetails,
+            status_transitions: StatusTransitions,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/reporting/report.rb

@@ -0,0 +1,116 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Reporting
+      # The Report resource represents a customizable report template that provides insights into various aspects of your Stripe integration.
+      class Report < APIResource
+        OBJECT_NAME = "v2.reporting.report"
+        def self.object_name
+          "v2.reporting.report"
+        end
+
+        class Parameters < ::Stripe::StripeObject
+          class ArrayDetails < ::Stripe::StripeObject
+            class EnumDetails < ::Stripe::StripeObject
+              # Allowed values of the enum.
+              attr_reader :allowed_values
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Data type of the elements in the array.
+            attr_reader :element_type
+            # Details about enum elements in the array.
+            attr_reader :enum_details
+
+            def self.inner_class_types
+              @inner_class_types = { enum_details: EnumDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class EnumDetails < ::Stripe::StripeObject
+            # Allowed values of the enum.
+            attr_reader :allowed_values
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class TimestampDetails < ::Stripe::StripeObject
+            # Maximum permitted timestamp which can be requested.
+            attr_reader :max
+            # Minimum permitted timestamp which can be requested.
+            attr_reader :min
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # For array parameters, provides details about the array elements.
+          attr_reader :array_details
+          # Explains the purpose and usage of the parameter.
+          attr_reader :description
+          # For enum parameters, provides the list of allowed values.
+          attr_reader :enum_details
+          # Indicates whether the parameter must be provided.
+          attr_reader :required
+          # For timestamp parameters, specifies the allowed date range.
+          attr_reader :timestamp_details
+          # The data type of the parameter.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {
+              array_details: ArrayDetails,
+              enum_details: EnumDetails,
+              timestamp_details: TimestampDetails,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The unique identifier of the `Report` object.
+        attr_reader :id
+        # The human-readable name of the `Report`.
+        attr_reader :name
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Specification of the parameters that the `Report` accepts. It details each parameter's
+        # name, description, whether it is required, and any validations performed.
+        attr_reader :parameters
+        # 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 = { parameters: Parameters }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/reporting/report_run.rb

@@ -0,0 +1,128 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Reporting
+      # The `ReportRun` object represents an instance of a `Report` generated with specific
+      # run parameters. Once the object is created, Stripe begins processing the report. When
+      # the report has finished running, it will give you a reference to the results.
+      class ReportRun < APIResource
+        OBJECT_NAME = "v2.reporting.report_run"
+        def self.object_name
+          "v2.reporting.report_run"
+        end
+
+        class Result < ::Stripe::StripeObject
+          class File < ::Stripe::StripeObject
+            class DownloadUrl < ::Stripe::StripeObject
+              # The time that the URL expires.
+              attr_reader :expires_at
+              # The URL that can be used for accessing the file.
+              attr_reader :url
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The content type of the file.
+            attr_reader :content_type
+            # A pre-signed URL that allows secure, time-limited access to download the file.
+            attr_reader :download_url
+            # The total size of the file in bytes.
+            attr_reader :size
+
+            def self.inner_class_types
+              @inner_class_types = { download_url: DownloadUrl }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Contains metadata about the file produced by the `ReportRun`, including
+          # its content type, size, and a URL to download its contents.
+          attr_reader :file
+          # The type of the `ReportRun` result.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { file: File }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class ResultOptions < ::Stripe::StripeObject
+          # If set, the generated report file will be compressed into a ZIP folder.
+          # This is useful for reducing file size and download time for large reports.
+          attr_reader :compress_file
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusDetails < ::Stripe::StripeObject
+          # Error code categorizing the reason the `ReportRun` failed.
+          attr_reader :error_code
+          # Error message with additional details about the failure.
+          attr_reader :error_message
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Time at which the object was created.
+        attr_reader :created
+        # The unique identifier of the `ReportRun` 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
+        # The unique identifier of the `Report` object which was run.
+        attr_reader :report
+        # The human-readable name of the `Report` which was run.
+        attr_reader :report_name
+        # The parameters used to customize the generation of the report.
+        attr_reader :report_parameters
+        # Details how to retrieve the results of a successfully completed `ReportRun`.
+        attr_reader :result
+        # The options specified for customizing the output file of the `ReportRun`.
+        attr_reader :result_options
+        # The current status of the `ReportRun`.
+        attr_reader :status
+        # Additional details about the current state of the `ReportRun`. The field is currently only populated when a `ReportRun`
+        # is in the `failed` state, providing more information about why the report failed to generate successfully.
+        attr_reader :status_details
+        # 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 = {
+            result: Result,
+            result_options: ResultOptions,
+            status_details: StatusDetails,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/tax/automatic_rule.rb

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Tax
+      # An AutomaticRule holds automatic Tax configuration for a BillableItem.
+      class AutomaticRule < APIResource
+        OBJECT_NAME = "v2.tax.automatic_rule"
+        def self.object_name
+          "v2.tax.automatic_rule"
+        end
+
+        # The ID of the BillableItem.
+        attr_reader :billable_item
+        # The time at which the AutomaticRule object was created.
+        attr_reader :created
+        # The ID of the AutomaticRule 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
+        # The status of the AutomaticRule object.
+        attr_reader :status
+        # A TaxCode object that will be used for automatic tax calculations.
+        attr_reader :tax_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 = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end