straddle 0.5.0 → 1.0.0

data/lib/straddle/models/account_consent_capabilities.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountConsentCapabilities < Straddle::Internal::Type::BaseModel
+      # @!attribute internet
+      #   Internet payment authorization capability for the account.
+      #
+      #   @return [Straddle::Models::AccountCapability]
+      required :internet, -> { Straddle::AccountCapability }
+
+      # @!attribute signed_agreement
+      #   Signed-agreement payment authorization capability for the account.
+      #
+      #   @return [Straddle::Models::AccountCapability]
+      required :signed_agreement, -> { Straddle::AccountCapability }
+
+      # @!method initialize(internet:, signed_agreement:)
+      #   @param internet [Straddle::Models::AccountCapability] Internet payment authorization capability for the account.
+      #
+      #   @param signed_agreement [Straddle::Models::AccountCapability] Signed-agreement payment authorization capability for the account.
+    end
+  end
+end

data/lib/straddle/models/account_consent_settings.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountConsentSettings < Straddle::Internal::Type::BaseModel
+      # @!attribute internet
+      #   Status of internet authorization support for the account.
+      #
+      #   @return [Symbol, Straddle::Models::AccountConsentSettings::Internet]
+      required :internet, enum: -> { Straddle::AccountConsentSettings::Internet }
+
+      # @!attribute signed_agreement
+      #   Status of signed-agreement authorization support for the account.
+      #
+      #   @return [Symbol, Straddle::Models::AccountConsentSettings::SignedAgreement]
+      required :signed_agreement, enum: -> { Straddle::AccountConsentSettings::SignedAgreement }
+
+      # @!method initialize(internet:, signed_agreement:)
+      #   @param internet [Symbol, Straddle::Models::AccountConsentSettings::Internet] Status of internet authorization support for the account.
+      #
+      #   @param signed_agreement [Symbol, Straddle::Models::AccountConsentSettings::SignedAgreement] Status of signed-agreement authorization support for the account.
+
+      # Status of internet authorization support for the account.
+      #
+      # @see Straddle::Models::AccountConsentSettings#internet
+      module Internet
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of signed-agreement authorization support for the account.
+      #
+      # @see Straddle::Models::AccountConsentSettings#signed_agreement
+      module SignedAgreement
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_create_params.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Accounts#create
+    class AccountCreateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute access_level
+      #   The account access level. `standard` provides normal account access, including
+      #   access to the Straddle dashboard. `managed` means the platform manages the
+      #   account and account users cannot access the Straddle dashboard.
+      #
+      #   @return [Symbol, Straddle::Models::AccountCreateParams::AccessLevel]
+      required :access_level, enum: -> { Straddle::AccountCreateParams::AccessLevel }
+
+      # @!attribute account_type
+      #   Account type. The only accepted value is `business`.
+      #
+      #   @return [Symbol, Straddle::Models::AccountCreateParams::AccountType]
+      required :account_type, enum: -> { Straddle::AccountCreateParams::AccountType }
+
+      # @!attribute business_profile
+      #
+      #   @return [Straddle::Models::AccountBusinessProfile]
+      required :business_profile, -> { Straddle::AccountBusinessProfile }
+
+      # @!attribute organization_id
+      #   ID of the organization that will own the account.
+      #
+      #   @return [String]
+      required :organization_id, String
+
+      # @!attribute external_id
+      #   Your unique ID for the account.
+      #
+      #   @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(access_level:, account_type:, business_profile:, organization_id:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::AccountCreateParams} for more details.
+      #
+      #   @param access_level [Symbol, Straddle::Models::AccountCreateParams::AccessLevel] The account access level. `standard` provides normal account access, including a
+      #
+      #   @param account_type [Symbol, Straddle::Models::AccountCreateParams::AccountType] Account type. The only accepted value is `business`.
+      #
+      #   @param business_profile [Straddle::Models::AccountBusinessProfile]
+      #
+      #   @param organization_id [String] ID of the organization that will own the account.
+      #
+      #   @param external_id [String, nil] Your unique ID for the account.
+      #
+      #   @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}]
+
+      # The account access level. `standard` provides normal account access, including
+      # access to the Straddle dashboard. `managed` means the platform manages the
+      # account and account users cannot access the Straddle dashboard.
+      module AccessLevel
+        extend Straddle::Internal::Type::Enum
+
+        STANDARD = :standard
+        MANAGED = :managed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Account type. The only accepted value is `business`.
+      module AccountType
+        extend Straddle::Internal::Type::Enum
+
+        BUSINESS = :business
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_created_v1_webhook_event.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountCreatedV1WebhookEvent < 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::Account]
+      required :data, -> { Straddle::Account }
+
+      # @!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::Account]
+      #
+      #   @param event_id [String] Unique identifier for this event.
+      #
+      #   @param event_type [String] Type of this event.
+    end
+  end
+end

