stripe 19.2.1 → 19.3.0.pre.alpha.1

data/lib/stripe/resources/price.rb

@@ -114,6 +114,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
@@ -191,6 +208,8 @@ module Stripe
     attr_reader :custom_unit_amount
     # Always true for a deleted object
     attr_reader :deleted
+    # A custom identifier for this price, such as a SKU number or product code, that can be used to reference records from external systems.
+    attr_reader :external_reference
     # Unique identifier for the object.
     attr_reader :id
     # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
@@ -199,6 +218,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.
@@ -254,6 +275,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,189 @@
+# 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
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # 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
+      # The first 10 validation errors for the current validation attempt. Use the validation errors list endpoint to paginate through the full list.
+      attr_reader :validation_errors
+
+      # 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,6 +25,31 @@ module Stripe
 
     nested_resource_class_methods :feature, operations: %i[create retrieve delete list]
 
+    class Identifiers < ::Stripe::StripeObject
+      # European Article Number (EAN) consisting of 8 or 13 digits and optional dashes. You may optionally provide a leading 0 for a total of 14 digits. The final digit is a validated check digit.
+      attr_reader :ean
+      # Global Trade Item Number (GTIN) consisting of 8, 12, 13, or 14 digits and optional dashes. The final digit is a validated check digit.
+      attr_reader :gtin
+      # International Standard Book Number (ISBN) consisting of 10 or 13 digits and optional dashes. The final digit is a validated check digit. For ISBN-10, the final digit may be a `X`.
+      attr_reader :isbn
+      # Japanese Article Number (JAN) consisting of 13 digits and optional dashes. The first two digits must either be `45` or `49`. The final digit is a validated check digit.
+      attr_reader :jan
+      # Manufacturer Part Number (MPN). May include up to 70 alphanumeric characters and dashes.
+      attr_reader :mpn
+      # National Stock Number (NSN) consisting of 13 digits and optional dashes. The seventh character may also be alphanumeric.
+      attr_reader :nsn
+      # Universal Product Code (UPC) consisting of 12 digits and optional dashes. The final digit is a validated check digit.
+      attr_reader :upc
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class MarketingFeature < ::Stripe::StripeObject
       # The marketing feature name. Up to 80 characters long.
       attr_reader :name
@@ -56,6 +81,21 @@ module Stripe
         @field_remappings = {}
       end
     end
+
+    class TaxDetails < ::Stripe::StripeObject
+      # The performance location.
+      attr_reader :performance_location
+      # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
+      attr_reader :tax_code
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
     # Whether the product is currently available for purchase.
     attr_reader :active
     # Time at which the object was created. Measured in seconds since the Unix epoch.
@@ -68,6 +108,8 @@ module Stripe
     attr_reader :description
     # Unique identifier for the object.
     attr_reader :id
+    # Attribute for field identifiers
+    attr_reader :identifiers
     # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
     attr_reader :images
     # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
@@ -88,6 +130,8 @@ module Stripe
     attr_reader :statement_descriptor
     # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
     attr_reader :tax_code
+    # Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
+    attr_reader :tax_details
     # The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.
     attr_reader :type
     # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
@@ -147,8 +191,10 @@ module Stripe
 
     def self.inner_class_types
       @inner_class_types = {
+        identifiers: Identifiers,
         marketing_features: MarketingFeature,
         package_dimensions: PackageDimensions,
+        tax_details: TaxDetails,
       }
     end
 

data/lib/stripe/resources/product_catalog/trial_offer.rb

@@ -0,0 +1,106 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module ProductCatalog
+    # Trial offers let you define free or paid introductory pricing for a subscription item.
+    # A TrialOffer specifies the price to charge during the trial, how long the trial lasts
+    # (a fixed end timestamp or a number of billing intervals), and what price the subscription
+    # item transitions to when the trial ends. You attach a TrialOffer to a subscription item
+    # using `items[current_trial][trial_offer]` when creating or updating a subscription.
+    class TrialOffer < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "product_catalog.trial_offer"
+      def self.object_name
+        "product_catalog.trial_offer"
+      end
+
+      class Duration < ::Stripe::StripeObject
+        class Relative < ::Stripe::StripeObject
+          # The number of iterations of the price's interval for this trial offer.
+          attr_reader :iterations
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field relative
+        attr_reader :relative
+        # The type of trial offer duration.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { relative: Relative }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class EndBehavior < ::Stripe::StripeObject
+        class Transition < ::Stripe::StripeObject
+          # The new price to use at the end of the trial offer period.
+          attr_reader :price
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field transition
+        attr_reader :transition
+        # The type of behavior when the trial offer ends.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { transition: Transition }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field duration
+      attr_reader :duration
+      # Attribute for field end_behavior
+      attr_reader :end_behavior
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # A brief, user-friendly name for the trial offer-for identification purposes.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The price during the trial offer.
+      attr_reader :price
+
+      # Creates a trial offer.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/product_catalog/trial_offers",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { duration: Duration, end_behavior: EndBehavior }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/profile.rb

@@ -0,0 +1,80 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A Stripe profile
+  class Profile < APIResource
+    OBJECT_NAME = "profile"
+    def self.object_name
+      "profile"
+    end
+
+    class Branding < ::Stripe::StripeObject
+      class Icon < ::Stripe::StripeObject
+        # Attribute for field original
+        attr_reader :original
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Logo < ::Stripe::StripeObject
+        # Attribute for field original
+        attr_reader :original
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field icon
+      attr_reader :icon
+      # Attribute for field logo
+      attr_reader :logo
+      # Attribute for field primary_color
+      attr_reader :primary_color
+      # Attribute for field secondary_color
+      attr_reader :secondary_color
+
+      def self.inner_class_types
+        @inner_class_types = { icon: Icon, logo: Logo }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Attribute for field branding
+    attr_reader :branding
+    # Attribute for field description
+    attr_reader :description
+    # Attribute for field display_name
+    attr_reader :display_name
+    # Attribute for field id
+    attr_reader :id
+    # Attribute for field livemode
+    attr_reader :livemode
+    # Attribute for field object
+    attr_reader :object
+    # Attribute for field url
+    attr_reader :url
+    # Attribute for field username
+    attr_reader :username
+
+    def self.inner_class_types
+      @inner_class_types = { branding: Branding }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end