stripe 19.3.0 → 19.4.0.pre.alpha.2

data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb

@@ -0,0 +1,183 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundPaymentCreateParams < ::Stripe::RequestParams
+        class DeliveryOptions < ::Stripe::RequestParams
+          class PaperCheck < ::Stripe::RequestParams
+            # The ID of a file to include as an attachment with the paper check.
+            attr_accessor :attachment
+            # Memo printed on the memo field of the check.
+            attr_accessor :memo
+            # Open Enum. Shipping speed of the paper check. Defaults to standard.
+            attr_accessor :shipping_speed
+            # Signature for the paper check.
+            attr_accessor :signature
+
+            def initialize(attachment: nil, memo: nil, shipping_speed: nil, signature: nil)
+              @attachment = attachment
+              @memo = memo
+              @shipping_speed = shipping_speed
+              @signature = signature
+            end
+          end
+          # Open Enum. Method for bank account.
+          attr_accessor :bank_account
+          # Delivery options for paper check.
+          attr_accessor :paper_check
+          # Open Enum. Speed of the payout.
+          attr_accessor :speed
+
+          def initialize(bank_account: nil, paper_check: nil, speed: nil)
+            @bank_account = bank_account
+            @paper_check = paper_check
+            @speed = speed
+          end
+        end
+
+        class From < ::Stripe::RequestParams
+          # Describes the FinancialAmount's currency drawn from.
+          attr_accessor :currency
+          # The FinancialAccount that funds were pulled from.
+          attr_accessor :financial_account
+
+          def initialize(currency: nil, financial_account: nil)
+            @currency = currency
+            @financial_account = financial_account
+          end
+        end
+
+        class RecipientNotification < ::Stripe::RequestParams
+          # Closed Enum. Configuration option to enable or disable notifications to recipients.
+          # Do not send notifications when setting is NONE. Default to account setting when setting is CONFIGURED or not set.
+          attr_accessor :setting
+
+          def initialize(setting: nil)
+            @setting = setting
+          end
+        end
+
+        class To < ::Stripe::RequestParams
+          class PayoutMethodOptions < ::Stripe::RequestParams
+            class BankAccount < ::Stripe::RequestParams
+              class PreferredNetworkOptions < ::Stripe::RequestParams
+                class Ach < ::Stripe::RequestParams
+                  # Open Enum. ACH submission timing.
+                  attr_accessor :submission
+                  # The transaction purpose for this ACH payment.
+                  attr_accessor :transaction_purpose
+
+                  def initialize(submission: nil, transaction_purpose: nil)
+                    @submission = submission
+                    @transaction_purpose = transaction_purpose
+                  end
+                end
+                # ACH-specific network options.
+                attr_accessor :ach
+
+                def initialize(ach: nil)
+                  @ach = ach
+                end
+              end
+              # Per-network configuration options.
+              attr_accessor :preferred_network_options
+              # The preferred networks to use for this OutboundPayment.
+              attr_accessor :preferred_networks
+
+              def initialize(preferred_network_options: nil, preferred_networks: nil)
+                @preferred_network_options = preferred_network_options
+                @preferred_networks = preferred_networks
+              end
+            end
+            # Options for bank account payout methods.
+            attr_accessor :bank_account
+
+            def initialize(bank_account: nil)
+              @bank_account = bank_account
+            end
+          end
+          # Describes the currency to send to the recipient.
+          # If included, this currency must match a currency supported by the destination.
+          # Can be omitted in the following cases:
+          # - destination only supports one currency
+          # - destination supports multiple currencies and one of the currencies matches the FA currency
+          # - destination supports multiple currencies and one of the currencies matches the presentment currency
+          # Note - when both FA currency and presentment currency are supported, we pick the FA currency to minimize FX.
+          attr_accessor :currency
+          # The payout method which the OutboundPayment uses to send payout.
+          attr_accessor :payout_method
+          # Payout method options for the OutboundPayment.
+          attr_accessor :payout_method_options
+          # To which account the OutboundPayment is sent.
+          attr_accessor :recipient
+
+          def initialize(
+            currency: nil,
+            payout_method: nil,
+            payout_method_options: nil,
+            recipient: nil
+          )
+            @currency = currency
+            @payout_method = payout_method
+            @payout_method_options = payout_method_options
+            @recipient = recipient
+          end
+        end
+        # The "presentment amount" to be sent to the recipient.
+        attr_accessor :amount
+        # Delivery options to be used to send the OutboundPayment.
+        attr_accessor :delivery_options
+        # An arbitrary string attached to the OutboundPayment. Often useful for displaying to users.
+        attr_accessor :description
+        # From which FinancialAccount and BalanceType to pull funds from.
+        attr_accessor :from
+        # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+        attr_accessor :metadata
+        # The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation.
+        attr_accessor :outbound_payment_quote
+        # The PayoutIntent ID that triggered this OutboundPayment.
+        attr_accessor :payout_intent
+        # The purpose of the OutboundPayment.
+        attr_accessor :purpose
+        # Details about the notification settings for the OutboundPayment recipient.
+        attr_accessor :recipient_notification
+        # The recipient verification id for this OutboundPayment. Only required for countries with regulatory mandates to verify recipient names before OutboundPayment creation.
+        attr_accessor :recipient_verification
+        # The description that appears on the receiving end for an OutboundPayment (for example, on a bank statement). Must be between 3 and 22 characters long for most destinations (500 for FinancialAccount destinations), and not contain profanity.
+        attr_accessor :statement_descriptor
+        # To which payout method to send the OutboundPayment.
+        attr_accessor :to
+
+        def initialize(
+          amount: nil,
+          delivery_options: nil,
+          description: nil,
+          from: nil,
+          metadata: nil,
+          outbound_payment_quote: nil,
+          payout_intent: nil,
+          purpose: nil,
+          recipient_notification: nil,
+          recipient_verification: nil,
+          statement_descriptor: nil,
+          to: nil
+        )
+          @amount = amount
+          @delivery_options = delivery_options
+          @description = description
+          @from = from
+          @metadata = metadata
+          @outbound_payment_quote = outbound_payment_quote
+          @payout_intent = payout_intent
+          @purpose = purpose
+          @recipient_notification = recipient_notification
+          @recipient_verification = recipient_verification
+          @statement_descriptor = statement_descriptor
+          @to = to
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_payment_list_params.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundPaymentListParams < ::Stripe::RequestParams
+        # Filter for objects created at the specified timestamp.
+        # Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+        attr_accessor :created
+        # Filter for objects created after the specified timestamp.
+        # Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+        attr_accessor :created_gt
+        # Filter for objects created on or after the specified timestamp.
+        # Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+        attr_accessor :created_gte
+        # Filter for objects created before the specified timestamp.
+        # Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+        attr_accessor :created_lt
+        # Filter for objects created on or before the specified timestamp.
+        # Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+        attr_accessor :created_lte
+        # The maximum number of results to return.
+        attr_accessor :limit
+        # Only return OutboundPayments sent to this recipient.
+        attr_accessor :recipient
+        # Closed Enum. Only return OutboundPayments with this status.
+        attr_accessor :status
+
+        def initialize(
+          created: nil,
+          created_gt: nil,
+          created_gte: nil,
+          created_lt: nil,
+          created_lte: nil,
+          limit: nil,
+          recipient: nil,
+          status: nil
+        )
+          @created = created
+          @created_gt = created_gt
+          @created_gte = created_gte
+          @created_lt = created_lt
+          @created_lte = created_lte
+          @limit = limit
+          @recipient = recipient
+          @status = status
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb

@@ -0,0 +1,70 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundPaymentQuoteCreateParams < ::Stripe::RequestParams
+        class DeliveryOptions < ::Stripe::RequestParams
+          # Open Enum. Method for bank account.
+          attr_accessor :bank_account
+          # Open Enum. Speed of the payout.
+          attr_accessor :speed
+
+          def initialize(bank_account: nil, speed: nil)
+            @bank_account = bank_account
+            @speed = speed
+          end
+        end
+
+        class From < ::Stripe::RequestParams
+          # Describes the FinancialAccount's currency drawn from.
+          attr_accessor :currency
+          # The FinancialAccount that funds were pulled from.
+          attr_accessor :financial_account
+
+          def initialize(currency: nil, financial_account: nil)
+            @currency = currency
+            @financial_account = financial_account
+          end
+        end
+
+        class To < ::Stripe::RequestParams
+          # Describes the currency to send to the recipient.
+          # If included, this currency must match a currency supported by the destination.
+          # Can be omitted in the following cases:
+          # - destination only supports one currency
+          # - destination supports multiple currencies and one of the currencies matches the FA currency
+          # - destination supports multiple currencies and one of the currencies matches the presentment currency
+          # Note - when both FA currency and presentment currency are supported, we pick the FA currency to minimize FX.
+          attr_accessor :currency
+          # The payout method which the OutboundPayment uses to send payout.
+          attr_accessor :payout_method
+          # To which account the OutboundPayment is sent.
+          attr_accessor :recipient
+
+          def initialize(currency: nil, payout_method: nil, recipient: nil)
+            @currency = currency
+            @payout_method = payout_method
+            @recipient = recipient
+          end
+        end
+        # The "presentment amount" to be sent to the recipient.
+        attr_accessor :amount
+        # Method to be used to send the OutboundPayment.
+        attr_accessor :delivery_options
+        # Request details about the sender of an OutboundPaymentQuote.
+        attr_accessor :from
+        # Request details about the recipient of an OutboundPaymentQuote.
+        attr_accessor :to
+
+        def initialize(amount: nil, delivery_options: nil, from: nil, to: nil)
+          @amount = amount
+          @delivery_options = delivery_options
+          @from = from
+          @to = to
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_payment_quote_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundPaymentQuoteRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_payment_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundPaymentRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_setup_intent_cancel_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundSetupIntentCancelParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_setup_intent_create_params.rb