data/lib/straddle/models/account_customer_capabilities.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountCustomerCapabilities < Straddle::Internal::Type::BaseModel
+      # @!attribute businesses
+      #
+      #   @return [Straddle::Models::AccountCapability]
+      required :businesses, -> { Straddle::AccountCapability }
+
+      # @!attribute individuals
+      #
+      #   @return [Straddle::Models::AccountCapability]
+      required :individuals, -> { Straddle::AccountCapability }
+
+      # @!method initialize(businesses:, individuals:)
+      #   @param businesses [Straddle::Models::AccountCapability]
+      #   @param individuals [Straddle::Models::AccountCapability]
+    end
+  end
+end

data/lib/straddle/models/account_customer_type_settings.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountCustomerTypeSettings < Straddle::Internal::Type::BaseModel
+      # @!attribute businesses
+      #   Status of business-customer support for the account.
+      #
+      #   @return [Symbol, Straddle::Models::AccountCustomerTypeSettings::Businesses]
+      required :businesses, enum: -> { Straddle::AccountCustomerTypeSettings::Businesses }
+
+      # @!attribute individuals
+      #   Status of individual-customer support for the account.
+      #
+      #   @return [Symbol, Straddle::Models::AccountCustomerTypeSettings::Individuals]
+      required :individuals, enum: -> { Straddle::AccountCustomerTypeSettings::Individuals }
+
+      # @!method initialize(businesses:, individuals:)
+      #   @param businesses [Symbol, Straddle::Models::AccountCustomerTypeSettings::Businesses] Status of business-customer support for the account.
+      #
+      #   @param individuals [Symbol, Straddle::Models::AccountCustomerTypeSettings::Individuals] Status of individual-customer support for the account.
+
+      # Status of business-customer support for the account.
+      #
+      # @see Straddle::Models::AccountCustomerTypeSettings#businesses
+      module Businesses
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of individual-customer support for the account.
+      #
+      # @see Straddle::Models::AccountCustomerTypeSettings#individuals
+      module Individuals
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_event_v1_webhook_event.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountEventV1WebhookEvent < 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::Account]
+      required :data, -> { Straddle::Account }
+
+      # @!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::Account]
+      #
+      #   @param event_id [String] Unique identifier for this event.
+      #
+      #   @param event_type [String] Type of this event.
+    end
+  end
+end

data/lib/straddle/models/account_industry.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountIndustry < Straddle::Internal::Type::BaseModel
+      # @!attribute category
+      #   Industry category. Required when `mcc` is omitted.
+      #
+      #   @return [String, nil]
+      optional :category, String, nil?: true
+
+      # @!attribute mcc
+      #   Merchant category code (MCC) that best describes the business. If omitted,
+      #   provide both `sector` and `category`.
+      #
+      #   @return [String, nil]
+      optional :mcc, String, nil?: true
+
+      # @!attribute sector
+      #   Business sector. Required when `mcc` is omitted.
+      #
+      #   @return [String, nil]
+      optional :sector, String, nil?: true
+
+      # @!method initialize(category: nil, mcc: nil, sector: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::AccountIndustry} for more details.
+      #
+      #   @param category [String, nil] Industry category. Required when `mcc` is omitted.
+      #
+      #   @param mcc [String, nil] Merchant category code (MCC) that best describes the business. If omitted, provi
+      #
+      #   @param sector [String, nil] Business sector. Required when `mcc` is omitted.
+    end
+  end
+end

