straddle 0.5.0 → 1.0.0

data/lib/straddle/models/account_update_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Accounts#update
+    class AccountUpdateParams < 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 business_profile
+      #
+      #   @return [Straddle::Models::AccountBusinessProfile]
+      required :business_profile, -> { Straddle::AccountBusinessProfile }
+
+      # @!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(account_id:, business_profile:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   @param account_id [String]
+      #
+      #   @param business_profile [Straddle::Models::AccountBusinessProfile]
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/straddle/models/balance_check_mode.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module BalanceCheckMode
+      extend Straddle::Internal::Type::Enum
+
+      REQUIRED = :required
+      ENABLED = :enabled
+      DISABLED = :disabled
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/bridge_create_bank_account_paykey_params.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Bridge#create_bank_account_paykey
+    class BridgeCreateBankAccountPaykeyParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_number
+      #   Bank account number.
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!attribute account_type
+      #
+      #   @return [Symbol, Straddle::Models::AccountType]
+      required :account_type, enum: -> { Straddle::AccountType }
+
+      # @!attribute customer_id
+      #   Unique identifier for the customer associated with the paykey.
+      #
+      #   @return [String]
+      required :customer_id, String
+
+      # @!attribute routing_number
+      #   Bank routing number.
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::PaykeyConfiguration, nil]
+      optional :config, -> { Straddle::PaykeyConfiguration }
+
+      # @!attribute external_id
+      #   Unique identifier for the paykey in your system.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], 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
+
+      # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(account_number:, account_type:, customer_id:, routing_number:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param account_number [String] Bank account number.
+      #
+      #   @param account_type [Symbol, Straddle::Models::AccountType]
+      #
+      #   @param customer_id [String] Unique identifier for the customer associated with the paykey.
+      #
+      #   @param routing_number [String] Bank routing number.
+      #
+      #   @param config [Straddle::Models::PaykeyConfiguration]
+      #
+      #   @param external_id [String, nil] Unique identifier for the paykey in your system.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @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 straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/bridge_create_plaid_paykey_params.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Bridge#create_plaid_paykey
+    class BridgeCreatePlaidPaykeyParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute customer_id
+      #   Unique identifier for the customer associated with the paykey.
+      #
+      #   @return [String]
+      required :customer_id, String
+
+      # @!attribute plaid_token
+      #   Plaid processor token generated by your application for use with the Straddle
+      #   API.
+      #
+      #   @return [String]
+      required :plaid_token, String
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::PaykeyConfiguration, nil]
+      optional :config, -> { Straddle::PaykeyConfiguration }
+
+      # @!attribute external_id
+      #   Unique identifier for the paykey in your system.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], 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
+
+      # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(customer_id:, plaid_token:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::BridgeCreatePlaidPaykeyParams} for more details.
+      #
+      #   @param customer_id [String] Unique identifier for the customer associated with the paykey.
+      #
+      #   @param plaid_token [String] Plaid processor token generated by your application for use with the Straddle AP
+      #
+      #   @param config [Straddle::Models::PaykeyConfiguration]
+      #
+      #   @param external_id [String, nil] Unique identifier for the paykey in your system.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @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 straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/bridge_create_quiltt_paykey_params.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Bridge#create_quiltt_paykey
+    class BridgeCreateQuilttPaykeyParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute customer_id
+      #   Unique identifier for the customer associated with the paykey.
+      #
+      #   @return [String]
+      required :customer_id, String
+
+      # @!attribute quiltt_token
+      #   Quiltt processor token generated by your application for use with the Straddle
+      #   API.
+      #
+      #   @return [String]
+      required :quiltt_token, String
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::PaykeyConfiguration, nil]
+      optional :config, -> { Straddle::PaykeyConfiguration }
+
+      # @!attribute external_id
+      #   Unique identifier for the paykey in your system.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], 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
+
+      # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(customer_id:, quiltt_token:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::BridgeCreateQuilttPaykeyParams} for more details.
+      #
+      #   @param customer_id [String] Unique identifier for the customer associated with the paykey.
+      #
+      #   @param quiltt_token [String] Quiltt processor token generated by your application for use with the Straddle A
+      #
+      #   @param config [Straddle::Models::PaykeyConfiguration]
+      #
+      #   @param external_id [String, nil] Unique identifier for the paykey in your system.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @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 straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/bridge_create_token_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Bridge#create_token
+    class BridgeCreateTokenParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute customer_id
+      #   Unique identifier for the customer associated with the Bridge session.
+      #
+      #   @return [String]
+      required :customer_id, String
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::PaykeyConfiguration, nil]
+      optional :config, -> { Straddle::PaykeyConfiguration }
+
+      # @!attribute external_id
+      #   Unique identifier for the paykey in your system.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, 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
+
+      # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(customer_id:, config: nil, external_id: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param customer_id [String] Unique identifier for the customer associated with the Bridge session.
+      #
+      #   @param config [Straddle::Models::PaykeyConfiguration]
+      #
+      #   @param external_id [String, nil] Unique identifier for the paykey in your system.
+      #
+      #   @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 straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/bridge_token.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class BridgeToken < Straddle::Internal::Type::BaseModel
+      # @!attribute bridge_token
+      #   JSON Web Token (JWT) for the Bridge widget.
+      #
+      #   @return [String]
+      required :bridge_token, String
+
+      # @!method initialize(bridge_token:)
+      #   @param bridge_token [String] JSON Web Token (JWT) for the Bridge widget.
+    end
+  end
+end

