stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/params/forwarding/request_list_params.rb

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Forwarding
+    class RequestListParams < ::Stripe::RequestParams
+      class Created < ::Stripe::RequestParams
+        # Return results where the `created` field is greater than this value.
+        attr_accessor :gt
+        # Return results where the `created` field is greater than or equal to this value.
+        attr_accessor :gte
+        # Return results where the `created` field is less than this value.
+        attr_accessor :lt
+        # Return results where the `created` field is less than or equal to this value.
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
+      attr_accessor :created
+      # A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
+      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 pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.
+      attr_accessor :starting_after
+
+      def initialize(created: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+  end
+end

data/lib/stripe/params/forwarding/request_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Forwarding
+    class RequestRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/fx_quote_create_params.rb

@@ -0,0 +1,73 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FxQuoteCreateParams < ::Stripe::RequestParams
+    class Usage < ::Stripe::RequestParams
+      class Payment < ::Stripe::RequestParams
+        # The Stripe account ID that the funds will be transferred to.
+        #
+        # This field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.
+        attr_accessor :destination
+        # The Stripe account ID that these funds are intended for.
+        #
+        # This field should match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
+        attr_accessor :on_behalf_of
+
+        def initialize(destination: nil, on_behalf_of: nil)
+          @destination = destination
+          @on_behalf_of = on_behalf_of
+        end
+      end
+
+      class Transfer < ::Stripe::RequestParams
+        # The Stripe account ID that the funds will be transferred to.
+        #
+        # This field should match the account ID that would be used in the Transfer’s destination field.
+        attr_accessor :destination
+
+        def initialize(destination: nil)
+          @destination = destination
+        end
+      end
+      # The payment transaction details that are intended for the FX Quote.
+      attr_accessor :payment
+      # The transfer transaction details that are intended for the FX Quote.
+      attr_accessor :transfer
+      # Which transaction the FX Quote will be used for
+      #
+      # Can be “payment” | “transfer”
+      attr_accessor :type
+
+      def initialize(payment: nil, transfer: nil, type: nil)
+        @payment = payment
+        @transfer = transfer
+        @type = type
+      end
+    end
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # A list of three letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be [supported currencies](https://stripe.com/docs/currencies).
+    attr_accessor :from_currencies
+    # The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is `none`. The maximum is 1 day.
+    attr_accessor :lock_duration
+    # 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_accessor :to_currency
+    # The usage specific information for the quote.
+    attr_accessor :usage
+
+    def initialize(
+      expand: nil,
+      from_currencies: nil,
+      lock_duration: nil,
+      to_currency: nil,
+      usage: nil
+    )
+      @expand = expand
+      @from_currencies = from_currencies
+      @lock_duration = lock_duration
+      @to_currency = to_currency
+      @usage = usage
+    end
+  end
+end

data/lib/stripe/params/fx_quote_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FxQuoteListParams < ::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
+
+    def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+      @ending_before = ending_before
+      @expand = expand
+      @limit = limit
+      @starting_after = starting_after
+    end
+  end
+end

data/lib/stripe/params/fx_quote_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FxQuoteRetrieveParams < ::Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/identity/verification_report_list_params.rb

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationReportListParams < ::Stripe::RequestParams
+      class Created < ::Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
+      attr_accessor :client_reference_id
+      # Only return VerificationReports that were created during the given date interval.
+      attr_accessor :created
+      # 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
+      # Only return VerificationReports of this type
+      attr_accessor :type
+      # Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.
+      attr_accessor :verification_session
+
+      def initialize(
+        client_reference_id: nil,
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        type: nil,
+        verification_session: nil
+      )
+        @client_reference_id = client_reference_id
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @type = type
+        @verification_session = verification_session
+      end
+    end
+  end
+end

data/lib/stripe/params/identity/verification_report_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationReportRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/identity/verification_session_cancel_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSessionCancelParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/identity/verification_session_create_params.rb

@@ -0,0 +1,111 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSessionCreateParams < ::Stripe::RequestParams
+      class Options < ::Stripe::RequestParams
+        class Document < ::Stripe::RequestParams
+          # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
+          attr_accessor :allowed_types
+          # Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
+          attr_accessor :require_id_number
+          # Disable image uploads, identity document images have to be captured using the device’s camera.
+          attr_accessor :require_live_capture
+          # Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie).
+          attr_accessor :require_matching_selfie
+
+          def initialize(
+            allowed_types: nil,
+            require_id_number: nil,
+            require_live_capture: nil,
+            require_matching_selfie: nil
+          )
+            @allowed_types = allowed_types
+            @require_id_number = require_id_number
+            @require_live_capture = require_live_capture
+            @require_matching_selfie = require_matching_selfie
+          end
+        end
+        # Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document).
+        attr_accessor :document
+
+        def initialize(document: nil)
+          @document = document
+        end
+      end
+
+      class ProvidedDetails < ::Stripe::RequestParams
+        # Email of user being verified
+        attr_accessor :email
+        # Phone number of user being verified
+        attr_accessor :phone
+
+        def initialize(email: nil, phone: nil)
+          @email = email
+          @phone = phone
+        end
+      end
+
+      class RelatedPerson < ::Stripe::RequestParams
+        # A token representing a connected account. If provided, the person parameter is also required and must be associated with the account.
+        attr_accessor :account
+        # A token referencing a Person resource that this verification is being used to verify.
+        attr_accessor :person
+
+        def initialize(account: nil, person: nil)
+          @account = account
+          @person = person
+        end
+      end
+      # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
+      attr_accessor :client_reference_id
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # 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. 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
+      # A set of options for the session’s verification checks.
+      attr_accessor :options
+      # Details provided about the user being verified. These details may be shown to the user.
+      attr_accessor :provided_details
+      # Customer ID
+      attr_accessor :related_customer
+      # The ID of the Account representing a customer.
+      attr_accessor :related_customer_account
+      # Tokens referencing a Person resource and it's associated account.
+      attr_accessor :related_person
+      # The URL that the user will be redirected to upon completing the verification flow.
+      attr_accessor :return_url
+      # The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
+      attr_accessor :type
+      # The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
+      attr_accessor :verification_flow
+
+      def initialize(
+        client_reference_id: nil,
+        expand: nil,
+        metadata: nil,
+        options: nil,
+        provided_details: nil,
+        related_customer: nil,
+        related_customer_account: nil,
+        related_person: nil,
+        return_url: nil,
+        type: nil,
+        verification_flow: nil
+      )
+        @client_reference_id = client_reference_id
+        @expand = expand
+        @metadata = metadata
+        @options = options
+        @provided_details = provided_details
+        @related_customer = related_customer
+        @related_customer_account = related_customer_account
+        @related_person = related_person
+        @return_url = return_url
+        @type = type
+        @verification_flow = verification_flow
+      end
+    end
+  end
+end

data/lib/stripe/params/identity/verification_session_list_params.rb

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSessionListParams < ::Stripe::RequestParams
+      class Created < ::Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
+      attr_accessor :client_reference_id
+      # Only return VerificationSessions that were created during the given date interval.
+      attr_accessor :created
+      # 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
+      # Customer ID
+      attr_accessor :related_customer
+      # The ID of the Account representing a customer.
+      attr_accessor :related_customer_account
+      # 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
+      # Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
+      attr_accessor :status
+
+      def initialize(
+        client_reference_id: nil,
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        related_customer: nil,
+        related_customer_account: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @client_reference_id = client_reference_id
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @related_customer = related_customer
+        @related_customer_account = related_customer_account
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+  end
+end

data/lib/stripe/params/identity/verification_session_redact_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSessionRedactParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/identity/verification_session_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSessionRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/identity/verification_session_update_params.rb

@@ -0,0 +1,69 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSessionUpdateParams < ::Stripe::RequestParams
+      class Options < ::Stripe::RequestParams
+        class Document < ::Stripe::RequestParams
+          # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
+          attr_accessor :allowed_types
+          # Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
+          attr_accessor :require_id_number
+          # Disable image uploads, identity document images have to be captured using the device’s camera.
+          attr_accessor :require_live_capture
+          # Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie).
+          attr_accessor :require_matching_selfie
+
+          def initialize(
+            allowed_types: nil,
+            require_id_number: nil,
+            require_live_capture: nil,
+            require_matching_selfie: nil
+          )
+            @allowed_types = allowed_types
+            @require_id_number = require_id_number
+            @require_live_capture = require_live_capture
+            @require_matching_selfie = require_matching_selfie
+          end
+        end
+        # Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document).
+        attr_accessor :document
+
+        def initialize(document: nil)
+          @document = document
+        end
+      end
+
+      class ProvidedDetails < ::Stripe::RequestParams
+        # Email of user being verified
+        attr_accessor :email
+        # Phone number of user being verified
+        attr_accessor :phone
+
+        def initialize(email: nil, phone: nil)
+          @email = email
+          @phone = phone
+        end
+      end
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # 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. 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
+      # A set of options for the session’s verification checks.
+      attr_accessor :options
+      # Details provided about the user being verified. These details may be shown to the user.
+      attr_accessor :provided_details
+      # The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.
+      attr_accessor :type
+
+      def initialize(expand: nil, metadata: nil, options: nil, provided_details: nil, type: nil)
+        @expand = expand
+        @metadata = metadata
+        @options = options
+        @provided_details = provided_details
+        @type = type
+      end
+    end
+  end
+end