straddle 0.4.0 → 1.0.0

data/lib/straddle/models/funding_event_summary_list.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#list
+    class FundingEventSummaryList < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #   Funding events returned for this page.
+      #
+      #   @return [Array<Straddle::Models::FundingEventSummary>]
+      required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::FundingEventSummary] }
+
+      # @!attribute meta
+      #   Metadata for an API request and a page of results.
+      #
+      #   @return [Straddle::Models::PageMetadata]
+      required :meta, -> { Straddle::PageMetadata }
+
+      # @!attribute response_type
+      #   Shape of the response envelope.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of JSON objects.
+      #   - `error` means `error` contains the error details.
+      #   - `none` means the response contains no data.
+      #
+      #   @return [Symbol, Straddle::Models::ResponseType]
+      required :response_type, enum: -> { Straddle::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventSummaryList} for more details.
+      #
+      #   @param data [Array<Straddle::Models::FundingEventSummary>] Funding events returned for this page.
+      #
+      #   @param meta [Straddle::Models::PageMetadata] Metadata for an API request and a page of results.
+      #
+      #   @param response_type [Symbol, Straddle::Models::ResponseType] Shape of the response envelope.
+    end
+  end
+end

data/lib/straddle/models/funding_event_transfer_direction.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # Transfer direction relative to the linked bank account. `deposit` moves funds
+    # into the account, and `withdrawal` moves funds out.
+    module FundingEventTransferDirection
+      extend Straddle::Internal::Type::Enum
+
+      DEPOSIT = :deposit
+      WITHDRAWAL = :withdrawal
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/funding_event_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # Reason for the funding event. `charge_deposit` settles collected charges to the
+    # linked bank account. `charge_reversal` withdraws funds for reversed charges.
+    # `payout_withdrawal` withdraws funds for payouts. `payout_return` deposits
+    # returned payout funds.
+    module FundingEventType
+      extend Straddle::Internal::Type::Enum
+
+      CHARGE_DEPOSIT = :charge_deposit
+      CHARGE_REVERSAL = :charge_reversal
+      PAYOUT_RETURN = :payout_return
+      PAYOUT_WITHDRAWAL = :payout_withdrawal
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/linked_bank_account.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class LinkedBankAccount < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Straddle's unique ID for the linked bank account.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   ID of the related account, if this is an account-level linked bank account.
+      #
+      #   @return [String, nil]
+      required :account_id, String, nil?: true
+
+      # @!attribute bank_account
+      #
+      #   @return [Straddle::Models::MaskedLinkedBankAccountDetails]
+      required :bank_account, -> { Straddle::MaskedLinkedBankAccountDetails }
+
+      # @!attribute created_at
+      #   Date and time when Straddle created the linked bank account.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute purposes
+      #   Payment purposes assigned to the linked bank account.
+      #
+      #   @return [Array<Symbol, Straddle::Models::LinkedBankAccount::Purpose>]
+      required :purposes, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::LinkedBankAccount::Purpose] }
+
+      # @!attribute status
+      #   Status of the linked bank account.
+      #
+      #   @return [Symbol, Straddle::Models::LinkedBankAccount::Status]
+      required :status, enum: -> { Straddle::LinkedBankAccount::Status }
+
+      # @!attribute status_detail
+      #
+      #   @return [Straddle::Models::LinkedBankAccountStatusDetail]
+      required :status_detail, -> { Straddle::LinkedBankAccountStatusDetail }
+
+      # @!attribute updated_at
+      #   Date and time of the most recent linked bank account update.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute description
+      #   Your description for the linked bank account.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String, nil?: true], nil?: true
+
+      # @!attribute platform_id
+      #   ID of the related platform, if this is a platform-level linked bank account.
+      #
+      #   @return [String, nil]
+      optional :platform_id, String, nil?: true
+
+      # @!method initialize(id:, account_id:, bank_account:, created_at:, purposes:, status:, status_detail:, updated_at:, description: nil, metadata: nil, platform_id: nil)
+      #   @param id [String] Straddle's unique ID for the linked bank account.
+      #
+      #   @param account_id [String, nil] ID of the related account, if this is an account-level linked bank account.
+      #
+      #   @param bank_account [Straddle::Models::MaskedLinkedBankAccountDetails]
+      #
+      #   @param created_at [Time] Date and time when Straddle created the linked bank account.
+      #
+      #   @param purposes [Array<Symbol, Straddle::Models::LinkedBankAccount::Purpose>] Payment purposes assigned to the linked bank account.
+      #
+      #   @param status [Symbol, Straddle::Models::LinkedBankAccount::Status] Status of the linked bank account.
+      #
+      #   @param status_detail [Straddle::Models::LinkedBankAccountStatusDetail]
+      #
+      #   @param updated_at [Time] Date and time of the most recent linked bank account update.
+      #
+      #   @param description [String, nil] Your description for the linked bank account.
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 user-defined key-value pairs.
+      #
+      #   @param platform_id [String, nil] ID of the related platform, if this is a platform-level linked bank account.
+
+      module Purpose
+        extend Straddle::Internal::Type::Enum
+
+        CHARGES = :charges
+        PAYOUTS = :payouts
+        BILLING = :billing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of the linked bank account.
+      #
+      # @see Straddle::Models::LinkedBankAccount#status
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        CREATED = :created
+        ONBOARDING = :onboarding
+        ACTIVE = :active
+        REJECTED = :rejected
+        INACTIVE = :inactive
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/linked_bank_account_cancel_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::LinkedBankAccounts#cancel
+    class LinkedBankAccountCancelParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute linked_bank_account_id
+      #
+      #   @return [String]
+      required :linked_bank_account_id, String
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!method initialize(linked_bank_account_id:, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   @param linked_bank_account_id [String]
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/linked_bank_account_create_params.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::LinkedBankAccounts#create
+    class LinkedBankAccountCreateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute bank_account
+      #
+      #   @return [Straddle::Models::LinkedBankAccountCreateParams::BankAccount]
+      required :bank_account, -> { Straddle::LinkedBankAccountCreateParams::BankAccount }
+
+      # @!attribute account_id
+      #   ID of the account that will own the linked bank account. Omit this field to
+      #   assign ownership to the platform in the authenticated request context.
+      #
+      #   @return [String, nil]
+      optional :account_id, String, nil?: true
+
+      # @!attribute description
+      #   Your description for the linked bank account.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String, nil?: true], nil?: true
+
+      # @!attribute platform_id
+      #   ID of the platform to associate with the linked bank account.
+      #
+      #   @return [String, nil]
+      optional :platform_id, String, nil?: true
+
+      # @!attribute purposes
+      #   Payment purposes for the linked bank account. Defaults to `charges`, `payouts`,
+      #   and `billing`.
+      #
+      #   @return [Array<Symbol, Straddle::Models::LinkedBankAccountCreateParams::Purpose>, nil]
+      optional :purposes,
+               -> do
+                 Straddle::Internal::Type::ArrayOf[enum: Straddle::LinkedBankAccountCreateParams::Purpose]
+               end,
+               nil?: true
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!method initialize(bank_account:, account_id: nil, description: nil, metadata: nil, platform_id: nil, purposes: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::LinkedBankAccountCreateParams} for more details.
+      #
+      #   @param bank_account [Straddle::Models::LinkedBankAccountCreateParams::BankAccount]
+      #
+      #   @param account_id [String, nil] ID of the account that will own the linked bank account. Omit this field to assi
+      #
+      #   @param description [String, nil] Your description for the linked bank account.
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 user-defined key-value pairs.
+      #
+      #   @param platform_id [String, nil] ID of the platform to associate with the linked bank account.
+      #
+      #   @param purposes [Array<Symbol, Straddle::Models::LinkedBankAccountCreateParams::Purpose>, nil] Payment purposes for the linked bank account. Defaults to `charges`, `payouts`,
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+      class BankAccount < Straddle::Internal::Type::BaseModel
+        # @!attribute account_holder
+        #   Account holder name as it appears on the bank account. This is usually the
+        #   business's legal name.
+        #
+        #   @return [String]
+        required :account_holder, String
+
+        # @!attribute account_number
+        #   The bank account number.
+        #
+        #   @return [String]
+        required :account_number, String
+
+        # @!attribute routing_number
+        #   Nine-digit ABA routing number.
+        #
+        #   @return [String]
+        required :routing_number, String
+
+        # @!method initialize(account_holder:, account_number:, routing_number:)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::LinkedBankAccountCreateParams::BankAccount} for more details.
+        #
+        #   @param account_holder [String] Account holder name as it appears on the bank account. This is usually the busin
+        #
+        #   @param account_number [String] The bank account number.
+        #
+        #   @param routing_number [String] Nine-digit ABA routing number.
+      end
+
+      module Purpose
+        extend Straddle::Internal::Type::Enum
+
+        CHARGES = :charges
+        PAYOUTS = :payouts
+        BILLING = :billing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/linked_bank_account_created_v1_webhook_event.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class LinkedBankAccountCreatedV1WebhookEvent < Straddle::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   Unique identifier for the account associated with this event.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::LinkedBankAccount]
+      required :data, -> { Straddle::LinkedBankAccount }
+
+      # @!attribute event_id
+      #   Unique identifier for this event.
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_type
+      #   Type of this event.
+      #
+      #   @return [String]
+      required :event_type, String
+
+      # @!method initialize(account_id:, data:, event_id:, event_type:)
+      #   @param account_id [String] Unique identifier for the account associated with this event.
+      #
+      #   @param data [Straddle::Models::LinkedBankAccount]
+      #
+      #   @param event_id [String] Unique identifier for this event.
+      #
+      #   @param event_type [String] Type of this event.
+    end
+  end
+end

