straddle 0.5.0 → 1.0.0

data/lib/straddle/models/linked_bank_account_list_unmasked_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::LinkedBankAccounts#list_unmasked
+    class LinkedBankAccountListUnmaskedParams < 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 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, 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 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_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::LinkedBankAccounts#create
+    class LinkedBankAccountResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::LinkedBankAccount]
+      required :data, -> { Straddle::LinkedBankAccount }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!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::LinkedBankAccountResponse::ResponseType]
+      required :response_type, enum: -> { Straddle::LinkedBankAccountResponse::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::LinkedBankAccountResponse} for more details.
+      #
+      #   @param data [Straddle::Models::LinkedBankAccount]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::LinkedBankAccountResponse::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::LinkedBankAccountResponse#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_retrieve_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::LinkedBankAccounts#retrieve
+    class LinkedBankAccountRetrieveParams < 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 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, 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 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_status_detail.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class LinkedBankAccountStatusDetail < Straddle::Internal::Type::BaseModel
+      # @!attribute code
+      #   Machine-readable status code from the source.
+      #
+      #   @return [String]
+      required :code, String
+
+      # @!attribute message
+      #   Human-readable description of the linked bank account's status.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute reason
+      #   Machine-readable reason for the linked bank account's status.
+      #
+      #   @return [Symbol, Straddle::Models::LinkedBankAccountStatusDetail::Reason]
+      required :reason, enum: -> { Straddle::LinkedBankAccountStatusDetail::Reason }
+
+      # @!attribute source
+      #   System that produced the linked bank account status detail.
+      #
+      #   @return [Symbol, Straddle::Models::LinkedBankAccountStatusDetail::Source]
+      required :source, enum: -> { Straddle::LinkedBankAccountStatusDetail::Source }
+
+      # @!method initialize(code:, message:, reason:, source:)
+      #   @param code [String] Machine-readable status code from the source.
+      #
+      #   @param message [String] Human-readable description of the linked bank account's status.
+      #
+      #   @param reason [Symbol, Straddle::Models::LinkedBankAccountStatusDetail::Reason] Machine-readable reason for the linked bank account's status.
+      #
+      #   @param source [Symbol, Straddle::Models::LinkedBankAccountStatusDetail::Source] System that produced the linked bank account status detail.
+
+      # Machine-readable reason for the linked bank account's status.
+      #
+      # @see Straddle::Models::LinkedBankAccountStatusDetail#reason
+      module Reason
+        extend Straddle::Internal::Type::Enum
+
+        UNVERIFIED = :unverified
+        IN_REVIEW = :in_review
+        PENDING = :pending
+        STUCK = :stuck
+        VERIFIED = :verified
+        FAILED_VERIFICATION = :failed_verification
+        DISABLED = :disabled
+        NEW = :new
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # System that produced the linked bank account status detail.
+      #
+      # @see Straddle::Models::LinkedBankAccountStatusDetail#source
+      module Source
+        extend Straddle::Internal::Type::Enum
+
+        WATCHTOWER = :watchtower
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/linked_bank_account_update_params.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::LinkedBankAccounts#update
+    class LinkedBankAccountUpdateParams < 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 bank_account
+      #
+      #   @return [Straddle::Models::LinkedBankAccountUpdateParams::BankAccount]
+      required :bank_account, -> { Straddle::LinkedBankAccountUpdateParams::BankAccount }
+
+      # @!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 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:, bank_account:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   @param linked_bank_account_id [String]
+      #
+      #   @param bank_account [Straddle::Models::LinkedBankAccountUpdateParams::BankAccount]
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 user-defined key-value pairs.
+      #
+      #   @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::LinkedBankAccountUpdateParams::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
+    end
+  end
+end

data/lib/straddle/models/masked_customer_device.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class MaskedCustomerDevice < Straddle::Internal::Type::BaseModel
+      # @!attribute ip_address
+      #   Masked IP address of the customer's device at the time of profile creation.
+      #
+      #   @return [String]
+      required :ip_address, String
+
+      # @!method initialize(ip_address:)
+      #   @param ip_address [String] Masked IP address of the customer's device at the time of profile creation.
+    end
+  end
+end

