stripe 15.4.0 → 15.5.0.pre.beta.1

data/lib/stripe/resources/payout.rb

@@ -116,6 +116,8 @@ module Stripe
       attr_accessor :metadata
       # The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
       attr_accessor :method
+      # The ID of a v2 FinancialAccount to send funds to.
+      attr_accessor :payout_method
       # The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
       attr_accessor :source_type
       # A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.
@@ -129,6 +131,7 @@ module Stripe
         expand: nil,
         metadata: nil,
         method: nil,
+        payout_method: nil,
         source_type: nil,
         statement_descriptor: nil
       )
@@ -139,6 +142,7 @@ module Stripe
         @expand = expand
         @metadata = metadata
         @method = method
+        @payout_method = payout_method
         @source_type = source_type
         @statement_descriptor = statement_descriptor
       end
@@ -214,6 +218,8 @@ module Stripe
     attr_reader :object
     # If the payout reverses another, this is the ID of the original payout.
     attr_reader :original_payout
+    # ID of the v2 FinancialAccount the funds are sent to.
+    attr_reader :payout_method
     # If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.
     attr_reader :reconciliation_status
     # If the payout reverses, this is the ID of the payout that reverses this payout.

data/lib/stripe/resources/price.rb

@@ -62,6 +62,15 @@ module Stripe
       attr_reader :preset
     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
+    end
+
     class Recurring < Stripe::StripeObject
       # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
       attr_reader :interval
@@ -523,6 +532,21 @@ module Stripe
           @unit_amount_decimal = unit_amount_decimal
         end
       end
+
+      class MigrateTo < Stripe::RequestParams
+        # The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
+        attr_accessor :behavior
+        # The time after which subscriptions should start using the new price.
+        attr_accessor :effective_after
+        # The ID of the price object.
+        attr_accessor :price
+
+        def initialize(behavior: nil, effective_after: nil, price: nil)
+          @behavior = behavior
+          @effective_after = effective_after
+          @price = price
+        end
+      end
       # Whether the price can be used for new purchases. Defaults to `true`.
       attr_accessor :active
       # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
@@ -533,6 +557,8 @@ module Stripe
       attr_accessor :lookup_key
       # 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
+      # If specified, subscriptions using this price will be updated to use the new referenced price.
+      attr_accessor :migrate_to
       # A brief description of the price, hidden from customers.
       attr_accessor :nickname
       # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
@@ -546,6 +572,7 @@ module Stripe
         expand: nil,
         lookup_key: nil,
         metadata: nil,
+        migrate_to: nil,
         nickname: nil,
         tax_behavior: nil,
         transfer_lookup_key: nil
@@ -555,6 +582,7 @@ module Stripe
         @expand = expand
         @lookup_key = lookup_key
         @metadata = metadata
+        @migrate_to = migrate_to
         @nickname = nickname
         @tax_behavior = tax_behavior
         @transfer_lookup_key = transfer_lookup_key
@@ -598,6 +626,8 @@ module Stripe
     attr_reader :lookup_key
     # 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.
     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.

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

@@ -0,0 +1,298 @@
+# 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
+      end
+
+      class ListParams < Stripe::RequestParams
+        # 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
+        # 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
+        # Attribute for param field status
+        attr_accessor :status
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+          @status = status
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class Objects < Stripe::RequestParams
+          # Attribute for param field charges
+          attr_accessor :charges
+          # Attribute for param field checkout_sessions
+          attr_accessor :checkout_sessions
+          # Attribute for param field customers
+          attr_accessor :customers
+          # Attribute for param field identity_verification_sessions
+          attr_accessor :identity_verification_sessions
+          # Attribute for param field invoices
+          attr_accessor :invoices
+          # Attribute for param field issuing_cardholders
+          attr_accessor :issuing_cardholders
+          # Attribute for param field issuing_cards
+          attr_accessor :issuing_cards
+          # Attribute for param field payment_intents
+          attr_accessor :payment_intents
+          # Attribute for param field radar_value_list_items
+          attr_accessor :radar_value_list_items
+          # Attribute for param field setup_intents
+          attr_accessor :setup_intents
+
+          def initialize(
+            charges: nil,
+            checkout_sessions: nil,
+            customers: nil,
+            identity_verification_sessions: nil,
+            invoices: nil,
+            issuing_cardholders: nil,
+            issuing_cards: nil,
+            payment_intents: nil,
+            radar_value_list_items: nil,
+            setup_intents: nil
+          )
+            @charges = charges
+            @checkout_sessions = checkout_sessions
+            @customers = customers
+            @identity_verification_sessions = identity_verification_sessions
+            @invoices = invoices
+            @issuing_cardholders = issuing_cardholders
+            @issuing_cards = issuing_cards
+            @payment_intents = payment_intents
+            @radar_value_list_items = radar_value_list_items
+            @setup_intents = setup_intents
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The objects to redact. These root objects and their related ones will be validated for redaction.
+        attr_accessor :objects
+        # Determines the validation behavior of the job. Default is `error`.
+        attr_accessor :validation_behavior
+
+        def initialize(expand: nil, objects: nil, validation_behavior: nil)
+          @expand = expand
+          @objects = objects
+          @validation_behavior = validation_behavior
+        end
+      end
+
+      class UpdateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Determines the validation behavior of the job. Default is `error`.
+        attr_accessor :validation_behavior
+
+        def initialize(expand: nil, validation_behavior: nil)
+          @expand = expand
+          @validation_behavior = validation_behavior
+        end
+      end
+
+      class CancelParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class RunParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class ValidateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        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
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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
+      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
+    end
+  end
+end

data/lib/stripe/resources/promotion_code.rb

@@ -57,6 +57,8 @@ module Stripe
       attr_accessor :created
       # Only return promotion codes that are restricted to this customer.
       attr_accessor :customer
+      # Only return promotion codes that are restricted to this account.
+      attr_accessor :customer_account
       # 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.
@@ -72,6 +74,7 @@ module Stripe
         coupon: nil,
         created: nil,
         customer: nil,
+        customer_account: nil,
         ending_before: nil,
         expand: nil,
         limit: nil,
@@ -82,6 +85,7 @@ module Stripe
         @coupon = coupon
         @created = created
         @customer = customer
+        @customer_account = customer_account
         @ending_before = ending_before
         @expand = expand
         @limit = limit
@@ -130,6 +134,8 @@ module Stripe
       attr_accessor :coupon
       # The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
       attr_accessor :customer
+      # The account that this promotion code can be used by. If not set, the promotion code can be used by all accounts.
+      attr_accessor :customer_account
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
       # The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.
@@ -146,6 +152,7 @@ module Stripe
         code: nil,
         coupon: nil,
         customer: nil,
+        customer_account: nil,
         expand: nil,
         expires_at: nil,
         max_redemptions: nil,
@@ -156,6 +163,7 @@ module Stripe
         @code = code
         @coupon = coupon
         @customer = customer
+        @customer_account = customer_account
         @expand = expand
         @expires_at = expires_at
         @max_redemptions = max_redemptions
@@ -209,6 +217,8 @@ module Stripe
     attr_reader :created
     # The customer that this promotion code can be used by.
     attr_reader :customer
+    # The account that this promotion code can be used by.
+    attr_reader :customer_account
     # Date at which the promotion code can no longer be redeemed.
     attr_reader :expires_at
     # Unique identifier for the object.