stripe 18.1.0 → 18.2.0.pre.alpha.1

data/lib/stripe/resources/payment_record.rb

@@ -285,6 +285,8 @@ module Stripe
           class Card < ::Stripe::StripeObject
             # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
             attr_reader :brand
+            # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+            attr_reader :brand_product
             # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
             attr_reader :country
             # Two-digit number representing the card's expiration month.
@@ -900,6 +902,16 @@ module Stripe
         end
       end
 
+      class Gopay < ::Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class Grabpay < ::Stripe::StripeObject
         # Unique transaction id generated by GrabPay
         attr_reader :transaction_id
@@ -913,6 +925,27 @@ module Stripe
         end
       end
 
+      class IdBankTransfer < ::Stripe::StripeObject
+        # Account number of the bank account to transfer funds to.
+        attr_reader :account_number
+        # Bank where the account is located.
+        attr_reader :bank
+        # Local bank code of the bank.
+        attr_reader :bank_code
+        # Name of the bank associated with the bank account.
+        attr_reader :bank_name
+        # Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
+        attr_reader :display_name
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class Ideal < ::Stripe::StripeObject
         # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
         attr_reader :bank
@@ -1319,6 +1352,52 @@ module Stripe
             @field_remappings = {}
           end
         end
+
+        class Shipping < ::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
+
+        class VerifiedAddress < ::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
         # Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
         attr_reader :country
         # Owner's email. Values are provided by PayPal directly
@@ -1331,11 +1410,39 @@ module Stripe
         attr_reader :payer_name
         # The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
         attr_reader :seller_protection
+        # The shipping address for the customer, as supplied by the merchant at the point of payment
+        # execution. This shipping address will not be updated if the merchant updates the shipping
+        # address on the PaymentIntent after the PaymentIntent was successfully confirmed.
+        attr_reader :shipping
         # A unique ID generated by PayPal for this transaction.
         attr_reader :transaction_id
+        # The shipping address for the customer, as supplied by the merchant at the point of payment
+        # execution. This shipping address will not be updated if the merchant updates the shipping
+        # address on the PaymentIntent after the PaymentIntent was successfully confirmed.
+        attr_reader :verified_address
+        # Owner's verified email. Values are verified or provided by PayPal directly
+        # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+        attr_reader :verified_email
+        # Owner's verified full name. Values are verified or provided by PayPal directly
+        # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+        attr_reader :verified_name
 
         def self.inner_class_types
