stripe 15.1.0 → 15.2.0.pre.beta.1

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

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

@@ -0,0 +1,95 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class PayoutMethodService < StripeService
+        class ArchiveParams < Stripe::RequestParams
+        end
+
+        class ListParams < Stripe::RequestParams
+          class UsageStatus < Stripe::RequestParams
+            # List of payments status to filter by.
+            attr_accessor :payments
+            # List of transfers status to filter by.
+            attr_accessor :transfers
+
+            def initialize(payments: nil, transfers: nil)
+              @payments = payments
+              @transfers = transfers
+            end
+          end
+          # The page size.
+          attr_accessor :limit
+          # Usage status filter.
+          attr_accessor :usage_status
+
+          def initialize(limit: nil, usage_status: nil)
+            @limit = limit
+            @usage_status = usage_status
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams
+        end
+
+        class UnarchiveParams < Stripe::RequestParams
+        end
+
+        # Archive a PayoutMethod object. Archived objects cannot be used as payout methods
+        # and will not appear in the payout method list.
+        #
+        # ** raises ControlledByDashboardError
+        # ** raises InvalidPayoutMethodError
+        def archive(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/money_management/payout_methods/%<id>s/archive", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # List objects that adhere to the PayoutMethod interface.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/money_management/payout_methods",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve a PayoutMethod object.
+        #
+        # ** raises InvalidPayoutMethodError
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/money_management/payout_methods/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Unarchive an PayoutMethod object.
+        #
+        # ** raises ControlledByDashboardError
+        # ** raises InvalidPayoutMethodError
+        def unarchive(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/money_management/payout_methods/%<id>s/unarchive", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class PayoutMethodsBankAccountSpecService < StripeService
+        class RetrieveParams < Stripe::RequestParams
+          # The countries to fetch the bank account spec for.
+          attr_accessor :countries
+
+          def initialize(countries: nil)
+            @countries = countries
+          end
+        end
+
+        # Fetch the specifications for a set of countries to know which
+        # credential fields are required, the validations for each fields, and how to translate these
+        # country-specific fields to the generic fields in the PayoutMethodBankAccount type.
+        def retrieve(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/money_management/payout_methods_bank_account_spec",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class ReceivedCreditService < StripeService
+        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 page limit.
+          attr_accessor :limit
+
+          def initialize(
+            created: nil,
+            created_gt: nil,
+            created_gte: nil,
+            created_lt: nil,
+            created_lte: nil,
+            limit: nil
+          )
+            @created = created
+            @created_gt = created_gt
+            @created_gte = created_gte
+            @created_lt = created_lt
+            @created_lte = created_lte
+            @limit = limit
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams
+        end
+
+        # Retrieves a list of ReceivedCredits.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/money_management/received_credits",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve a ReceivedCredit by ID.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/money_management/received_credits/%<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/received_debit_service.rb

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class ReceivedDebitService < StripeService
+        class ListParams < Stripe::RequestParams
+          # The page limit.
+          attr_accessor :limit
+
+          def initialize(limit: nil)
+            @limit = limit
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams
+        end
+
+        # Retrieves a list of ReceivedDebits, given the selected filters.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/money_management/received_debits",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieves a single ReceivedDebit by ID.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/money_management/received_debits/%<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/transaction_entry_service.rb

@@ -0,0 +1,70 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class TransactionEntryService < StripeService
+        class ListParams < Stripe::RequestParams
+          # Filter for Transactions created at an exact time.
+          attr_accessor :created
+          # Filter for Transactions created after the specified timestamp.
+          attr_accessor :created_gt
+          # Filter for Transactions created at or after the specified timestamp.
+          attr_accessor :created_gte
+          # Filter for Transactions created before the specified timestamp.
+          attr_accessor :created_lt
+          # Filter for Transactions created at or before the specified timestamp.
+          attr_accessor :created_lte
+          # The page limit.
+          attr_accessor :limit
+          # Filter for TransactionEntries belonging to a Transaction.
+          attr_accessor :transaction
+
+          def initialize(
+            created: nil,
+            created_gt: nil,
+            created_gte: nil,
+            created_lt: nil,
+            created_lte: nil,
+            limit: nil,
+            transaction: nil
+          )
+            @created = created
+            @created_gt = created_gt
+            @created_gte = created_gte
+            @created_lt = created_lt
+            @created_lte = created_lte
+            @limit = limit
+            @transaction = transaction
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams
+        end
+
+        # Returns a list of TransactionEntries that match the provided filters.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/money_management/transaction_entries",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieves the details of a TransactionEntry by ID.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/money_management/transaction_entries/%<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/transaction_service.rb

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      class TransactionService < StripeService
+        class ListParams < Stripe::RequestParams
+          # Filter for Transactions created at an exact time.
+          attr_accessor :created
+          # Filter for Transactions created after the specified timestamp.
+          attr_accessor :created_gt
+          # Filter for Transactions created at or after the specified timestamp.
+          attr_accessor :created_gte
+          # Filter for Transactions created before the specified timestamp.
+          attr_accessor :created_lt
+          # Filter for Transactions created at or before the specified timestamp.
+          attr_accessor :created_lte
+          # Filter for Transactions belonging to a FinancialAccount.
+          attr_accessor :financial_account
+          # Filter for Transactions corresponding to a Flow.
+          attr_accessor :flow
+          # The page limit.
+          attr_accessor :limit
+
+          def initialize(
+            created: nil,
+            created_gt: nil,
+            created_gte: nil,
+            created_lt: nil,
+            created_lte: nil,
+            financial_account: nil,
+            flow: nil,
+            limit: nil
+          )
+            @created = created
+            @created_gt = created_gt
+            @created_gte = created_gte
+            @created_lt = created_lt
+            @created_lte = created_lte
+            @financial_account = financial_account
+            @flow = flow
+            @limit = limit
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams
+        end
+
+        # Returns a list of Transactions that match the provided filters.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/money_management/transactions",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieves the details of a Transaction by ID.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/money_management/transactions/%<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_service.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class MoneyManagementService < StripeService
+      attr_reader :adjustments, :financial_accounts, :financial_addresses, :inbound_transfers, :outbound_payments, :outbound_payment_quotes, :outbound_transfers, :outbound_setup_intents, :payout_methods, :payout_methods_bank_account_spec, :received_credits, :received_debits, :transactions, :transaction_entries
+
+      def initialize(requestor)
+        super
+        @adjustments = Stripe::V2::MoneyManagement::AdjustmentService.new(@requestor)
+        @financial_accounts = Stripe::V2::MoneyManagement::FinancialAccountService.new(@requestor)
+        @financial_addresses = Stripe::V2::MoneyManagement::FinancialAddressService.new(@requestor)
+        @inbound_transfers = Stripe::V2::MoneyManagement::InboundTransferService.new(@requestor)
+        @outbound_payments = Stripe::V2::MoneyManagement::OutboundPaymentService.new(@requestor)
+        @outbound_payment_quotes = Stripe::V2::MoneyManagement::OutboundPaymentQuoteService
+                                   .new(@requestor)
+        @outbound_transfers = Stripe::V2::MoneyManagement::OutboundTransferService.new(@requestor)
+        @outbound_setup_intents = Stripe::V2::MoneyManagement::OutboundSetupIntentService
+                                  .new(@requestor)
+        @payout_methods = Stripe::V2::MoneyManagement::PayoutMethodService.new(@requestor)
+        @payout_methods_bank_account_spec = Stripe::V2::MoneyManagement::PayoutMethodsBankAccountSpecService
+                                            .new(@requestor)
+        @received_credits = Stripe::V2::MoneyManagement::ReceivedCreditService.new(@requestor)
+        @received_debits = Stripe::V2::MoneyManagement::ReceivedDebitService.new(@requestor)
+        @transactions = Stripe::V2::MoneyManagement::TransactionService.new(@requestor)
+        @transaction_entries = Stripe::V2::MoneyManagement::TransactionEntryService.new(@requestor)
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/test_helper_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class TestHelperService < StripeService
+      attr_reader :financial_addresses
+
+      def initialize(requestor)
+        super
+        @financial_addresses = Stripe::V2::TestHelpers::FinancialAddressService.new(@requestor)
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/test_helpers/financial_address_service.rb

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module TestHelpers
+      class FinancialAddressService < StripeService
+        class CreditParams < Stripe::RequestParams
+          # Object containing the amount value and currency to credit.
+          attr_accessor :amount
+          # Open Enum. The network to use in simulating the funds flow. This will be the reflected in the resulting ReceivedCredit.
+          attr_accessor :network
+          # String explaining funds flow. Use this field to populate the statement descriptor of the ReceivedCredit created as an eventual result of this simulation.
+          attr_accessor :statement_descriptor
+
+          def initialize(amount: nil, network: nil, statement_descriptor: nil)
+            @amount = amount
+            @network = network
+            @statement_descriptor = statement_descriptor
+          end
+        end
+
+        class GenerateMicrodepositsParams < Stripe::RequestParams
+        end
+
+        # Simulate crediting a FinancialAddress in a Sandbox environment. This can be used to add virtual funds and increase your balance for testing.
+        def credit(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/test_helpers/financial_addresses/%<id>s/credit", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Generates microdeposits for a FinancialAddress in a Sandbox environment.
+        def generate_microdeposits(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/test_helpers/financial_addresses/%<id>s/generate_microdeposits", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2_services.rb

@@ -3,12 +3,14 @@
 
 module Stripe
   class V2Services < StripeService
-    attr_reader :billing, :core
+    attr_reader :core, :money_management, :billing, :test_helpers
 
     def initialize(requestor)
       super
-      @billing = Stripe::V2::BillingService.new(@requestor)
       @core = Stripe::V2::CoreService.new(@requestor)
+      @money_management = Stripe::V2::MoneyManagementService.new(@requestor)
+      @billing = Stripe::V2::BillingService.new(@requestor)
+      @test_helpers = Stripe::V2::TestHelperService.new(@requestor)
     end
   end
 end