stripe 13.4.1 → 17.0.1

data/lib/stripe/params/token_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TokenRetrieveParams < 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/topup_cancel_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TopupCancelParams < 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/topup_create_params.rb

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TopupCreateParams < Stripe::RequestParams
+    # A positive integer representing how much to transfer.
+    attr_accessor :amount
+    # 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 :currency
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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. 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
+    # The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)).
+    attr_accessor :source
+    # Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.
+    attr_accessor :statement_descriptor
+    # A string that identifies this top-up as part of a group.
+    attr_accessor :transfer_group
+
+    def initialize(
+      amount: nil,
+      currency: nil,
+      description: nil,
+      expand: nil,
+      metadata: nil,
+      source: nil,
+      statement_descriptor: nil,
+      transfer_group: nil
+    )
+      @amount = amount
+      @currency = currency
+      @description = description
+      @expand = expand
+      @metadata = metadata
+      @source = source
+      @statement_descriptor = statement_descriptor
+      @transfer_group = transfer_group
+    end
+  end
+end

data/lib/stripe/params/topup_list_params.rb

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TopupListParams < Stripe::RequestParams
+    class Amount < 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
+
+    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 positive integer representing how much to transfer.
+    attr_accessor :amount
+    # A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
+    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 top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.
+    attr_accessor :status
+
+    def initialize(
+      amount: nil,
+      created: nil,
+      ending_before: nil,
+      expand: nil,
+      limit: nil,
+      starting_after: nil,
+      status: nil
+    )
+      @amount = amount
+      @created = created
+      @ending_before = ending_before
+      @expand = expand
+      @limit = limit
+      @starting_after = starting_after
+      @status = status
+    end
+  end
+end

data/lib/stripe/params/topup_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TopupRetrieveParams < 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/topup_update_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TopupUpdateParams < Stripe::RequestParams
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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. 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
+
+    def initialize(description: nil, expand: nil, metadata: nil)
+      @description = description
+      @expand = expand
+      @metadata = metadata
+    end
+  end
+end

data/lib/stripe/params/transfer_create_params.rb

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferCreateParams < Stripe::RequestParams
+    # A positive integer in cents (or local equivalent) representing how much to transfer.
+    attr_accessor :amount
+    # Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).
+    attr_accessor :currency
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # The ID of a connected Stripe account. <a href="/docs/connect/separate-charges-and-transfers">See the Connect documentation</a> for details.
+    attr_accessor :destination
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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. 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
+    # You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.
+    attr_accessor :source_transaction
+    # The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.
+    attr_accessor :source_type
+    # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
+    attr_accessor :transfer_group
+
+    def initialize(
+      amount: nil,
+      currency: nil,
+      description: nil,
+      destination: nil,
+      expand: nil,
+      metadata: nil,
+      source_transaction: nil,
+      source_type: nil,
+      transfer_group: nil
+    )
+      @amount = amount
+      @currency = currency
+      @description = description
+      @destination = destination
+      @expand = expand
+      @metadata = metadata
+      @source_transaction = source_transaction
+      @source_type = source_type
+      @transfer_group = transfer_group
+    end
+  end
+end

data/lib/stripe/params/transfer_list_params.rb

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferListParams < 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
+    # Only return transfers that were created during the given date interval.
+    attr_accessor :created
+    # Only return transfers for the destination specified by this account ID.
+    attr_accessor :destination
+    # 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 transfers with the specified transfer group.
+    attr_accessor :transfer_group
+
+    def initialize(
+      created: nil,
+      destination: nil,
+      ending_before: nil,
+      expand: nil,
+      limit: nil,
+      starting_after: nil,
+      transfer_group: nil
+    )
+      @created = created
+      @destination = destination
+      @ending_before = ending_before
+      @expand = expand
+      @limit = limit
+      @starting_after = starting_after
+      @transfer_group = transfer_group
+    end
+  end
+end