-          @inner_class_types = { seller_protection: SellerProtection }
+          @inner_class_types = {
+            seller_protection: SellerProtection,
+            shipping: Shipping,
+            verified_address: VerifiedAddress,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Paypay < ::Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
         end
 
         def self.field_remappings
@@ -1365,6 +1472,8 @@ module Stripe
       class Pix < ::Stripe::StripeObject
         # Unique transaction id generated by BCB
         attr_reader :bank_transaction_id
+        # ID of the multi use Mandate generated by the PaymentIntent
+        attr_reader :mandate
 
         def self.inner_class_types
           @inner_class_types = {}
@@ -1388,11 +1497,36 @@ module Stripe
         end
       end
 
+      class Qris < ::Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Rechnung < ::Stripe::StripeObject
+        # Payment portal URL.
+        attr_reader :payment_portal_url
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class RevolutPay < ::Stripe::StripeObject
         class Funding < ::Stripe::StripeObject
           class Card < ::Stripe::StripeObject
             # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
             attr_reader :brand
+            # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+            attr_reader :brand_product
             # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
             attr_reader :country
             # Two-digit number representing the card's expiration month.
@@ -1509,6 +1643,16 @@ module Stripe
         end
       end
 
+      class Shopeepay < ::Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class Sofort < ::Stripe::StripeObject
         # Bank code of bank associated with the bank account.
         attr_reader :bank_code
@@ -1550,6 +1694,21 @@ module Stripe
         end
       end
 
+      class StripeBalance < ::Stripe::StripeObject
+        # The connected account ID whose Stripe balance to use as the source of payment
+        attr_reader :account
+        # The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
+        attr_reader :source_type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class Swish < ::Stripe::StripeObject
         # Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer
         attr_reader :fingerprint
@@ -1694,8 +1853,12 @@ module Stripe
       attr_reader :fpx
       # Attribute for field giropay
       attr_reader :giropay
+      # Attribute for field gopay
+      attr_reader :gopay
       # Attribute for field grabpay
       attr_reader :grabpay
+      # Attribute for field id_bank_transfer
+      attr_reader :id_bank_transfer
       # Attribute for field ideal
       attr_reader :ideal
       # Attribute for field interac_present
@@ -1734,12 +1897,18 @@ module Stripe
       attr_reader :paynow
       # Attribute for field paypal
       attr_reader :paypal
+      # Attribute for field paypay
+      attr_reader :paypay
       # Attribute for field payto
       attr_reader :payto
       # Attribute for field pix
       attr_reader :pix
       # Attribute for field promptpay
       attr_reader :promptpay
+      # Attribute for field qris
+      attr_reader :qris
+      # Attribute for field rechnung
+      attr_reader :rechnung
       # Attribute for field revolut_pay
       attr_reader :revolut_pay
       # Attribute for field samsung_pay
@@ -1750,10 +1919,14 @@ module Stripe
       attr_reader :sepa_credit_transfer
       # Attribute for field sepa_debit
       attr_reader :sepa_debit
+      # Attribute for field shopeepay
+      attr_reader :shopeepay
       # Attribute for field sofort
       attr_reader :sofort
       # Attribute for field stripe_account
       attr_reader :stripe_account
+      # Attribute for field stripe_balance
+      attr_reader :stripe_balance
       # Attribute for field swish
       attr_reader :swish
       # Attribute for field twint
@@ -1797,7 +1970,9 @@ module Stripe
           eps: Eps,
           fpx: Fpx,
           giropay: Giropay,
+          gopay: Gopay,
           grabpay: Grabpay,
+          id_bank_transfer: IdBankTransfer,
           ideal: Ideal,
           interac_present: InteracPresent,
           kakao_pay: KakaoPay,
@@ -1816,16 +1991,21 @@ module Stripe
           payco: Payco,
           paynow: Paynow,
           paypal: Paypal,
+          paypay: Paypay,
           payto: Payto,
           pix: Pix,
           promptpay: Promptpay,
+          qris: Qris,
+          rechnung: Rechnung,
           revolut_pay: RevolutPay,
           samsung_pay: SamsungPay,
           satispay: Satispay,
           sepa_credit_transfer: SepaCreditTransfer,
           sepa_debit: SepaDebit,
+          shopeepay: Shopeepay,
           sofort: Sofort,
           stripe_account: StripeAccount,
+          stripe_balance: StripeBalance,
           swish: Swish,
           twint: Twint,
           us_bank_account: UsBankAccount,

data/lib/stripe/resources/person.rb

@@ -292,6 +292,36 @@ module Stripe
       end
     end
 
+    class SelfReportedIncome < ::Stripe::StripeObject
+      # The amount in the minor currency unit (for example, cents for USD).
+      attr_reader :amount
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class SelfReportedMonthlyHousingPayment < ::Stripe::StripeObject
+      # The amount in the minor currency unit (for example, cents for USD).
+      attr_reader :amount
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class UsCfpbData < ::Stripe::StripeObject
       class EthnicityDetails < ::Stripe::StripeObject
         # The persons ethnicity
@@ -453,6 +483,10 @@ module Stripe
     attr_reader :relationship
     # Information about the requirements for this person, including what information needs to be collected, and by when.
     attr_reader :requirements
+    # Attribute for field self_reported_income
+    attr_reader :self_reported_income
+    # Attribute for field self_reported_monthly_housing_payment
+    attr_reader :self_reported_monthly_housing_payment
     # Whether the last four digits of the person's Social Security number have been provided (U.S. only).
     attr_reader :ssn_last_4_provided
     # Demographic data related to the person.
@@ -494,6 +528,8 @@ module Stripe
         registered_address: RegisteredAddress,
         relationship: Relationship,
         requirements: Requirements,
+        self_reported_income: SelfReportedIncome,
+        self_reported_monthly_housing_payment: SelfReportedMonthlyHousingPayment,
         us_cfpb_data: UsCfpbData,
         verification: Verification,
       }

data/lib/stripe/resources/price.rb

@@ -94,6 +94,23 @@ module Stripe
       end
     end
 
+    class MigrateTo < ::Stripe::StripeObject
+      # The behavior controlling at what point in the subscription lifecycle to migrate the price
+      attr_reader :behavior
+      # The unix timestamp after at which subscriptions will start to migrate to the new price.
+      attr_reader :effective_after
+      # The id of the price being migrated to
+      attr_reader :price
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class Recurring < ::Stripe::StripeObject
       # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
       attr_reader :interval