@@ -0,0 +1,110 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundSetupIntentCreateParams < ::Stripe::RequestParams
+        class PayoutMethodData < ::Stripe::RequestParams
+          class BankAccount < ::Stripe::RequestParams
+            # The account number or IBAN of the bank account.
+            attr_accessor :account_number
+            # Closed Enum. The type of the bank account (checking or savings).
+            attr_accessor :bank_account_type
+            # The branch number of the bank account, if present.
+            attr_accessor :branch_number
+            # The country code of the bank account.
+            attr_accessor :country
+            # The currency of the bank account.
+            attr_accessor :currency
+            # The routing number of the bank account, if present.
+            attr_accessor :routing_number
+            # The swift code of the bank account, if present.
+            attr_accessor :swift_code
+
+            def initialize(
+              account_number: nil,
+              bank_account_type: nil,
+              branch_number: nil,
+              country: nil,
+              currency: nil,
+              routing_number: nil,
+              swift_code: nil
+            )
+              @account_number = account_number
+              @bank_account_type = bank_account_type
+              @branch_number = branch_number
+              @country = country
+              @currency = currency
+              @routing_number = routing_number
+              @swift_code = swift_code
+            end
+          end
+
+          class Card < ::Stripe::RequestParams
+            # The currency of the card.
+            attr_accessor :currency
+            # The expiration month of the card.
+            attr_accessor :exp_month
+            # The expiration year of the card.
+            attr_accessor :exp_year
+            # The card number.
+            attr_accessor :number
+
+            def initialize(currency: nil, exp_month: nil, exp_year: nil, number: nil)
+              @currency = currency
+              @exp_month = exp_month
+              @exp_year = exp_year
+              @number = number
+            end
+          end
+
+          class CryptoWallet < ::Stripe::RequestParams
+            # Crypto wallet address.
+            attr_accessor :address
+            # Optional field, required if network supports memos (only "stellar" currently).
+            attr_accessor :memo
+            # Which rail we should use to make an Outbound money movement to this wallet.
+            attr_accessor :network
+
+            def initialize(address: nil, memo: nil, network: nil)
+              @address = address
+              @memo = memo
+              @network = network
+            end
+          end
+          # The type specific details of the bank account payout method.
+          attr_accessor :bank_account
+          # The type specific details of the card payout method.
+          attr_accessor :card
+          # The type specific details of the crypto wallet payout method.
+          attr_accessor :crypto_wallet
+          # Closed Enum. The type of payout method to be created.
+          attr_accessor :type
+
+          def initialize(bank_account: nil, card: nil, crypto_wallet: nil, type: nil)
+            @bank_account = bank_account
+            @card = card
+            @crypto_wallet = crypto_wallet
+            @type = type
+          end
+        end
+        # If provided, the existing payout method resource to link to this setup intent.
+        # Any payout_method_data provided is used to update information on this linked payout method resource.
+        attr_accessor :payout_method
+        # If no payout_method provided, used to create the underlying credential that is set up for outbound money movement.
+        # If a payout_method provided, used to update data on the credential linked to this setup intent.
+        attr_accessor :payout_method_data
+        # Specify which type of outbound money movement this credential should be set up for (payment | transfer).
+        # If not provided, defaults to payment.
+        attr_accessor :usage_intent
+
+        def initialize(payout_method: nil, payout_method_data: nil, usage_intent: nil)
+          @payout_method = payout_method
+          @payout_method_data = payout_method_data
+          @usage_intent = usage_intent
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_setup_intent_list_params.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundSetupIntentListParams < ::Stripe::RequestParams
+        # The page size.
+        attr_accessor :limit
+
+        def initialize(limit: nil)
+          @limit = limit
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_setup_intent_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundSetupIntentRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_setup_intent_update_params.rb