data/lib/stripe/params/transfer_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferRetrieveParams < 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/transfer_reversal_create_params.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferReversalCreateParams < Stripe::RequestParams
+    # A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.
+    attr_accessor :amount
+    # An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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. 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
+    # Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.
+    attr_accessor :refund_application_fee
+
+    def initialize(
+      amount: nil,
+      description: nil,
+      expand: nil,
+      metadata: nil,
+      refund_application_fee: nil
+    )
+      @amount = amount
+      @description = description
+      @expand = expand
+      @metadata = metadata
+      @refund_application_fee = refund_application_fee
+    end
+  end
+end

data/lib/stripe/params/transfer_reversal_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferReversalListParams < 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/transfer_reversal_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferReversalRetrieveParams < 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/transfer_reversal_update_params.rb

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferReversalUpdateParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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. 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
+
+    def initialize(expand: nil, metadata: nil)
+      @expand = expand
+      @metadata = metadata
+    end
+  end
+end

data/lib/stripe/params/transfer_update_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferUpdateParams < Stripe::RequestParams
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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. 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
+
+    def initialize(description: nil, expand: nil, metadata: nil)
+      @description = description
+      @expand = expand
+      @metadata = metadata
+    end
+  end
+end

data/lib/stripe/params/treasury/credit_reversal_create_params.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class CreditReversalCreateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # 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. 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
+      # The ReceivedCredit to reverse.
+      attr_accessor :received_credit
+
+      def initialize(expand: nil, metadata: nil, received_credit: nil)
+        @expand = expand
+        @metadata = metadata
+        @received_credit = received_credit
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/credit_reversal_list_params.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class CreditReversalListParams < 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
+      # Returns objects associated with this FinancialAccount.
+      attr_accessor :financial_account
+      # 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
+      # Only return CreditReversals for the ReceivedCredit ID.
+      attr_accessor :received_credit
+      # 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 CreditReversals for a given status.
+      attr_accessor :status
+
+      def initialize(
+        ending_before: nil,
+        expand: nil,
+        financial_account: nil,
+        limit: nil,
+        received_credit: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @ending_before = ending_before
+        @expand = expand
+        @financial_account = financial_account
+        @limit = limit
+        @received_credit = received_credit
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/credit_reversal_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class CreditReversalRetrieveParams < 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/treasury/debit_reversal_create_params.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class DebitReversalCreateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # 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. 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
+      # The ReceivedDebit to reverse.
+      attr_accessor :received_debit
+
+      def initialize(expand: nil, metadata: nil, received_debit: nil)
+        @expand = expand
+        @metadata = metadata
+        @received_debit = received_debit
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/debit_reversal_list_params.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class DebitReversalListParams < 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
+      # Returns objects associated with this FinancialAccount.
+      attr_accessor :financial_account
+      # 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
+      # Only return DebitReversals for the ReceivedDebit ID.
+      attr_accessor :received_debit
+      # Only return DebitReversals for a given resolution.
+      attr_accessor :resolution
+      # 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 DebitReversals for a given status.
+      attr_accessor :status
+
+      def initialize(
+        ending_before: nil,
+        expand: nil,
+        financial_account: nil,
+        limit: nil,
+        received_debit: nil,
+        resolution: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @ending_before = ending_before
+        @expand = expand
+        @financial_account = financial_account
+        @limit = limit
+        @received_debit = received_debit
+        @resolution = resolution
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/debit_reversal_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class DebitReversalRetrieveParams < 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/treasury/financial_account_close_params.rb

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class FinancialAccountCloseParams < Stripe::RequestParams
+      class ForwardingSettings < Stripe::RequestParams
+        # The financial_account id
+        attr_accessor :financial_account
+        # The payment_method or bank account id. This needs to be a verified bank account.
+        attr_accessor :payment_method
+        # The type of the bank account provided. This can be either "financial_account" or "payment_method"
+        attr_accessor :type
+
+        def initialize(financial_account: nil, payment_method: nil, type: nil)
+          @financial_account = financial_account
+          @payment_method = payment_method
+          @type = type
+        end
+      end
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
+      attr_accessor :forwarding_settings
+
+      def initialize(expand: nil, forwarding_settings: nil)
+        @expand = expand
+        @forwarding_settings = forwarding_settings
+      end
+    end
+  end
+end