stripe 17.2.0 → 17.3.0.pre.alpha.1

data/lib/stripe/resources/v2/payments/off_session_payment.rb

@@ -0,0 +1,242 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Payments
+      # OffSessionPayment resource.
+      class OffSessionPayment < APIResource
+        OBJECT_NAME = "v2.payments.off_session_payment"
+        def self.object_name
+          "v2.payments.off_session_payment"
+        end
+
+        class AmountDetails < ::Stripe::StripeObject
+          class LineItem < ::Stripe::StripeObject
+            class Tax < ::Stripe::StripeObject
+              # Total portion of the amount that is for tax.
+              attr_reader :total_tax_amount
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The amount an item was discounted for. Positive integer.
+            attr_reader :discount_amount
+            # Unique identifier of the product. At most 12 characters long.
+            attr_reader :product_code
+            # Name of the product. At most 100 characters long.
+            attr_reader :product_name
+            # Number of items of the product. Positive integer.
+            attr_reader :quantity
+            # Contains information about the tax on the item.
+            attr_reader :tax
+            # Cost of the product. Non-negative integer.
+            attr_reader :unit_cost
+
+            def self.inner_class_types
+              @inner_class_types = { tax: Tax }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Shipping < ::Stripe::StripeObject
+            # Portion of the amount that is for shipping.
+            attr_reader :amount
+            # The postal code that represents the shipping source.
+            attr_reader :from_postal_code
+            # The postal code that represents the shipping destination.
+            attr_reader :to_postal_code
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Tax < ::Stripe::StripeObject
+            # Total portion of the amount that is for tax.
+            attr_reader :total_tax_amount
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The amount the total transaction was discounted for.
+          attr_reader :discount_amount
+          # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
+          attr_reader :line_items
+          # Contains information about the shipping portion of the amount.
+          attr_reader :shipping
+          # Contains information about the tax portion of the amount.
+          attr_reader :tax
+
+          def self.inner_class_types
+            @inner_class_types = { line_items: LineItem, shipping: Shipping, tax: Tax }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Capture < ::Stripe::StripeObject
+          # The timestamp when this payment is no longer eligible to be captured.
+          attr_reader :capture_before
+          # The method to use to capture the payment.
+          attr_reader :capture_method
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class PaymentsOrchestration < ::Stripe::StripeObject
+          # True when you want to enable payments orchestration for this off-session payment. False otherwise.
+          attr_reader :enabled
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class RetryDetails < ::Stripe::StripeObject
+          # Number of authorization attempts so far.
+          attr_reader :attempts
+          # The pre-configured retry policy to use for the payment.
+          attr_reader :retry_policy
+          # Indicates the strategy for how you want Stripe to retry the payment.
+          attr_reader :retry_strategy
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class TransferData < ::Stripe::StripeObject
+          # The amount transferred to the destination account. This transfer will occur
+          # automatically after the payment succeeds. If no amount is specified, by default
+          # the entire payment amount is transferred to the destination account. The amount
+          # must be less than or equal to the
+          # [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
+          # and must be a positive integer representing how much to transfer in the smallest
+          # currency unit (e.g., 100 cents to charge $1.00).
+          attr_reader :amount
+          # The account (if any) that the payment is attributed to for tax reporting, and
+          # where funds from the payment are transferred to after payment success.
+          attr_reader :destination
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The amount available to be captured.
+        attr_reader :amount_capturable
+        # Provides industry-specific information about the amount.
+        attr_reader :amount_details
+        # The “presentment amount” to be collected from the customer.
+        attr_reader :amount_requested
+        # The frequency of the underlying payment.
+        attr_reader :cadence
+        # Details about the capture configuration for the OffSessionPayment.
+        attr_reader :capture
+        # Whether the OffSessionPayment should be captured automatically or manually.
+        attr_reader :capture_method
+        # ID of the owning compartment.
+        attr_reader :compartment_id
+        # Creation time of the OffSessionPayment. Represented as a RFC 3339 date & time UTC
+        # value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :created
+        # ID of the Customer to which this OffSessionPayment belongs.
+        attr_reader :customer
+        # The reason why the OffSessionPayment failed.
+        attr_reader :failure_reason
+        # Unique identifier for the object.
+        attr_reader :id
+        # The payment error encountered in the previous attempt to authorize the payment.
+        attr_reader :last_authorization_attempt_error
+        # Payment attempt record for the latest attempt, if one exists.
+        attr_reader :latest_payment_attempt_record
+        # 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
+        # Set of [key-value pairs](https://docs.corp.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. Learn more about
+        # [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
+        attr_reader :metadata
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The account (if any) for which the funds of the OffSessionPayment are intended.
+        attr_reader :on_behalf_of
+        # ID of the payment method used in this OffSessionPayment.
+        attr_reader :payment_method
+        # Payment record associated with the OffSessionPayment.
+        attr_reader :payment_record
+        # Details about the payments orchestration configuration.
+        attr_reader :payments_orchestration
+        # Details about the OffSessionPayment retries.
+        attr_reader :retry_details
+        # Text that appears on the customer’s statement as the statement descriptor for a
+        # non-card charge. This value overrides the account’s default statement descriptor.
+        # For information about requirements, including the 22-character limit, see the
+        # [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
+        attr_reader :statement_descriptor
+        # Provides information about a card charge. Concatenated to the account’s
+        # [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+        # to form the complete statement descriptor that appears on the customer’s statement.
+        attr_reader :statement_descriptor_suffix
+        # Status of this OffSessionPayment, one of `pending`, `pending_retry`, `processing`,
+        # `failed`, `canceled`, `requires_capture`, or `succeeded`.
+        attr_reader :status
+        # Test clock that can be used to advance the retry attempts in a sandbox.
+        attr_reader :test_clock
+        # The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
+        attr_reader :transfer_data
+
+        def self.inner_class_types
+          @inner_class_types = {
+            amount_details: AmountDetails,
+            capture: Capture,
+            payments_orchestration: PaymentsOrchestration,
+            retry_details: RetryDetails,
+            transfer_data: TransferData,
+          }
+        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