data/lib/straddle/models/masked_linked_bank_account_details.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class MaskedLinkedBankAccountDetails < Straddle::Internal::Type::BaseModel
+      # @!attribute account_holder
+      #   Name of the account holder as it appears on the bank account.
+      #
+      #   @return [String]
+      required :account_holder, String
+
+      # @!attribute account_mask
+      #   Last four digits of the bank account number.
+      #
+      #   @return [String]
+      required :account_mask, String
+
+      # @!attribute institution_name
+      #   Name of the financial institution.
+      #
+      #   @return [String]
+      required :institution_name, String
+
+      # @!attribute routing_number
+      #   Nine-digit ABA routing number for the bank account.
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!method initialize(account_holder:, account_mask:, institution_name:, routing_number:)
+      #   @param account_holder [String] Name of the account holder as it appears on the bank account.
+      #
+      #   @param account_mask [String] Last four digits of the bank account number.
+      #
+      #   @param institution_name [String] Name of the financial institution.
+      #
+      #   @param routing_number [String] Nine-digit ABA routing number for the bank account.
+    end
+  end
+end

data/lib/straddle/models/masked_payment_device.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class MaskedPaymentDevice < Straddle::Internal::Type::BaseModel
+      # @!attribute ip_address
+      #   Masked IP address of the device used when the customer authorized the charge or
+      #   payout.
+      #
+      #   @return [String]
+      required :ip_address, String
+
+      # @!method initialize(ip_address:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::MaskedPaymentDevice} for more details.
+      #
+      #   @param ip_address [String] Masked IP address of the device used when the customer authorized the charge or
+    end
+  end
+end

data/lib/straddle/models/organization.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class Organization < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Straddle's unique ID for the organization.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Date and time when Straddle created the organization.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute name
+      #   The name of the organization.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute updated_at
+      #   Date and time of the most recent organization update.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute external_id
+      #   Your unique ID for the organization.
+      #
+      #   @return [String, nil]
+      optional :external_id, 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
+
+      # @!method initialize(id:, created_at:, name:, updated_at:, external_id: nil, metadata: nil)
+      #   @param id [String] Straddle's unique ID for the organization.
+      #
+      #   @param created_at [Time] Date and time when Straddle created the organization.
+      #
+      #   @param name [String] The name of the organization.
+      #
+      #   @param updated_at [Time] Date and time of the most recent organization update.
+      #
+      #   @param external_id [String, nil] Your unique ID for the organization.
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 user-defined key-value pairs.
+    end
+  end
+end

data/lib/straddle/models/organization_create_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Organizations#create
+    class OrganizationCreateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   Organization name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute external_id
+      #   Your unique ID for the organization.
+      #
+      #   @return [String, nil]
+      optional :external_id, 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 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(name:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   @param name [String] Organization name.
+      #
+      #   @param external_id [String, nil] Your unique ID for the organization.
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 user-defined key-value pairs.
+      #
+      #   @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/organization_list.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Organizations#list
+    class OrganizationList < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #   Organizations returned for this page.
+      #
+      #   @return [Array<Straddle::Models::Organization>]
+      required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::Organization] }
+
+      # @!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::OrganizationList::ResponseType]
+      required :response_type, enum: -> { Straddle::OrganizationList::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::OrganizationList} for more details.
+      #
+      #   @param data [Array<Straddle::Models::Organization>] Organizations 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::OrganizationList::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::OrganizationList#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/organization_list_params.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Organizations#list
+    class OrganizationListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute external_id
+      #   Your external ID for the organization.
+      #
+      #   @return [String, nil]
+      optional :external_id, String
+
+      # @!attribute name
+      #   Organization name. Supports partial matches.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!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 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::OrganizationListParams::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::OrganizationListParams::SortOrder }
+
+      # @!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(external_id: nil, name: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {})
+      #   @param external_id [String] Your external ID for the organization.
+      #
+      #   @param name [String] Organization name. Supports partial matches.
+      #
+      #   @param page_number [Integer] Page number. Defaults to `1`.
+      #
+      #   @param page_size [Integer] Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      #   @param sort_by [String] Field used to sort results. Defaults to `id`.
+      #
+      #   @param sort_order [Symbol, Straddle::Models::OrganizationListParams::SortOrder] Sort direction. Defaults to `asc`.
+      #
+      #   @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 SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end