@@ -170,6 +187,8 @@ module Stripe
     attr_reader :lookup_key
     # Set of [key-value pairs](https://docs.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.
     attr_reader :metadata
+    # Subscriptions using this price will be migrated to use the new referenced price.
+    attr_reader :migrate_to
     # A brief description of the price, hidden from customers.
     attr_reader :nickname
     # String representing the object's type. Objects of the same type share the same value.
@@ -227,6 +246,7 @@ module Stripe
       @inner_class_types = {
         currency_options: CurrencyOptions,
         custom_unit_amount: CustomUnitAmount,
+        migrate_to: MigrateTo,
         recurring: Recurring,
         tiers: Tier,
         transform_quantity: TransformQuantity,

data/lib/stripe/resources/privacy/redaction_job.rb

@@ -0,0 +1,187 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    # The Redaction Job object redacts Stripe objects. You can use it
+    # to coordinate the removal of personal information from selected
+    # objects, making them permanently inaccessible in the Stripe Dashboard
+    # and API.
+    class RedactionJob < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "privacy.redaction_job"
+      def self.object_name
+        "privacy.redaction_job"
+      end
+
+      nested_resource_class_methods :validation_error, operations: %i[list]
+
+      class Objects < ::Stripe::StripeObject
+        # Charge object identifiers usually starting with `ch_`
+        attr_reader :charges
+        # CheckoutSession object identifiers starting with `cs_`
+        attr_reader :checkout_sessions
+        # Customer object identifiers starting with `cus_`
+        attr_reader :customers
+        # Identity VerificationSessions object identifiers starting with `vs_`
+        attr_reader :identity_verification_sessions
+        # Invoice object identifiers starting with `in_`
+        attr_reader :invoices
+        # Issuing Cardholder object identifiers starting with `ich_`
+        attr_reader :issuing_cardholders
+        # PaymentIntent object identifiers starting with `pi_`
+        attr_reader :payment_intents
+        # Fraud ValueListItem object identifiers starting with `rsli_`
+        attr_reader :radar_value_list_items
+        # SetupIntent object identifiers starting with `seti_`
+        attr_reader :setup_intents
+
+        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
+      # 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.
+      attr_reader :object
+      # The objects to redact in this job.
+      attr_reader :objects
+      # The status of the job.
+      attr_reader :status
+      # Validation behavior determines how a job validates objects for redaction eligibility. Default is `error`.
+      attr_reader :validation_behavior
+
+      # You can cancel a redaction job when it's in one of these statuses: ready, failed.
+      #
+      # Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/cancel", { job: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # You can cancel a redaction job when it's in one of these statuses: ready, failed.
+      #
+      # Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
+      def self.cancel(job, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/cancel", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a redaction job. When a job is created, it will start to validate.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/privacy/redaction_jobs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of redaction jobs.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/privacy/redaction_jobs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Run a redaction job in a ready status.
+      #
+      # When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
+      #
+      # The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
+      def run(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/run", { job: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Run a redaction job in a ready status.
+      #
+      # When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
+      #
+      # The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
+      def self.run(job, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/run", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates the properties of a redaction job without running or canceling the job.
+      #
+      # If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
+      def self.update(job, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Validate a redaction job when it is in a failed status.
+      #
+      # When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
+      #
+      # The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
+      def validate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/validate", { job: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Validate a redaction job when it is in a failed status.
+      #
+      # When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
+      #
+      # The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
+      def self.validate(job, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/validate", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { objects: Objects }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/privacy/redaction_job_validation_error.rb

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    # The Redaction Job validation error object contains information about
+    # errors that affect the ability to redact a specific object in a
+    # redaction job.
+    class RedactionJobValidationError < APIResource
+      OBJECT_NAME = "privacy.redaction_job_validation_error"
+      def self.object_name
+        "privacy.redaction_job_validation_error"
+      end
+
+      class ErroringObject < ::Stripe::StripeObject
+        # Unique identifier for the object.
+        attr_reader :id
+        # Erroring object type
+        attr_reader :object_type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # A code indicating the reason for the error.
+      attr_reader :code
+      # If the error is related to a specific object, this field includes the object's identifier and object type.
+      attr_reader :erroring_object
+      # Unique identifier for the object.
+      attr_reader :id
+      # A human-readable message providing more details about the error.
+      attr_reader :message
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
+      def self.inner_class_types
+        @inner_class_types = { erroring_object: ErroringObject }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end