data/lib/straddle/models/bridge_token_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Bridge#create_token
+    class BridgeTokenResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::BridgeToken]
+      required :data, -> { Straddle::BridgeToken }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!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::BridgeTokenResponse} for more details.
+      #
+      #   @param data [Straddle::Models::BridgeToken]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::ResponseType] Shape of the response envelope.
+    end
+  end
+end

data/lib/straddle/models/business_customer_representative.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class BusinessCustomerRepresentative < Straddle::Internal::Type::BaseModel
+      # @!attribute name
+      #   Full name of the representative.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute email
+      #   Email address of the representative.
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute phone
+      #   Phone number of the representative.
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!method initialize(name:, email: nil, phone: nil)
+      #   @param name [String] Full name of the representative.
+      #
+      #   @param email [String, nil] Email address of the representative.
+      #
+      #   @param phone [String, nil] Phone number of the representative.
+    end
+  end
+end

data/lib/straddle/models/capability_request.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class CapabilityRequest < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Straddle's unique ID for the capability request.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   ID of the account associated with the capability request.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute category
+      #   Groups the requested capability. `payment_type` covers `charges` and `payouts`.
+      #   `customer_type` covers `individuals` and `businesses`. `consent_type` covers
+      #   `signed_agreement` and `internet` authorization.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequest::Category]
+      required :category, enum: -> { Straddle::CapabilityRequest::Category }
+
+      # @!attribute created_at
+      #   Date and time when Straddle created the capability request.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute enable
+      #   Whether the request enables or disables the capability.
+      #
+      #   @return [Boolean]
+      required :enable, Straddle::Internal::Type::Boolean
+
+      # @!attribute status
+      #   Status of the capability request.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequest::Status]
+      required :status, enum: -> { Straddle::CapabilityRequest::Status }
+
+      # @!attribute type
+      #   Capability type requested within the category.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequest::Type]
+      required :type, enum: -> { Straddle::CapabilityRequest::Type }
+
+      # @!attribute updated_at
+      #   Date and time of the most recent capability request update.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute settings
+      #   Limits and other settings requested for the capability.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :settings, Straddle::Internal::Type::HashOf[Straddle::Internal::Type::Unknown], nil?: true
+
+      # @!method initialize(id:, account_id:, category:, created_at:, enable:, status:, type:, updated_at:, settings: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::CapabilityRequest} for more details.
+      #
+      #   @param id [String] Straddle's unique ID for the capability request.
+      #
+      #   @param account_id [String] ID of the account associated with the capability request.
+      #
+      #   @param category [Symbol, Straddle::Models::CapabilityRequest::Category] Groups the requested capability. `payment_type` covers `charges` and `payouts`.
+      #
+      #   @param created_at [Time] Date and time when Straddle created the capability request.
+      #
+      #   @param enable [Boolean] Whether the request enables or disables the capability.
+      #
+      #   @param status [Symbol, Straddle::Models::CapabilityRequest::Status] Status of the capability request.
+      #
+      #   @param type [Symbol, Straddle::Models::CapabilityRequest::Type] Capability type requested within the category.
+      #
+      #   @param updated_at [Time] Date and time of the most recent capability request update.
+      #
+      #   @param settings [Hash{Symbol=>Object}, nil] Limits and other settings requested for the capability.
+
+      # Groups the requested capability. `payment_type` covers `charges` and `payouts`.
+      # `customer_type` covers `individuals` and `businesses`. `consent_type` covers
+      # `signed_agreement` and `internet` authorization.
+      #
+      # @see Straddle::Models::CapabilityRequest#category
+      module Category
+        extend Straddle::Internal::Type::Enum
+
+        PAYMENT_TYPE = :payment_type
+        CUSTOMER_TYPE = :customer_type
+        CONSENT_TYPE = :consent_type
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of the capability request.
+      #
+      # @see Straddle::Models::CapabilityRequest#status
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+        IN_REVIEW = :in_review
+        REJECTED = :rejected
+        APPROVED = :approved
+        REVIEWING = :reviewing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Capability type requested within the category.
+      #
+      # @see Straddle::Models::CapabilityRequest#type
+      module Type
+        extend Straddle::Internal::Type::Enum
+
+        CHARGES = :charges
+        PAYOUTS = :payouts
+        INDIVIDUALS = :individuals
+        BUSINESSES = :businesses
+        SIGNED_AGREEMENT = :signed_agreement
+        INTERNET = :internet
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end