stripe 17.0.0 → 17.1.0.pre.alpha.1

data/lib/stripe/resources/payout.rb

@@ -20,7 +20,7 @@ module Stripe
       "payout"
     end
 
-    class TraceId < Stripe::StripeObject
+    class TraceId < ::Stripe::StripeObject
       # Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`.
       attr_reader :status
       # The trace ID value if `trace_id.status` is `supported`, otherwise `nil`.

data/lib/stripe/resources/person.rb

@@ -15,8 +15,8 @@ module Stripe
       "person"
     end
 
-    class AdditionalTosAcceptances < Stripe::StripeObject
-      class Account < Stripe::StripeObject
+    class AdditionalTosAcceptances < ::Stripe::StripeObject
+      class Account < ::Stripe::StripeObject
         # The Unix timestamp marking when the legal guardian accepted the service agreement.
         attr_reader :date
         # The IP address from which the legal guardian accepted the service agreement.
@@ -44,7 +44,7 @@ module Stripe
       end
     end
 
-    class Address < Stripe::StripeObject
+    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)).
@@ -67,7 +67,7 @@ module Stripe
       end
     end
 
-    class AddressKana < Stripe::StripeObject
+    class AddressKana < ::Stripe::StripeObject
       # City/Ward.
       attr_reader :city
       # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -92,7 +92,7 @@ module Stripe
       end
     end
 
-    class AddressKanji < Stripe::StripeObject
+    class AddressKanji < ::Stripe::StripeObject
       # City/Ward.
       attr_reader :city
       # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -117,7 +117,7 @@ module Stripe
       end
     end
 
-    class Dob < Stripe::StripeObject
+    class Dob < ::Stripe::StripeObject
       # The day of birth, between 1 and 31.
       attr_reader :day
       # The month of birth, between 1 and 12.
@@ -134,8 +134,8 @@ module Stripe
       end
     end
 
-    class FutureRequirements < Stripe::StripeObject
-      class Alternative < Stripe::StripeObject
+    class FutureRequirements < ::Stripe::StripeObject
+      class Alternative < ::Stripe::StripeObject
         # Fields that can be provided to satisfy all fields in `original_fields_due`.
         attr_reader :alternative_fields_due
         # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
@@ -150,7 +150,7 @@ module Stripe
         end
       end
 
-      class Error < Stripe::StripeObject
+      class Error < ::Stripe::StripeObject
         # The code for the type of error.
         attr_reader :code
         # An informative message that indicates the error type and provides additional details about the error.
@@ -188,7 +188,7 @@ module Stripe
       end
     end
 
-    class RegisteredAddress < Stripe::StripeObject
+    class RegisteredAddress < ::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)).
@@ -211,7 +211,7 @@ module Stripe
       end
     end
 
-    class Relationship < Stripe::StripeObject
+    class Relationship < ::Stripe::StripeObject
       # Whether the person is the authorizer of the account's representative.
       attr_reader :authorizer
       # Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
@@ -238,8 +238,8 @@ module Stripe
       end
     end
 
-    class Requirements < Stripe::StripeObject
-      class Alternative < Stripe::StripeObject
+    class Requirements < ::Stripe::StripeObject
+      class Alternative < ::Stripe::StripeObject
         # Fields that can be provided to satisfy all fields in `original_fields_due`.
         attr_reader :alternative_fields_due
         # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
@@ -254,7 +254,7 @@ module Stripe
         end
       end
 
-      class Error < Stripe::StripeObject
+      class Error < ::Stripe::StripeObject
         # The code for the type of error.
         attr_reader :code
         # An informative message that indicates the error type and provides additional details about the error.
@@ -292,8 +292,8 @@ module Stripe
       end
     end
 
-    class UsCfpbData < Stripe::StripeObject
-      class EthnicityDetails < Stripe::StripeObject
+    class UsCfpbData < ::Stripe::StripeObject
+      class EthnicityDetails < ::Stripe::StripeObject
         # The persons ethnicity
         attr_reader :ethnicity
         # Please specify your origin, when other is selected.
@@ -308,7 +308,7 @@ module Stripe
         end
       end
 
-      class RaceDetails < Stripe::StripeObject
+      class RaceDetails < ::Stripe::StripeObject
         # The persons race.
         attr_reader :race
         # Please specify your race, when other is selected.
