stripe 20.2.0.pre.beta.1 → 21.0.0

data/lib/stripe/resources/payment_plan.rb

@@ -1,213 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  # A Payment Plan splits a single invoice obligation into multiple installments,
-  # each with its own due date and amount. Payment Plans are associated with a
-  # finalized or draft invoice and track how much has been collected against
-  # each installment.
-  class PaymentPlan < APIResource
-    extend Stripe::APIOperations::Create
-    extend Stripe::APIOperations::List
-    include Stripe::APIOperations::Save
-
-    OBJECT_NAME = "payment_plan"
-    def self.object_name
-      "payment_plan"
-    end
-
-    class CollectsOn < ::Stripe::StripeObject
-      class InvoiceDetails < ::Stripe::StripeObject
-        # The ID of the invoice this plan collects against.
-        attr_reader :invoice
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # Attribute for field invoice_details
-      attr_reader :invoice_details
-      # The type of object this plan collects against. This is always `invoice_details`.
-      attr_reader :type
-
-      def self.inner_class_types
-        @inner_class_types = { invoice_details: InvoiceDetails }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-
-    class Installment < ::Stripe::StripeObject
-      # Amount owed for this installment, in the smallest currency unit.
-      attr_reader :amount_due
-      # Amount forgiven for this installment, in the smallest currency unit.
-      attr_reader :amount_forgiven
-      # Amount already paid toward this installment, in the smallest currency unit.
-      attr_reader :amount_paid
-      # Three-letter ISO currency code.
-      attr_reader :currency
-      # A description of this installment.
-      attr_reader :description
-      # Unix timestamp when this installment is due. Omitted for installments with no due date.
-      attr_reader :due_date
-      # Unique identifier for the installment.
-      attr_reader :id
-      # Unix timestamp when this installment was paid.
-      attr_reader :paid_at
-      # The status of this installment. One of `open`, `paid`, `past_due`, or `canceled`.
-      attr_reader :status
-
-      def self.inner_class_types
-        @inner_class_types = {}
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-
-    class Schedule < ::Stripe::StripeObject
-      class AmountsDue < ::Stripe::StripeObject
-        class Amount < ::Stripe::StripeObject
-          class DueDate < ::Stripe::StripeObject
-            class Relative < ::Stripe::StripeObject
-              # The number of intervals after the invoice is finalized that this entry is due.
-              attr_reader :count
-              # The interval unit: `day`, `week`, `month`, or `year`.
-              attr_reader :interval
-
-              def self.inner_class_types
-                @inner_class_types = {}
-              end
-
-              def self.field_remappings
-                @field_remappings = {}
-              end
-            end
-            # Unix timestamp of the due date. Present when type is `absolute`.
-            attr_reader :absolute
-            # Attribute for field relative
-            attr_reader :relative
-            # The type of due date. Either `absolute` or `relative`.
-            attr_reader :type
-
-            def self.inner_class_types
-              @inner_class_types = { relative: Relative }
-            end
-
-            def self.field_remappings
-              @field_remappings = {}
-            end
-          end
-
-          class FixedAmount < ::Stripe::StripeObject
-            # Fixed amount for this entry, in the smallest currency unit.
-            attr_reader :amount
-            # Three-letter ISO currency code.
-            attr_reader :currency
-
-            def self.inner_class_types
-              @inner_class_types = {}
-            end
-
-            def self.field_remappings
-              @field_remappings = {}
-            end
-          end
-          # A description of this schedule entry.
-          attr_reader :description
-          # Attribute for field due_date
-          attr_reader :due_date
-          # Attribute for field fixed_amount
-          attr_reader :fixed_amount
-          # Unique identifier for this schedule entry.
-          attr_reader :id
-          # Percentage of the invoice total for this entry (0–100). Present when type is `percentage`.
-          attr_reader :percentage
-          # The type of this schedule entry. Either `fixed_amount` or `percentage`.
-          attr_reader :type
-
-          def self.inner_class_types
-            @inner_class_types = { due_date: DueDate, fixed_amount: FixedAmount }
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        # The list of installment schedule entries.
-        attr_reader :amounts
-
-        def self.inner_class_types
-          @inner_class_types = { amounts: Amount }
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # Attribute for field amounts_due
-      attr_reader :amounts_due
-      # The type of schedule. This is always `amounts_due`.
-      attr_reader :type
-
-      def self.inner_class_types
-        @inner_class_types = { amounts_due: AmountsDue }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-    # The list of objects this payment plan collects against.
-    attr_reader :collects_on
-    # 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
-    # The list of installments derived from the schedule. Each installment tracks an individual payment obligation.
-    attr_reader :installments
-    # 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
-    # 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
-    # String representing the object's type. Objects of the same type share the same value.
-    attr_reader :object
-    # Attribute for field schedule
-    attr_reader :schedule
-
-    # Creates a payment plan that splits a single invoice obligation into installments with their own due dates and amounts.
-    def self.create(params = {}, opts = {})
-      request_stripe_object(method: :post, path: "/v1/payment_plans", params: params, opts: opts)
-    end
-
-    # Returns a list of payment plans.
-    def self.list(params = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/payment_plans", params: params, opts: opts)
-    end
-
-    # Updates the schedule or metadata of an existing payment plan. Only unpaid installments can be updated.
-    def self.update(id, params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: format("/v1/payment_plans/%<id>s", { id: CGI.escape(id) }),
-        params: params,
-        opts: opts
-      )
-    end
-
-    def self.inner_class_types
-      @inner_class_types = { collects_on: CollectsOn, installments: Installment, schedule: Schedule }
-    end
-
-    def self.field_remappings
-      @field_remappings = {}
-    end
-  end
-end

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

@@ -1,189 +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
-
-        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

@@ -1,49 +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
-
-        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