data/lib/straddle/models/account_list.rb

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Accounts#list
+    class AccountListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute external_id
+      #   Your external ID for the account.
+      #
+      #   @return [String, nil]
+      optional :external_id, 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 search_text
+      #   Text to search for across account fields.
+      #
+      #   @return [String, nil]
+      optional :search_text, String
+
+      # @!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::AccountListParams::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::AccountListParams::SortOrder }
+
+      # @!attribute status
+      #   Account status to return.
+      #
+      #   @return [Symbol, Straddle::Models::AccountListParams::Status, nil]
+      optional :status, enum: -> { Straddle::AccountListParams::Status }
+
+      # @!attribute type
+      #   Account type to return.
+      #
+      #   @return [Symbol, Straddle::Models::AccountListParams::Type, nil]
+      optional :type, enum: -> { Straddle::AccountListParams::Type }
+
+      # @!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, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+      #   @param external_id [String] Your external ID for the account.
+      #
+      #   @param page_number [Integer] Page number. Defaults to `1`.
+      #
+      #   @param page_size [Integer] Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      #   @param search_text [String] Text to search for across account fields.
+      #
+      #   @param sort_by [String] Field used to sort results. Defaults to `id`.
+      #
+      #   @param sort_order [Symbol, Straddle::Models::AccountListParams::SortOrder] Sort direction. Defaults to `asc`.
+      #
+      #   @param status [Symbol, Straddle::Models::AccountListParams::Status] Account status to return.
+      #
+      #   @param type [Symbol, Straddle::Models::AccountListParams::Type] Account type to return.
+      #
+      #   @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
+
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        CREATED = :created
+        ONBOARDING = :onboarding
+        ACTIVE = :active
+        REJECTED = :rejected
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Type
+        extend Straddle::Internal::Type::Enum
+
+        BUSINESS = :business
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_onboard_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Accounts#onboard
+    class AccountOnboardParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute terms_of_service
+      #
+      #   @return [Straddle::Models::TermsOfService]
+      required :terms_of_service, -> { Straddle::TermsOfService }
+
+      # @!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(account_id:, terms_of_service:, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   @param account_id [String]
+      #
+      #   @param terms_of_service [Straddle::Models::TermsOfService]
+      #
+      #   @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/account_payment_capabilities.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountPaymentCapabilities < Straddle::Internal::Type::BaseModel
+      # @!attribute charges
+      #
+      #   @return [Straddle::Models::AccountCapability]
+      required :charges, -> { Straddle::AccountCapability }
+
+      # @!attribute payouts
+      #
+      #   @return [Straddle::Models::AccountCapability]
+      required :payouts, -> { Straddle::AccountCapability }
+
+      # @!method initialize(charges:, payouts:)
+      #   @param charges [Straddle::Models::AccountCapability]
+      #   @param payouts [Straddle::Models::AccountCapability]
+    end
+  end
+end

data/lib/straddle/models/account_payment_settings.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountPaymentSettings < Straddle::Internal::Type::BaseModel
+      # @!attribute charges
+      #
+      #   @return [Straddle::Models::AccountChargeSettings]
+      required :charges, -> { Straddle::AccountChargeSettings }
+
+      # @!attribute payouts
+      #
+      #   @return [Straddle::Models::AccountPayoutSettings]
+      required :payouts, -> { Straddle::AccountPayoutSettings }
+
+      # @!method initialize(charges:, payouts:)
+      #   @param charges [Straddle::Models::AccountChargeSettings]
+      #   @param payouts [Straddle::Models::AccountPayoutSettings]
+    end
+  end
+end