@@ -0,0 +1,88 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundSetupIntentUpdateParams < ::Stripe::RequestParams
+        class PayoutMethodData < ::Stripe::RequestParams
+          class BankAccount < ::Stripe::RequestParams
+            # The account number or IBAN of the bank account.
+            attr_accessor :account_number
+            # Closed Enum. The type of the bank account (checking or savings).
+            attr_accessor :bank_account_type
+            # The branch number of the bank account, if present.
+            attr_accessor :branch_number
+            # The country code of the bank account.
+            attr_accessor :country
+            # The currency of the bank account.
+            attr_accessor :currency
+            # The routing number of the bank account, if present.
+            attr_accessor :routing_number
+            # The swift code of the bank account, if present.
+            attr_accessor :swift_code
+
+            def initialize(
+              account_number: nil,
+              bank_account_type: nil,
+              branch_number: nil,
+              country: nil,
+              currency: nil,
+              routing_number: nil,
+              swift_code: nil
+            )
+              @account_number = account_number
+              @bank_account_type = bank_account_type
+              @branch_number = branch_number
+              @country = country
+              @currency = currency
+              @routing_number = routing_number
+              @swift_code = swift_code
+            end
+          end
+
+          class Card < ::Stripe::RequestParams
+            # The currency of the card.
+            attr_accessor :currency
+            # The expiration month of the card.
+            attr_accessor :exp_month
+            # The expiration year of the card.
+            attr_accessor :exp_year
+            # The card number. This can only be passed when creating a new credential on an outbound setup intent in the requires_payout_method state.
+            attr_accessor :number
+
+            def initialize(currency: nil, exp_month: nil, exp_year: nil, number: nil)
+              @currency = currency
+              @exp_month = exp_month
+              @exp_year = exp_year
+              @number = number
+            end
+          end
+          # The type specific details of the bank account payout method.
+          attr_accessor :bank_account
+          # The type specific details of the card payout method.
+          attr_accessor :card
+          # Closed Enum. The type of payout method to be created/updated.
+          attr_accessor :type
+
+          def initialize(bank_account: nil, card: nil, type: nil)
+            @bank_account = bank_account
+            @card = card
+            @type = type
+          end
+        end
+        # If provided, the existing payout method resource to link to this outbound setup intent.
+        attr_accessor :payout_method
+        # If no payout_method provided, used to create the underlying credential that is set up for outbound money movement.
+        # If a payout_method provided, used to update data on the credential linked to this setup intent.
+        # Only card expiry (exp_month, exp_year) can be updated in the case where payout_method is provided.
+        attr_accessor :payout_method_data
+
+        def initialize(payout_method: nil, payout_method_data: nil)
+          @payout_method = payout_method
+          @payout_method_data = payout_method_data
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_transfer_cancel_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundTransferCancelParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/money_management/outbound_transfer_create_params.rb

