stripe 14.0.0 → 14.1.0.pre.beta.1

data/lib/stripe/services/v2/money_management/outbound_payment_service.rb

@@ -0,0 +1,202 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundPaymentService < StripeService
+        class CancelParams < Stripe::RequestParams
+        end
+
+        class CreateParams < 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 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
+            # 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
+          # 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
+          # Details about the notification settings for the OutboundPayment recipient.
+          attr_accessor :recipient_notification
+          # 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,
+            recipient_notification: nil,
+            to: nil
+          )
+            @amount = amount
+            @delivery_options = delivery_options
+            @description = description
+            @from = from
+            @metadata = metadata
+            @outbound_payment_quote = outbound_payment_quote
+            @recipient_notification = recipient_notification
+            @to = to
+          end
+        end
+
+        class ListParams < 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
+
+        class RetrieveParams < Stripe::RequestParams
+        end
+
+        # Cancels an OutboundPayment. Only processing OutboundPayments can be canceled.
+        #
+        # ** raises AlreadyCanceledError
+        # ** raises NotCancelableError
+        def cancel(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/money_management/outbound_payments/%<id>s/cancel", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Creates an OutboundPayment.
+        #
+        # ** raises InsufficientFundsError
+        # ** raises QuotaExceededError
+        # ** raises RecipientNotNotifiableError
+        # ** raises FeatureNotEnabledError
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/money_management/outbound_payments",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Returns a list of OutboundPayments that match the provided filters.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/money_management/outbound_payments",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment create or list response.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/money_management/outbound_payments/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb

@@ -0,0 +1,237 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundSetupIntentService < StripeService
+        class CancelParams < Stripe::RequestParams
+        end
+
+        class CreateParams < 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 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,
+                routing_number: nil,
+                swift_code: nil
+              )
+                @account_number = account_number
+                @bank_account_type = bank_account_type
+                @branch_number = branch_number
+                @country = country
+                @routing_number = routing_number
+                @swift_code = swift_code
+              end
+            end
+
+            class Card < Stripe::RequestParams
+              # 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(exp_month: nil, exp_year: nil, number: nil)
+                @exp_month = exp_month
+                @exp_year = exp_year
+                @number = number
+              end
+            end
+            # Closed Enum. The type of payout method to be created.
+            attr_accessor :type
+            # 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
+
+            def initialize(type: nil, bank_account: nil, card: nil)
+              @type = type
+              @bank_account = bank_account
+              @card = card
+            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
+
+        class ListParams < Stripe::RequestParams
+          # The page size.
+          attr_accessor :limit
+
+          def initialize(limit: nil)
+            @limit = limit
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams
+        end
+
+        class UpdateParams < 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 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,
+                routing_number: nil,
+                swift_code: nil
+              )
+                @account_number = account_number
+                @bank_account_type = bank_account_type
+                @branch_number = branch_number
+                @country = country
+                @routing_number = routing_number
+                @swift_code = swift_code
+              end
+            end
+
+            class Card < Stripe::RequestParams
+              # 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(exp_month: nil, exp_year: nil, number: nil)
+                @exp_month = exp_month
+                @exp_year = exp_year
+                @number = number
+              end
+            end
+            # Closed Enum. The type of payout method to be created/updated.
+            attr_accessor :type
+            # 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
+
+            def initialize(type: nil, bank_account: nil, card: nil)
+              @type = type
+              @bank_account = bank_account
+              @card = card
+            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.
+          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
+
+        # Cancel an OutboundSetupIntent object.
+        def cancel(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/money_management/outbound_setup_intents/%<id>s/cancel", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Create an OutboundSetupIntent object.
+        #
+        # ** raises BlockedByStripeError
+        # ** raises InvalidPayoutMethodError
+        # ** raises QuotaExceededError
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/money_management/outbound_setup_intents",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # List the OutboundSetupIntent objects.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/money_management/outbound_setup_intents",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve an OutboundSetupIntent object.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/money_management/outbound_setup_intents/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update an OutboundSetupIntent object.
+        #
+        # ** raises QuotaExceededError
+        # ** raises BlockedByStripeError
+        # ** raises InvalidPayoutMethodError
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/money_management/outbound_setup_intents/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb

@@ -0,0 +1,174 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class OutboundTransferService < StripeService
+        class CancelParams < Stripe::RequestParams
+        end
+
+        class CreateParams < 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
+            # 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
+
+            def initialize(currency: nil, payout_method: nil)
+              @currency = currency
+              @payout_method = payout_method
+            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
+          # To which payout method to send the OutboundTransfer.
+          attr_accessor :to
+
+          def initialize(
+            amount: nil,
+            delivery_options: nil,
+            description: nil,
+            from: nil,
+            metadata: nil,
+            to: nil
+          )
+            @amount = amount
+            @delivery_options = delivery_options
+            @description = description
+            @from = from
+            @metadata = metadata
+            @to = to
+          end
+        end
+
+        class ListParams < 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
+          # Closed Enum. Only return OutboundTransfers with this status.
+          attr_accessor :status
+
+          def initialize(
+            created: nil,
+            created_gt: nil,
+            created_gte: nil,
+            created_lt: nil,
+            created_lte: nil,
+            limit: nil,
+            status: nil
+          )
+            @created = created
+            @created_gt = created_gt
+            @created_gte = created_gte
+            @created_lt = created_lt
+            @created_lte = created_lte
+            @limit = limit
+            @status = status
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams
+        end
+
+        # Cancels an OutboundTransfer. Only processing OutboundTransfers can be canceled.
+        #
+        # ** raises AlreadyCanceledError
+        # ** raises NotCancelableError
+        def cancel(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/money_management/outbound_transfers/%<id>s/cancel", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Creates an OutboundTransfer.
+        #
+        # ** raises InsufficientFundsError
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/money_management/outbound_transfers",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Returns a list of OutboundTransfers that match the provided filters.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/money_management/outbound_transfers",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundPayment create or list response.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/money_management/outbound_transfers/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end