stripe 19.2.0 → 19.3.0.pre.alpha.2

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

@@ -0,0 +1,264 @@
+# 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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        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
+
+        def self.inner_class_types
+          @inner_class_types = { jurisdiction: Jurisdiction }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Us1099K < ::Stripe::StripeObject
+        # Year represented by the information reported on the tax form.
+        attr_reader :reporting_year
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Us1099Misc < ::Stripe::StripeObject
+        # Year represented by the information reported on the tax form.
+        attr_reader :reporting_year
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Us1099Nec < ::Stripe::StripeObject
+        # Year represented by the information reported on the tax form.
+        attr_reader :reporting_year
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        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
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # 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
+
+      def self.inner_class_types
+        @inner_class_types = {
+          au_serr: AuSerr,
+          ca_mrdp: CaMrdp,
+          eu_dac7: EuDac7,
+          filing_statuses: FilingStatus,
+          gb_mrdp: GbMrdp,
+          nz_mrdp: NzMrdp,
+          payee: Payee,
+          us_1099_k: Us1099K,
+          us_1099_misc: Us1099Misc,
+          us_1099_nec: Us1099Nec,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # Tax locations represent venues for services, tickets, or other product types.
+    class Location < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "tax.location"
+      def self.object_name
+        "tax.location"
+      end
+
+      class Address < ::Stripe::StripeObject
+        # City, district, suburb, town, or village.
+        attr_reader :city
+        # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+        attr_reader :country
+        # Address line 1, such as the street, PO Box, or company name.
+        attr_reader :line1
+        # Address line 2, such as the apartment, suite, unit, or building.
+        attr_reader :line2
+        # ZIP or postal code.
+        attr_reader :postal_code
+        # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
+        attr_reader :state
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field address
+      attr_reader :address
+      # A descriptive text providing additional context about the tax location. This can include information about the venue, types of events held, services available, or any relevant details for better identification (e.g., "A spacious auditorium suitable for large concerts and events.").
+      attr_reader :description
+      # 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 type of tax location to be defined. Currently the only option is `performance`.
+      attr_reader :type
+
+      # Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(method: :post, path: "/v1/tax/locations", params: params, opts: opts)
+      end
+
+      # Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.
+      #
+      # The response includes detailed information for each tax location, such as its address, name, description, and current operational status.
+      #
+      # You can paginate through the list by using the limit parameter to control the number of results returned in each request.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/tax/locations", params: params, opts: opts)
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { address: Address }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -1746,6 +1746,84 @@ module Stripe
         end
 
         class Us < ::Stripe::StripeObject
+          class AdmissionsTax < ::Stripe::StripeObject
+            # A [jurisdiction code](https://docs.stripe.com/tax/registering?type=admissions_tax#registration-types) representing the local jurisdiction.
+            attr_reader :jurisdiction
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class AttendanceTax < ::Stripe::StripeObject
+            # A [jurisdiction code](https://docs.stripe.com/tax/registering?type=attendance_tax#registration-types) representing the local jurisdiction.
+            attr_reader :jurisdiction
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class EntertainmentTax < ::Stripe::StripeObject
+            # A [jurisdiction code](https://docs.stripe.com/tax/registering?type=entertainment_tax#registration-types) representing the local jurisdiction.
+            attr_reader :jurisdiction
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class GrossReceiptsTax < ::Stripe::StripeObject
+            # A [jurisdiction code](https://docs.stripe.com/tax/registering?type=gross_receipts_tax#registration-types) representing the local jurisdiction.
+            attr_reader :jurisdiction
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class HomeRuleTax < ::Stripe::StripeObject
+            # A [jurisdiction code](https://docs.stripe.com/tax/registering?type=home_rule_tax#registration-types) representing the local jurisdiction.
+            attr_reader :jurisdiction
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class HospitalityTax < ::Stripe::StripeObject
+            # A [jurisdiction code](https://docs.stripe.com/tax/registering?type=hospitality_tax#registration-types) representing the local jurisdiction.
+            attr_reader :jurisdiction
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           class LocalAmusementTax < ::Stripe::StripeObject
             # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.
             attr_reader :jurisdiction
@@ -1772,6 +1850,32 @@ module Stripe
             end
           end
 
+          class LuxuryTax < ::Stripe::StripeObject
+            # A [jurisdiction code](https://docs.stripe.com/tax/registering?type=luxury_tax#registration-types) representing the local jurisdiction.
+            attr_reader :jurisdiction
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class ResortTax < ::Stripe::StripeObject
+            # A [jurisdiction code](https://docs.stripe.com/tax/registering?type=resort_tax#registration-types) representing the local jurisdiction.
+            attr_reader :jurisdiction
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           class StateSalesTax < ::Stripe::StripeObject
             class Election < ::Stripe::StripeObject
               # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.
@@ -1798,22 +1902,62 @@ module Stripe
               @field_remappings = {}
             end
           end
+
+          class TourismTax < ::Stripe::StripeObject
+            # A [jurisdiction code](https://docs.stripe.com/tax/registering?type=tourism_tax#registration-types) representing the local jurisdiction.
+            attr_reader :jurisdiction
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Attribute for field admissions_tax
+          attr_reader :admissions_tax
+          # Attribute for field attendance_tax
+          attr_reader :attendance_tax
+          # Attribute for field entertainment_tax
+          attr_reader :entertainment_tax
+          # Attribute for field gross_receipts_tax
+          attr_reader :gross_receipts_tax
+          # Attribute for field home_rule_tax
+          attr_reader :home_rule_tax
+          # Attribute for field hospitality_tax
+          attr_reader :hospitality_tax
           # Attribute for field local_amusement_tax
           attr_reader :local_amusement_tax
           # Attribute for field local_lease_tax
           attr_reader :local_lease_tax
+          # Attribute for field luxury_tax
+          attr_reader :luxury_tax
+          # Attribute for field resort_tax
+          attr_reader :resort_tax
           # Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
           attr_reader :state
           # Attribute for field state_sales_tax
           attr_reader :state_sales_tax
+          # Attribute for field tourism_tax
+          attr_reader :tourism_tax
           # Type of registration in the US.
           attr_reader :type
 
           def self.inner_class_types
             @inner_class_types = {
+              admissions_tax: AdmissionsTax,
+              attendance_tax: AttendanceTax,
+              entertainment_tax: EntertainmentTax,
+              gross_receipts_tax: GrossReceiptsTax,
+              home_rule_tax: HomeRuleTax,
+              hospitality_tax: HospitalityTax,
               local_amusement_tax: LocalAmusementTax,
               local_lease_tax: LocalLeaseTax,
+              luxury_tax: LuxuryTax,
+              resort_tax: ResortTax,
               state_sales_tax: StateSalesTax,
+              tourism_tax: TourismTax,
             }
           end
 

data/lib/stripe/resources/tax_code.rb

@@ -11,6 +11,18 @@ module Stripe
       "tax_code"
     end
 
+    class Requirements < ::Stripe::StripeObject
+      # Describes whether a performance location is required for a successful tax calculation with a tax code.
+      attr_reader :performance_location
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
     # A detailed description of which types of products the tax code represents.
     attr_reader :description
     # Unique identifier for the object.
@@ -19,6 +31,8 @@ module Stripe
     attr_reader :name
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object
+    # An object that describes more information about the tax location required for this tax code. Some [tax codes](/tax/tax-for-tickets/integration-guide#types-of-products) require a tax location of type `performance` to calculate tax correctly.
+    attr_reader :requirements
 
     # A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
     def self.list(params = {}, opts = {})
@@ -26,7 +40,7 @@ module Stripe
     end
 
     def self.inner_class_types
-      @inner_class_types = {}
+      @inner_class_types = { requirements: Requirements }
     end
 
     def self.field_remappings

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

@@ -68,6 +68,19 @@ module Stripe
         end
       end
 
+      class ReaderSecurity < ::Stripe::StripeObject
+        # Passcode used to access a reader's admin menu.
+        attr_reader :admin_menu_passcode
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class RebootWindow < ::Stripe::StripeObject
         # Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
         attr_reader :end_hour
@@ -701,6 +714,8 @@ module Stripe
       attr_reader :object
       # Attribute for field offline
       attr_reader :offline
+      # Attribute for field reader_security
+      attr_reader :reader_security
       # Attribute for field reboot_window
       attr_reader :reboot_window
       # Attribute for field stripe_s700
@@ -778,6 +793,7 @@ module Stripe
           bbpos_wisepos_e: BbposWiseposE,
           cellular: Cellular,
           offline: Offline,
+          reader_security: ReaderSecurity,
           reboot_window: RebootWindow,
           stripe_s700: StripeS700,
           stripe_s710: StripeS710,

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

@@ -315,6 +315,8 @@ module Stripe
               @field_remappings = {}
             end
           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.
@@ -348,6 +350,8 @@ module Stripe
               @field_remappings = {}
             end
           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.
@@ -426,6 +430,8 @@ module Stripe
               @field_remappings = {}
             end
           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
@@ -482,6 +488,8 @@ module Stripe
               @field_remappings = {}
             end
           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,47 @@
+# 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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # 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
+
+      def self.inner_class_types
+        @inner_class_types = { magstripe: Magstripe }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/transfer.rb

@@ -29,6 +29,10 @@ module Stripe
     attr_reader :amount
     # Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
     attr_reader :amount_reversed
+    # Attribute for field application_fee
+    attr_reader :application_fee
+    # Attribute for field application_fee_amount
+    attr_reader :application_fee_amount
     # Balance transaction that describes the impact of this transfer on your account balance.
     attr_reader :balance_transaction
     # Time that this record of the transfer was first created.
@@ -41,6 +45,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
     # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.