@@ -338,8 +338,8 @@ module Stripe
       end
     end
 
-    class Verification < Stripe::StripeObject
-      class AdditionalDocument < Stripe::StripeObject
+    class Verification < ::Stripe::StripeObject
+      class AdditionalDocument < ::Stripe::StripeObject
         # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
         attr_reader :back
         # A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
@@ -358,7 +358,7 @@ module Stripe
         end
       end
 
-      class Document < Stripe::StripeObject
+      class Document < ::Stripe::StripeObject
         # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
         attr_reader :back
         # A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".

data/lib/stripe/resources/plan.rb

@@ -21,7 +21,7 @@ module Stripe
       "plan"
     end
 
-    class Tier < Stripe::StripeObject
+    class Tier < ::Stripe::StripeObject
       # Price for the entire tier.
       attr_reader :flat_amount
       # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
@@ -42,7 +42,7 @@ module Stripe
       end
     end
 
-    class TransformUsage < Stripe::StripeObject
+    class TransformUsage < ::Stripe::StripeObject
       # Divide usage by this number.
       attr_reader :divide_by
       # After division, either round the result `up` or `down`.

data/lib/stripe/resources/price.rb

@@ -19,8 +19,8 @@ module Stripe
       "price"
     end
 
-    class CurrencyOptions < Stripe::StripeObject
-      class CustomUnitAmount < Stripe::StripeObject
+    class CurrencyOptions < ::Stripe::StripeObject
+      class CustomUnitAmount < ::Stripe::StripeObject
         # The maximum unit amount the customer can specify for this item.
         attr_reader :maximum
         # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
@@ -37,7 +37,7 @@ module Stripe
         end
       end
 
-      class Tier < Stripe::StripeObject
+      class Tier < ::Stripe::StripeObject
         # Price for the entire tier.
         attr_reader :flat_amount
         # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
@@ -77,7 +77,7 @@ module Stripe
       end
     end
 
-    class CustomUnitAmount < Stripe::StripeObject
+    class CustomUnitAmount < ::Stripe::StripeObject
       # The maximum unit amount the customer can specify for this item.
       attr_reader :maximum
       # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
@@ -94,7 +94,24 @@ module Stripe
       end
     end
 
-    class Recurring < Stripe::StripeObject
+    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
       # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
@@ -115,7 +132,7 @@ module Stripe
       end
     end
 
-    class Tier < Stripe::StripeObject
+    class Tier < ::Stripe::StripeObject
       # Price for the entire tier.
       attr_reader :flat_amount
       # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
@@ -136,7 +153,7 @@ module Stripe
       end
     end
 
-    class TransformQuantity < Stripe::StripeObject
+    class TransformQuantity < ::Stripe::StripeObject
       # Divide usage by this number.
       attr_reader :divide_by
       # After division, either round the result `up` or `down`.
@@ -170,6 +187,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.
@@ -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

data/lib/stripe/resources/product.rb

@@ -25,7 +25,7 @@ module Stripe
 
     nested_resource_class_methods :feature, operations: %i[create retrieve delete list]
 
-    class MarketingFeature < Stripe::StripeObject
+    class MarketingFeature < ::Stripe::StripeObject
       # The marketing feature name. Up to 80 characters long.
       attr_reader :name
 
@@ -38,7 +38,7 @@ module Stripe
       end
     end
 
-    class PackageDimensions < Stripe::StripeObject
+    class PackageDimensions < ::Stripe::StripeObject
       # Height, in inches.
       attr_reader :height
       # Length, in inches.

data/lib/stripe/resources/promotion_code.rb

@@ -17,7 +17,7 @@ module Stripe
       "promotion_code"
     end
 
-    class Promotion < Stripe::StripeObject
+    class Promotion < ::Stripe::StripeObject
       # If promotion `type` is `coupon`, the coupon for this promotion.
       attr_reader :coupon
       # The type of promotion.
@@ -32,8 +32,8 @@ module Stripe
       end
     end
 
-    class Restrictions < Stripe::StripeObject
-      class CurrencyOptions < Stripe::StripeObject
+    class Restrictions < ::Stripe::StripeObject
+      class CurrencyOptions < ::Stripe::StripeObject
         # Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
         attr_reader :minimum_amount
 
@@ -70,6 +70,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.