data/lib/straddle/models/linked_bank_account_event_v1_webhook_event.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class LinkedBankAccountEventV1WebhookEvent < Straddle::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   Unique identifier for the account associated with this event.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::LinkedBankAccount]
+      required :data, -> { Straddle::LinkedBankAccount }
+
+      # @!attribute event_id
+      #   Unique identifier for this event.
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_type
+      #   Type of this event.
+      #
+      #   @return [String]
+      required :event_type, String
+
+      # @!method initialize(account_id:, data:, event_id:, event_type:)
+      #   @param account_id [String] Unique identifier for the account associated with this event.
+      #
+      #   @param data [Straddle::Models::LinkedBankAccount]
+      #
+      #   @param event_id [String] Unique identifier for this event.
+      #
+      #   @param event_type [String] Type of this event.
+    end
+  end
+end

data/lib/straddle/models/linked_bank_account_list.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::LinkedBankAccounts#list
+    class LinkedBankAccountList < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #   Linked bank accounts returned for this page.
+      #
+      #   @return [Array<Straddle::Models::LinkedBankAccount>]
+      required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::LinkedBankAccount] }
+
+      # @!attribute meta
+      #   Metadata for an API request and a page of results.
+      #
+      #   @return [Straddle::Models::PageMetadata]
+      required :meta, -> { Straddle::PageMetadata }
+
+      # @!attribute response_type
+      #   Indicates how the response content is structured.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of objects.
+      #   - `error` means `error` contains error details.
+      #   - `none` means the response has no data.
+      #
+      #   @return [Symbol, Straddle::Models::LinkedBankAccountList::ResponseType]
+      required :response_type, enum: -> { Straddle::LinkedBankAccountList::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::LinkedBankAccountList} for more details.
+      #
+      #   @param data [Array<Straddle::Models::LinkedBankAccount>] Linked bank accounts returned for this page.
+      #
+      #   @param meta [Straddle::Models::PageMetadata] Metadata for an API request and a page of results.
+      #
+      #   @param response_type [Symbol, Straddle::Models::LinkedBankAccountList::ResponseType] Indicates how the response content is structured.
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      #
+      # @see Straddle::Models::LinkedBankAccountList#response_type
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        OBJECT = :object
+        ARRAY = :array
+        ERROR = :error
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/linked_bank_account_list_params.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::LinkedBankAccounts#list
+    class LinkedBankAccountListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Account ID used to filter the results.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute level
+      #   Scope of linked bank accounts to return.
+      #
+      #   @return [Symbol, Straddle::Models::LinkedBankAccountListParams::Level, nil]
+      optional :level, enum: -> { Straddle::LinkedBankAccountListParams::Level }
+
+      # @!attribute page_number
+      #   Page number. Defaults to `1`.
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute purpose
+      #   Linked bank account purpose. Accepted values are `charges`, `payouts`, and
+      #   `billing`.
+      #
+      #   @return [Symbol, Straddle::Models::LinkedBankAccountListParams::Purpose, nil]
+      optional :purpose, enum: -> { Straddle::LinkedBankAccountListParams::Purpose }
+
+      # @!attribute sort_by
+      #   Field used to sort results. Defaults to `id`.
+      #
+      #   @return [String, nil]
+      optional :sort_by, String
+
+      # @!attribute sort_order
+      #   Sort direction. Defaults to `asc`.
+      #
+      #   @return [Symbol, Straddle::Models::LinkedBankAccountListParams::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::LinkedBankAccountListParams::SortOrder }
+
+      # @!attribute status
+      #   Linked bank account status. Accepted values are `created`, `onboarding`,
+      #   `active`, `rejected`, `inactive`, and `canceled`.
+      #
+      #   @return [Symbol, Straddle::Models::LinkedBankAccountListParams::Status, nil]
+      optional :status, enum: -> { Straddle::LinkedBankAccountListParams::Status }
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!method initialize(account_id: nil, level: nil, page_number: nil, page_size: nil, purpose: nil, sort_by: nil, sort_order: nil, status: nil, correlation_id: nil, request_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::LinkedBankAccountListParams} for more details.
+      #
+      #   @param account_id [String] Account ID used to filter the results.
+      #
+      #   @param level [Symbol, Straddle::Models::LinkedBankAccountListParams::Level] Scope of linked bank accounts to return.
+      #
+      #   @param page_number [Integer] Page number. Defaults to `1`.
+      #
+      #   @param page_size [Integer] Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      #   @param purpose [Symbol, Straddle::Models::LinkedBankAccountListParams::Purpose] Linked bank account purpose. Accepted values are `charges`, `payouts`, and `bill
+      #
+      #   @param sort_by [String] Field used to sort results. Defaults to `id`.
+      #
+      #   @param sort_order [Symbol, Straddle::Models::LinkedBankAccountListParams::SortOrder] Sort direction. Defaults to `asc`.
+      #
+      #   @param status [Symbol, Straddle::Models::LinkedBankAccountListParams::Status] Linked bank account status. Accepted values are `created`, `onboarding`, `active
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+      module Level
+        extend Straddle::Internal::Type::Enum
+
+        ACCOUNT = :account
+        PLATFORM = :platform
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Purpose
+        extend Straddle::Internal::Type::Enum
+
+        CHARGES = :charges
+        PAYOUTS = :payouts
+        BILLING = :billing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        CREATED = :created
+        ONBOARDING = :onboarding
+        ACTIVE = :active
+        REJECTED = :rejected
+        INACTIVE = :inactive
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end