stripe 15.3.0.pre.beta.1 → 15.3.0

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

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

@@ -1,33 +0,0 @@
-# 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/quote_line.rb

@@ -1,274 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  # A quote line defines a set of changes, in the order provided, that will be applied upon quote acceptance.
-  class QuoteLine < APIResource
-    OBJECT_NAME = "quote_line"
-    def self.object_name
-      "quote_line"
-    end
-
-    class Action < Stripe::StripeObject
-      class AddDiscount < Stripe::StripeObject
-        class DiscountEnd < Stripe::StripeObject
-          # The discount end type.
-          attr_reader :type
-        end
-        # ID of the coupon to create a new discount for.
-        attr_reader :coupon
-        # ID of an existing discount on the object (or one of its ancestors) to reuse.
-        attr_reader :discount
-        # Details to determine how long the discount should be applied for.
-        attr_reader :discount_end
-        # The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
-        attr_reader :index
-        # ID of the promotion code to create a new discount for.
-        attr_reader :promotion_code
-      end
-
-      class AddItem < Stripe::StripeObject
-        class Discount < Stripe::StripeObject
-          class DiscountEnd < Stripe::StripeObject
-            # The discount end timestamp.
-            attr_reader :timestamp
-            # The discount end type.
-            attr_reader :type
-          end
-          # ID of the coupon to create a new discount for.
-          attr_reader :coupon
-          # ID of an existing discount on the object (or one of its ancestors) to reuse.
-          attr_reader :discount
-          # Details to determine how long the discount should be applied for.
-          attr_reader :discount_end
-          # ID of the promotion code to create a new discount for.
-          attr_reader :promotion_code
-        end
-
-        class Trial < Stripe::StripeObject
-          # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
-          attr_reader :converts_to
-          # Determines the type of trial for this item.
-          attr_reader :type
-        end
-        # The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
-        attr_reader :discounts
-        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
-        attr_reader :metadata
-        # ID of the price to which the customer should be subscribed.
-        attr_reader :price
-        # Quantity of the plan to which the customer should be subscribed.
-        attr_reader :quantity
-        # The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
-        attr_reader :tax_rates
-        # Options that configure the trial on the subscription item.
-        attr_reader :trial
-      end
-
-      class RemoveDiscount < Stripe::StripeObject
-        class DiscountEnd < Stripe::StripeObject
-          # The discount end timestamp.
-          attr_reader :timestamp
-          # The discount end type.
-          attr_reader :type
-        end
-        # ID of the coupon to create a new discount for.
-        attr_reader :coupon
-        # ID of an existing discount on the object (or one of its ancestors) to reuse.
-        attr_reader :discount
-        # Details to determine how long the discount should be applied for.
-        attr_reader :discount_end
-        # ID of the promotion code to create a new discount for.
-        attr_reader :promotion_code
-      end
-
-      class RemoveItem < Stripe::StripeObject
-        # ID of a price to remove.
-        attr_reader :price
-      end
-
-      class SetDiscount < Stripe::StripeObject
-        class DiscountEnd < Stripe::StripeObject
-          # The discount end timestamp.
-          attr_reader :timestamp
-          # The discount end type.
-          attr_reader :type
-        end
-        # ID of the coupon to create a new discount for.
-        attr_reader :coupon
-        # ID of an existing discount on the object (or one of its ancestors) to reuse.
-        attr_reader :discount
-        # Details to determine how long the discount should be applied for.
-        attr_reader :discount_end
-        # ID of the promotion code to create a new discount for.
-        attr_reader :promotion_code
-      end
-
-      class SetItem < Stripe::StripeObject
-        class Discount < Stripe::StripeObject
-          class DiscountEnd < Stripe::StripeObject
-            # The discount end timestamp.
-            attr_reader :timestamp
-            # The discount end type.
-            attr_reader :type
-          end
-          # ID of the coupon to create a new discount for.
-          attr_reader :coupon
-          # ID of an existing discount on the object (or one of its ancestors) to reuse.
-          attr_reader :discount
-          # Details to determine how long the discount should be applied for.
-          attr_reader :discount_end
-          # ID of the promotion code to create a new discount for.
-          attr_reader :promotion_code
-        end
-
-        class Trial < Stripe::StripeObject
-          # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
-          attr_reader :converts_to
-          # Determines the type of trial for this item.
-          attr_reader :type
-        end
-        # The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
-        attr_reader :discounts
-        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
-        attr_reader :metadata
-        # ID of the price to which the customer should be subscribed.
-        attr_reader :price
-        # Quantity of the plan to which the customer should be subscribed.
-        attr_reader :quantity
-        # The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
-        attr_reader :tax_rates
-        # Options that configure the trial on the subscription item.
-        attr_reader :trial
-      end
-      # Details for the `add_discount` type.
-      attr_reader :add_discount
-      # Details for the `add_item` type.
-      attr_reader :add_item
-      # Details for the `add_metadata` type: specify a hash of key-value pairs.
-      attr_reader :add_metadata
-      # Details for the `remove_discount` type.
-      attr_reader :remove_discount
-      # Details for the `remove_item` type.
-      attr_reader :remove_item
-      # Details for the `remove_metadata` type: specify an array of metadata keys.
-      attr_reader :remove_metadata
-      # Details for the `set_discounts` type.
-      attr_reader :set_discounts
-      # Details for the `set_items` type.
-      attr_reader :set_items
-      # Details for the `set_metadata` type: specify an array of key-value pairs.
-      attr_reader :set_metadata
-      # The type of action the quote line performs.
-      attr_reader :type
-    end
-
-    class AppliesTo < Stripe::StripeObject
-      # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
-      attr_reader :new_reference
-      # The ID of the schedule the line applies to.
-      attr_reader :subscription_schedule
-      # Describes whether the quote line is affecting a new schedule or an existing schedule.
-      attr_reader :type
-    end
-
-    class CancelSubscriptionSchedule < Stripe::StripeObject
-      # Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
-      attr_reader :cancel_at
-      # If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
-      attr_reader :invoice_now
-      # If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
-      attr_reader :prorate
-    end
-
-    class EndsAt < Stripe::StripeObject
-      class DiscountEnd < Stripe::StripeObject
-        # The ID of a specific discount.
-        attr_reader :discount
-      end
-
-      class Duration < Stripe::StripeObject
-        # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-        attr_reader :interval
-        # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-        attr_reader :interval_count
-      end
-      # The timestamp value that will be used to determine when to make changes to the subscription schedule, as computed from the `ends_at` field. For example, if `ends_at[type]=upcoming_invoice`, the upcoming invoice date will be computed at the time the `ends_at` field was specified and saved. This field will not be recomputed upon future requests to update or finalize the quote unless `ends_at` is respecified. This field is guaranteed to be populated after quote acceptance.
-      attr_reader :computed
-      # Use the `end` time of a given discount.
-      attr_reader :discount_end
-      # Time span for the quote line starting from the `starts_at` date.
-      attr_reader :duration
-      # A precise Unix timestamp.
-      attr_reader :timestamp
-      # Select a way to pass in `ends_at`.
-      attr_reader :type
-    end
-
-    class SetPauseCollection < Stripe::StripeObject
-      class Set < Stripe::StripeObject
-        # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
-        attr_reader :behavior
-      end
-      # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
-      attr_reader :set
-      # Defines the type of the pause_collection behavior for the quote line.
-      attr_reader :type
-    end
-
-    class StartsAt < Stripe::StripeObject
-      class DiscountEnd < Stripe::StripeObject
-        # The ID of a specific discount.
-        attr_reader :discount
-      end
-
-      class LineEndsAt < Stripe::StripeObject
-        # Unique identifier for the object.
-        attr_reader :id
-      end
-      # The timestamp value that will be used to determine when to make changes to the subscription schedule, as computed from the `starts_at` field. For example, if `starts_at[type]=upcoming_invoice`, the upcoming invoice date will be computed at the time the `starts_at` field was specified and saved. This field will not be recomputed upon future requests to update or finalize the quote unless `starts_at` is respecified. This field is guaranteed to be populated after quote acceptance.
-      attr_reader :computed
-      # Use the `end` time of a given discount.
-      attr_reader :discount_end
-      # The timestamp the given line ends at.
-      attr_reader :line_ends_at
-      # A precise Unix timestamp.
-      attr_reader :timestamp
-      # Select a way to pass in `starts_at`.
-      attr_reader :type
-    end
-
-    class TrialSettings < Stripe::StripeObject
-      class EndBehavior < Stripe::StripeObject
-        # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
-        attr_reader :prorate_up_front
-      end
-      # Defines how the subscription should behave when a trial ends.
-      attr_reader :end_behavior
-    end
-    # A list of items the customer is being quoted for.
-    attr_reader :actions
-    # Details to identify the subscription schedule the quote line applies to.
-    attr_reader :applies_to
-    # For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
-    attr_reader :billing_cycle_anchor
-    # A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
-    attr_reader :cancel_subscription_schedule
-    # Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
-    attr_reader :ends_at
-    # 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
-    # Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
-    attr_reader :proration_behavior
-    # Details to modify the pause_collection behavior of the subscription schedule.
-    attr_reader :set_pause_collection
-    # Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
-    attr_reader :set_schedule_end
-    # Details to identify the earliest timestamp where the proposed change should take effect.
-    attr_reader :starts_at
-    # Settings related to subscription trials.
-    attr_reader :trial_settings
-  end
-end