stripe 15.4.0 → 15.5.0.pre.beta.1

data/lib/stripe/resources/tax/association.rb

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input
+    class Association < APIResource
+      OBJECT_NAME = "tax.association"
+      def self.object_name
+        "tax.association"
+      end
+
+      class TaxTransactionAttempt < Stripe::StripeObject
+        class Committed < Stripe::StripeObject
+          # The [Tax Transaction](https://stripe.com/docs/api/tax/transaction/object)
+          attr_reader :transaction
+        end
+
+        class Errored < Stripe::StripeObject
+          # Details on why we couldn't commit the tax transaction.
+          attr_reader :reason
+        end
+        # Attribute for field committed
+        attr_reader :committed
+        # Attribute for field errored
+        attr_reader :errored
+        # The source of the tax transaction attempt. This is either a refund or a payment intent.
+        attr_reader :source
+        # The status of the transaction attempt. This can be `errored` or `committed`.
+        attr_reader :status
+      end
+
+      class FindParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Valid [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) id
+        attr_accessor :payment_intent
+
+        def initialize(expand: nil, payment_intent: nil)
+          @expand = expand
+          @payment_intent = payment_intent
+        end
+      end
+      # The [Tax Calculation](https://stripe.com/docs/api/tax/calculations/object) that was included in PaymentIntent.
+      attr_reader :calculation
+      # 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
+      # The [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) that this Tax Association is tracking.
+      attr_reader :payment_intent
+      # Information about the tax transactions linked to this payment intent
+      attr_reader :tax_transaction_attempts
+
+      # Finds a tax association object by PaymentIntent id.
+      def self.find(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/tax/associations/find",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/tax/form.rb

@@ -0,0 +1,211 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
+    #
+    # Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
+    class Form < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "tax.form"
+      def self.object_name
+        "tax.form"
+      end
+
+      class AuSerr < Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+      end
+
+      class CaMrdp < Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+      end
+
+      class EuDac7 < Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+      end
+
+      class FilingStatus < Stripe::StripeObject
+        class Jurisdiction < Stripe::StripeObject
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_reader :country
+          # Indicates the level of the jurisdiction where the form was filed.
+          attr_reader :level
+          # [ISO 3166-2 U.S. state code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix, if any. For example, "NY" for New York, United States. Null for non-U.S. forms.
+          attr_reader :state
+        end
+        # Time when the filing status was updated.
+        attr_reader :effective_at
+        # Attribute for field jurisdiction
+        attr_reader :jurisdiction
+        # The current status of the filed form.
+        attr_reader :value
+      end
+
+      class GbMrdp < Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+      end
+
+      class NzMrdp < Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+      end
+
+      class Payee < Stripe::StripeObject
+        # The ID of the payee's Stripe account.
+        attr_reader :account
+        # The external reference to this payee.
+        attr_reader :external_reference
+        # Either `account` or `external_reference`.
+        attr_reader :type
+      end
+
+      class Us1099K < Stripe::StripeObject
+        # Year represented by the information reported on the tax form.
+        attr_reader :reporting_year
+      end
+
+      class Us1099Misc < Stripe::StripeObject
+        # Year represented by the information reported on the tax form.
+        attr_reader :reporting_year
+      end
+
+      class Us1099Nec < Stripe::StripeObject
+        # Year represented by the information reported on the tax form.
+        attr_reader :reporting_year
+      end
+
+      class ListParams < Stripe::RequestParams
+        class Payee < Stripe::RequestParams
+          # The ID of the Stripe account whose forms will be retrieved.
+          attr_accessor :account
+          # The external reference to the payee whose forms will be retrieved.
+          attr_accessor :external_reference
+          # Specifies the payee type. Either `account` or `external_reference`.
+          attr_accessor :type
+
+          def initialize(account: nil, external_reference: nil, type: nil)
+            @account = account
+            @external_reference = external_reference
+            @type = type
+          end
+        end
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # The payee whose volume is represented on the tax form.
+        attr_accessor :payee
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+        # An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
+        attr_accessor :type
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          payee: nil,
+          starting_after: nil,
+          type: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @payee = payee
+          @starting_after = starting_after
+          @type = type
+        end
+      end
+
+      class PdfParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+      # Attribute for field au_serr
+      attr_reader :au_serr
+      # Attribute for field ca_mrdp
+      attr_reader :ca_mrdp
+      # The form that corrects this form, if any.
+      attr_reader :corrected_by
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Attribute for field eu_dac7
+      attr_reader :eu_dac7
+      # A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction’s tax authority.
+      attr_reader :filing_statuses
+      # Attribute for field gb_mrdp
+      attr_reader :gb_mrdp
+      # Unique identifier for the object.
+      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
+      # Attribute for field nz_mrdp
+      attr_reader :nz_mrdp
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Attribute for field payee
+      attr_reader :payee
+      # The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.
+      attr_reader :type
+      # Attribute for field us_1099_k
+      attr_reader :us_1099_k
+      # Attribute for field us_1099_misc
+      attr_reader :us_1099_misc
+      # Attribute for field us_1099_nec
+      attr_reader :us_1099_nec
+
+      # Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/tax/forms", params: params, opts: opts)
+      end
+
+      # Download the PDF for a tax form.
+      def pdf(params = {}, opts = {}, &read_body_chunk_block)
+        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
+        request_stream(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts,
+          base_address: :files,
+          &read_body_chunk_block
+        )
+      end
+
+      # Download the PDF for a tax form.
+      def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block)
+        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
+        execute_resource_request_stream(
+          :get,
+          format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
+          :files,
+          params,
+          opts,
+          &read_body_chunk_block
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/tax_id.rb

@@ -23,6 +23,8 @@ module Stripe
       attr_reader :application
       # The customer being referenced when `type` is `customer`.
       attr_reader :customer
+      # The account being referenced when `type` is `customer`.
+      attr_reader :customer_account
       # Type of owner referenced.
       attr_reader :type
     end
@@ -44,12 +46,15 @@ module Stripe
         attr_accessor :account
         # Customer the tax ID belongs to. Required when `type=customer`
         attr_accessor :customer
+        # v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
+        attr_accessor :customer_account
         # Type of owner referenced.
         attr_accessor :type
 
-        def initialize(account: nil, customer: nil, type: nil)
+        def initialize(account: nil, customer: nil, customer_account: nil, type: nil)
           @account = account
           @customer = customer
+          @customer_account = customer_account
           @type = type
         end
       end
@@ -79,12 +84,15 @@ module Stripe
         attr_accessor :account
         # Customer the tax ID belongs to. Required when `type=customer`
         attr_accessor :customer
+        # v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
+        attr_accessor :customer_account
         # Type of owner referenced.
         attr_accessor :type
 
-        def initialize(account: nil, customer: nil, type: nil)
+        def initialize(account: nil, customer: nil, customer_account: nil, type: nil)
           @account = account
           @customer = customer
+          @customer_account = customer_account
           @type = type
         end
       end
@@ -110,6 +118,8 @@ module Stripe
     attr_reader :created
     # ID of the customer.
     attr_reader :customer
+    # ID of the account.
+    attr_reader :customer_account
     # Unique identifier for the object.
     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.

data/lib/stripe/resources/terminal/onboarding_link.rb

@@ -0,0 +1,84 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    # Returns redirect links used for onboarding onto Tap to Pay on iPhone.
+    class OnboardingLink < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "terminal.onboarding_link"
+      def self.object_name
+        "terminal.onboarding_link"
+      end
+
+      class LinkOptions < Stripe::StripeObject
+        class AppleTermsAndConditions < Stripe::StripeObject
+          # Whether the link should also support users relinking their Apple account.
+          attr_reader :allow_relinking
+          # The business name of the merchant accepting Apple's Terms and Conditions.
+          attr_reader :merchant_display_name
+        end
+        # The options associated with the Apple Terms and Conditions link type.
+        attr_reader :apple_terms_and_conditions
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class LinkOptions < Stripe::RequestParams
+          class AppleTermsAndConditions < Stripe::RequestParams
+            # Whether the link should also support users relinking their Apple account.
+            attr_accessor :allow_relinking
+            # The business name of the merchant accepting Apple's Terms and Conditions.
+            attr_accessor :merchant_display_name
+
+            def initialize(allow_relinking: nil, merchant_display_name: nil)
+              @allow_relinking = allow_relinking
+              @merchant_display_name = merchant_display_name
+            end
+          end
+          # The options associated with the Apple Terms and Conditions link type.
+          attr_accessor :apple_terms_and_conditions
+
+          def initialize(apple_terms_and_conditions: nil)
+            @apple_terms_and_conditions = apple_terms_and_conditions
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Specific fields needed to generate the desired link type.
+        attr_accessor :link_options
+        # The type of link being generated.
+        attr_accessor :link_type
+        # Stripe account ID to generate the link for.
+        attr_accessor :on_behalf_of
+
+        def initialize(expand: nil, link_options: nil, link_type: nil, on_behalf_of: nil)
+          @expand = expand
+          @link_options = link_options
+          @link_type = link_type
+          @on_behalf_of = on_behalf_of
+        end
+      end
+      # Link type options associated with the current onboarding link object.
+      attr_reader :link_options
+      # The type of link being generated.
+      attr_reader :link_type
+      # Attribute for field object
+      attr_reader :object
+      # Stripe account ID to generate the link for.
+      attr_reader :on_behalf_of
+      # The link passed back to the user for their onboarding.
+      attr_reader :redirect_url
+
+      # Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/terminal/onboarding_links",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/terminal/reader.rb

@@ -125,6 +125,8 @@ module Stripe
             # Represents a per-transaction tipping configuration
             attr_reader :tipping
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # Represents a per-transaction override of a reader configuration
           attr_reader :collect_config
           # Most recent PaymentIntent processed by the reader.
@@ -142,6 +144,8 @@ module Stripe
             # If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
             attr_reader :return_url
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # Represents a per-transaction override of a reader configuration
           attr_reader :confirm_config
           # Most recent PaymentIntent processed by the reader.
@@ -163,6 +167,8 @@ module Stripe
             # Represents a per-transaction tipping configuration
             attr_reader :tipping
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # Most recent PaymentIntent processed by the reader.
           attr_reader :payment_intent
           # Represents a per-transaction override of a reader configuration
@@ -187,6 +193,8 @@ module Stripe
             # Enable customer-initiated cancellation when refunding this payment.
             attr_reader :enable_customer_cancellation
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # The amount being refunded.
           attr_reader :amount
           # Charge that is being refunded.

data/lib/stripe/resources/terminal/reader_collected_data.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    # Returns data collected by Terminal readers. This data is only stored for 24 hours.
+    class ReaderCollectedData < APIResource
+      OBJECT_NAME = "terminal.reader_collected_data"
+      def self.object_name
+        "terminal.reader_collected_data"
+      end
+
+      class Magstripe < Stripe::StripeObject
+        # The raw magstripe data collected by the reader.
+        attr_reader :data
+      end
+      # 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 the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # The magstripe data collected by the reader.
+      attr_reader :magstripe
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The type of data collected by the reader.
+      attr_reader :type
+    end
+  end
+end

data/lib/stripe/resources/transfer.rb

@@ -88,6 +88,8 @@ module Stripe
       attr_accessor :destination
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
+      # The FX rate in the quote is validated and used to convert the transfer amount to the destination currency.
+      attr_accessor :fx_quote
       # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
       attr_accessor :metadata
       # You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.
@@ -103,6 +105,7 @@ module Stripe
         description: nil,
         destination: nil,
         expand: nil,
+        fx_quote: nil,
         metadata: nil,
         source_transaction: nil,
         source_type: nil,
@@ -113,6 +116,7 @@ module Stripe
         @description = description
         @destination = destination
         @expand = expand
+        @fx_quote = fx_quote
         @metadata = metadata
         @source_transaction = source_transaction
         @source_type = source_type
@@ -150,6 +154,8 @@ module Stripe
     attr_reader :destination
     # If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
     attr_reader :destination_payment
+    # The FX Quote used for the transfer.
+    attr_reader :fx_quote
     # Unique identifier for the object.
     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.

data/lib/stripe/resources/treasury/financial_account.rb

@@ -131,10 +131,13 @@ module Stripe
 
           class FinancialAddresses < Stripe::RequestParams
             class Aba < Stripe::RequestParams
+              # Requested bank partner
+              attr_accessor :bank
               # Whether the FinancialAccount should have the Feature.
               attr_accessor :requested
 
-              def initialize(requested: nil)
+              def initialize(bank: nil, requested: nil)
+                @bank = bank
                 @requested = requested
               end
             end
@@ -274,6 +277,8 @@ module Stripe
             @outbound_flows = outbound_flows
           end
         end
+        # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+        attr_accessor :display_name
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
         # Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.
@@ -288,6 +293,7 @@ module Stripe
         attr_accessor :supported_currencies
 
         def initialize(
+          display_name: nil,
           expand: nil,
           features: nil,
           metadata: nil,
@@ -295,6 +301,7 @@ module Stripe
           platform_restrictions: nil,
           supported_currencies: nil
         )
+          @display_name = display_name
           @expand = expand
           @features = features
           @metadata = metadata
@@ -326,10 +333,13 @@ module Stripe
 
           class FinancialAddresses < Stripe::RequestParams
             class Aba < Stripe::RequestParams
+              # Requested bank partner
+              attr_accessor :bank
               # Whether the FinancialAccount should have the Feature.
               attr_accessor :requested
 
-              def initialize(requested: nil)
+              def initialize(bank: nil, requested: nil)
+                @bank = bank
                 @requested = requested
               end
             end
@@ -484,6 +494,8 @@ module Stripe
             @outbound_flows = outbound_flows
           end
         end
+        # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+        attr_accessor :display_name
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
         # Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.
@@ -498,6 +510,7 @@ module Stripe
         attr_accessor :platform_restrictions
 
         def initialize(
+          display_name: nil,
           expand: nil,
           features: nil,
           forwarding_settings: nil,
@@ -505,6 +518,7 @@ module Stripe
           nickname: nil,
           platform_restrictions: nil
         )
+          @display_name = display_name
           @expand = expand
           @features = features
           @forwarding_settings = forwarding_settings
@@ -544,10 +558,13 @@ module Stripe
 
         class FinancialAddresses < Stripe::RequestParams
           class Aba < Stripe::RequestParams
+            # Requested bank partner
+            attr_accessor :bank
             # Whether the FinancialAccount should have the Feature.
             attr_accessor :requested
 
-            def initialize(requested: nil)
+            def initialize(bank: nil, requested: nil)
+              @bank = bank
               @requested = requested
             end
           end
@@ -713,6 +730,8 @@ module Stripe
       attr_reader :country
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
+      # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+      attr_reader :display_name
       # Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
       # Stripe or the platform can control Features via the requested field.
       attr_reader :features

data/lib/stripe/resources/treasury/financial_account_features.rb

@@ -55,6 +55,8 @@ module Stripe
             # The `platform_restrictions` that are restricting this Feature.
             attr_reader :restriction
           end
+          # Requested bank partner for this Financial Account
+          attr_reader :bank
           # Whether the FinancialAccount should have the Feature.
           attr_reader :requested
           # Whether the Feature is operational.