stripe 15.1.0 → 15.2.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,275 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    # Redaction Jobs store the status of a redaction request. They are created
+    # when a redaction request is made and track the redaction validation and execution.
+    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
+        # Attribute for field charges
+        attr_reader :charges
+        # Attribute for field checkout_sessions
+        attr_reader :checkout_sessions
+        # Attribute for field customers
+        attr_reader :customers
+        # Attribute for field identity_verification_sessions
+        attr_reader :identity_verification_sessions
+        # Attribute for field invoices
+        attr_reader :invoices
+        # Attribute for field issuing_cardholders
+        attr_reader :issuing_cardholders
+        # Attribute for field payment_intents
+        attr_reader :payment_intents
+        # Attribute for field radar_value_list_items
+        attr_reader :radar_value_list_items
+        # Attribute for field setup_intents
+        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 at the root level that are subject to redaction.
+        attr_accessor :objects
+        # Default is "error". If "error", we will make sure all objects in the graph are
+        # redactable in the 1st traversal, otherwise error. If "fix", where possible, we will
+        # auto-fix any validation errors (e.g. by auto-transitioning objects to a terminal
+        # state, etc.) in the 2nd traversal before redacting
+        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
+        # Attribute for param field validation_behavior
+        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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The objects at the root level that are subject to redaction.
+      attr_reader :objects
+      # The status field represents the current state of the redaction job. It can take on any of the following values: VALIDATING, READY, REDACTING, SUCCEEDED, CANCELED, FAILED.
+      attr_reader :status
+      # Default is "error". If "error", we will make sure all objects in the graph are redactable in the 1st traversal, otherwise error. If "fix", where possible, we will auto-fix any validation errors (e.g. by auto-transitioning objects to a terminal state, etc.) in the 2nd traversal before redacting
+      attr_reader :validation_behavior
+
+      # Cancel redaction job method
+      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
+
+      # Cancel redaction job method
+      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
+
+      # Create redaction job method
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/privacy/redaction_jobs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # List redaction jobs method...
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/privacy/redaction_jobs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Run redaction job method
+      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 redaction job method
+      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
+
+      # Update redaction job method
+      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 redaction job method
+      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 redaction job method
+      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,25 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    # Validation errors
+    class RedactionJobValidationError < APIResource
+      OBJECT_NAME = "privacy.redaction_job_validation_error"
+      def self.object_name
+        "privacy.redaction_job_validation_error"
+      end
+
+      # Attribute for field code
+      attr_reader :code
+      # Attribute for field erroring_object
+      attr_reader :erroring_object
+      # Unique identifier for the object.
+      attr_reader :id
+      # Attribute for field message
+      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/product.rb

@@ -41,6 +41,25 @@ module Stripe
       attr_reader :width
     end
 
+    class Provisioning < Stripe::StripeObject
+      class GiftCard < Stripe::StripeObject
+        class FixedAmount < Stripe::StripeObject
+          # The initial amount with which the provisioned gift card will be created.
+          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
+        end
+        # Attribute for field fixed_amount
+        attr_reader :fixed_amount
+        # The specific type of gift_card provisioning, only `fixed_amount` currently supported.
+        attr_reader :type
+      end
+      # Attribute for field gift_card
+      attr_reader :gift_card
+      # The type of provisioning, only `gift_card` currently supported.
+      attr_reader :type
+    end
+
     class DeleteParams < Stripe::RequestParams
     end
 
@@ -366,6 +385,40 @@ module Stripe
           @width = width
         end
       end
+
+      class Provisioning < Stripe::RequestParams
+        class GiftCard < Stripe::RequestParams
+          class FixedAmount < Stripe::RequestParams
+            # The initial amount with which the provisioned gift card will be created.
+            attr_accessor :amount
+            # Attribute for param field currency
+            attr_accessor :currency
+
+            def initialize(amount: nil, currency: nil)
+              @amount = amount
+              @currency = currency
+            end
+          end
+          # Attribute for param field fixed_amount
+          attr_accessor :fixed_amount
+          # The specific type of gift_card provisioning, only `fixed_amount` currently supported.
+          attr_accessor :type
+
+          def initialize(fixed_amount: nil, type: nil)
+            @fixed_amount = fixed_amount
+            @type = type
+          end
+        end
+        # Attribute for param field gift_card
+        attr_accessor :gift_card
+        # The type of provisioning, only `gift_card` currently supported.
+        attr_accessor :type
+
+        def initialize(gift_card: nil, type: nil)
+          @gift_card = gift_card
+          @type = type
+        end
+      end
       # Whether the product is currently available for purchase. Defaults to `true`.
       attr_accessor :active
       # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.
@@ -386,6 +439,8 @@ module Stripe
       attr_accessor :name
       # The dimensions of this product for shipping purposes.
       attr_accessor :package_dimensions
+      # Provisioning configuration for this product.
+      attr_accessor :provisioning
       # Whether this product is shipped (i.e., physical goods).
       attr_accessor :shippable
       # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
@@ -413,6 +468,7 @@ module Stripe
         metadata: nil,
         name: nil,
         package_dimensions: nil,
+        provisioning: nil,
         shippable: nil,
         statement_descriptor: nil,
         tax_code: nil,
@@ -430,6 +486,7 @@ module Stripe
         @metadata = metadata
         @name = name
         @package_dimensions = package_dimensions
+        @provisioning = provisioning
         @shippable = shippable
         @statement_descriptor = statement_descriptor
         @tax_code = tax_code
@@ -480,6 +537,8 @@ module Stripe
     attr_reader :object
     # The dimensions of this product for shipping purposes.
     attr_reader :package_dimensions
+    # Provisioning configuration for this product.
+    attr_reader :provisioning
     # Whether this product is shipped (i.e., physical goods).
     attr_reader :shippable
     # Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.

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.