@@ -0,0 +1,104 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundTransferCreateParams < ::Stripe::RequestParams
+        class DeliveryOptions < ::Stripe::RequestParams
+          # Open Enum. Method for bank account.
+          attr_accessor :bank_account
+
+          def initialize(bank_account: nil)
+            @bank_account = bank_account
+          end
+        end
+
+        class From < ::Stripe::RequestParams
+          # Describes the FinancialAmount's currency drawn from.
+          attr_accessor :currency
+          # The FinancialAccount that funds were pulled from.
+          attr_accessor :financial_account
+
+          def initialize(currency: nil, financial_account: nil)
+            @currency = currency
+            @financial_account = financial_account
+          end
+        end
+
+        class To < ::Stripe::RequestParams
+          class PayoutMethodOptions < ::Stripe::RequestParams
+            class BankAccount < ::Stripe::RequestParams
+              # The preferred networks to use for this OutboundTransfer.
+              attr_accessor :preferred_networks
+
+              def initialize(preferred_networks: nil)
+                @preferred_networks = preferred_networks
+              end
+            end
+            # Options for bank account payout methods.
+            attr_accessor :bank_account
+
+            def initialize(bank_account: nil)
+              @bank_account = bank_account
+            end
+          end
+          # Describes the currency to send to the recipient.
+          # If included, this currency must match a currency supported by the destination.
+          # Can be omitted in the following cases:
+          # - destination only supports one currency
+          # - destination supports multiple currencies and one of the currencies matches the FA currency
+          # - destination supports multiple currencies and one of the currencies matches the presentment currency
+          # Note - when both FA currency and presentment currency are supported, we pick the FA currency to minimize FX.
+          attr_accessor :currency
+          # The payout method which the OutboundTransfer uses to send payout.
+          attr_accessor :payout_method
+          # Payout method options for the OutboundTransfer.
+          attr_accessor :payout_method_options
+
+          def initialize(currency: nil, payout_method: nil, payout_method_options: nil)
+            @currency = currency
+            @payout_method = payout_method
+            @payout_method_options = payout_method_options
+          end
+        end
+        # The "presentment amount" for the OutboundPayment.
+        attr_accessor :amount
+        # Delivery options to be used to send the OutboundTransfer.
+        attr_accessor :delivery_options
+        # An arbitrary string attached to the OutboundTransfer. Often useful for displaying to users.
+        attr_accessor :description
+        # The FinancialAccount to pull funds from.
+        attr_accessor :from
+        # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+        attr_accessor :metadata
+        # The recipient verification id for this OutboundTransfer. Only required for countries with regulatory mandates to verify recipient names before OutboundTransfer creation.
+        attr_accessor :recipient_verification
+        # The description that appears on the receiving end for an OutboundTransfer (for example, on a bank statement). Must be between 3 and 22 characters long for most destinations (500 for FinancialAccount destinations), and not contain profanity.
+        attr_accessor :statement_descriptor
+        # To which payout method to send the OutboundTransfer.
+        attr_accessor :to
+
+        def initialize(
+          amount: nil,
+          delivery_options: nil,
+          description: nil,
+          from: nil,
+          metadata: nil,
+          recipient_verification: nil,
+          statement_descriptor: nil,
+          to: nil
+        )
+          @amount = amount
+          @delivery_options = delivery_options
+          @description = description
+          @from = from
+          @metadata = metadata
+          @recipient_verification = recipient_verification
+          @statement_descriptor = statement_descriptor
+          @to = to
+        end
+      end
+    end
+  end
+end