straddle 0.5.0 → 1.0.0

data/lib/straddle/models/report_create_total_customers_by_status_response.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    # @see Straddle::Resources::Reports#create_total_customers_by_status
-    class ReportCreateTotalCustomersByStatusResponse < Straddle::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data]
-      required :data, -> { Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data }
-
-      # @!attribute meta
-      #   Metadata about the API request, including an identifier and timestamp.
-      #
-      #   @return [Straddle::Models::ResponseMetadata]
-      required :meta, -> { Straddle::ResponseMetadata }
-
-      # @!attribute response_type
-      #   Indicates the structure of the returned content.
-      #
-      #   - "object" means the `data` field contains a single JSON object.
-      #   - "array" means the `data` field contains an array of objects.
-      #   - "error" means the `data` field contains an error object with details of the
-      #     issue.
-      #   - "none" means no data is returned.
-      #
-      #   @return [Symbol, Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType]
-      required :response_type,
-               enum: -> { Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType }
-
-      # @!method initialize(data:, meta:, response_type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Straddle::Models::ReportCreateTotalCustomersByStatusResponse} for more details.
-      #
-      #   @param data [Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data]
-      #
-      #   @param meta [Straddle::Models::ResponseMetadata] Metadata about the API request, including an identifier and timestamp.
-      #
-      #   @param response_type [Symbol, Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType] Indicates the structure of the returned content.
-
-      # @see Straddle::Models::ReportCreateTotalCustomersByStatusResponse#data
-      class Data < Straddle::Internal::Type::BaseModel
-        # @!attribute inactive
-        #
-        #   @return [Integer]
-        required :inactive, Integer
-
-        # @!attribute pending
-        #
-        #   @return [Integer]
-        required :pending, Integer
-
-        # @!attribute rejected
-        #
-        #   @return [Integer]
-        required :rejected, Integer
-
-        # @!attribute review
-        #
-        #   @return [Integer]
-        required :review, Integer
-
-        # @!attribute verified
-        #
-        #   @return [Integer]
-        required :verified, Integer
-
-        # @!method initialize(inactive:, pending:, rejected:, review:, verified:)
-        #   @param inactive [Integer]
-        #   @param pending [Integer]
-        #   @param rejected [Integer]
-        #   @param review [Integer]
-        #   @param verified [Integer]
-      end
-
-      # Indicates the structure of the returned content.
-      #
-      # - "object" means the `data` field contains a single JSON object.
-      # - "array" means the `data` field contains an array of objects.
-      # - "error" means the `data` field contains an error object with details of the
-      #   issue.
-      # - "none" means no data is returned.
-      #
-      # @see Straddle::Models::ReportCreateTotalCustomersByStatusResponse#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/status_details_v1.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    class StatusDetailsV1 < Straddle::Internal::Type::BaseModel
-      # @!attribute changed_at
-      #   The time the status change occurred.
-      #
-      #   @return [Time]
-      required :changed_at, Time
-
-      # @!attribute message
-      #   A human-readable description of the current status.
-      #
-      #   @return [String]
-      required :message, String
-
-      # @!attribute reason
-      #   A machine-readable identifier for the specific status, useful for programmatic
-      #   handling.
-      #
-      #   @return [Symbol, Straddle::Models::StatusDetailsV1::Reason]
-      required :reason, enum: -> { Straddle::StatusDetailsV1::Reason }
-
-      # @!attribute source
-      #   Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
-      #   This helps in tracking the cause of status updates.
-      #
-      #   @return [Symbol, Straddle::Models::StatusDetailsV1::Source]
-      required :source, enum: -> { Straddle::StatusDetailsV1::Source }
-
-      # @!attribute code
-      #   The status code if applicable.
-      #
-      #   @return [String, nil]
-      optional :code, String, nil?: true
-
-      # @!method initialize(changed_at:, message:, reason:, source:, code: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Straddle::Models::StatusDetailsV1} for more details.
-      #
-      #   @param changed_at [Time] The time the status change occurred.
-      #
-      #   @param message [String] A human-readable description of the current status.
-      #
-      #   @param reason [Symbol, Straddle::Models::StatusDetailsV1::Reason] A machine-readable identifier for the specific status, useful for programmatic h
-      #
-      #   @param source [Symbol, Straddle::Models::StatusDetailsV1::Source] Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
-      #
-      #   @param code [String, nil] The status code if applicable.
-
-      # A machine-readable identifier for the specific status, useful for programmatic
-      # handling.
-      #
-      # @see Straddle::Models::StatusDetailsV1#reason
-      module Reason
-        extend Straddle::Internal::Type::Enum
-
-        INSUFFICIENT_FUNDS = :insufficient_funds
-        CLOSED_BANK_ACCOUNT = :closed_bank_account
-        INVALID_BANK_ACCOUNT = :invalid_bank_account
-        INVALID_ROUTING = :invalid_routing
-        DISPUTED = :disputed
-        PAYMENT_STOPPED = :payment_stopped
-        OWNER_DECEASED = :owner_deceased
-        FROZEN_BANK_ACCOUNT = :frozen_bank_account
-        RISK_REVIEW = :risk_review
-        FRAUDULENT = :fraudulent
-        DUPLICATE_ENTRY = :duplicate_entry
-        INVALID_PAYKEY = :invalid_paykey
-        PAYMENT_BLOCKED = :payment_blocked
-        AMOUNT_TOO_LARGE = :amount_too_large
-        TOO_MANY_ATTEMPTS = :too_many_attempts
-        INTERNAL_SYSTEM_ERROR = :internal_system_error
-        USER_REQUEST = :user_request
-        OK = :ok
-        OTHER_NETWORK_RETURN = :other_network_return
-        PAYOUT_REFUSED = :payout_refused
-        CANCEL_REQUEST = :cancel_request
-        FAILED_VERIFICATION = :failed_verification
-        REQUIRE_REVIEW = :require_review
-        BLOCKED_BY_SYSTEM = :blocked_by_system
-        WATCHTOWER_REVIEW = :watchtower_review
-        VALIDATING = :validating
-        AUTO_HOLD = :auto_hold
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
-      # This helps in tracking the cause of status updates.
-      #
-      # @see Straddle::Models::StatusDetailsV1#source
-      module Source
-        extend Straddle::Internal::Type::Enum
-
-        WATCHTOWER = :watchtower
-        BANK_DECLINE = :bank_decline
-        CUSTOMER_DISPUTE = :customer_dispute
-        USER_ACTION = :user_action
-        SYSTEM = :system
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/straddle/resources/bridge/link.rb

@@ -1,230 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Resources
-    class Bridge
-      # Bridge provides a comprehensive suite of tools for connecting customer bank
-      # accounts. Use it to generate secure widget sessions for instant account
-      # verification, accept tokens from major providers like Plaid and Finicity, or
-      # verify accounts directly via our API. Bridge handles all sensitive banking
-      # credentials and ensures secure, compliant connections with support for 90% of US
-      # bank accounts.
-      class Link
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Bridge::LinkBankAccountParams} for more details.
-        #
-        # Use Bridge to create a new paykey using a bank routing and account number as the
-        # source. This endpoint allows you to create a secure payment token linked to a
-        # specific bank account.
-        #
-        # @overload bank_account(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] Body param: The bank account number.
-        #
-        # @param account_type [Symbol, Straddle::Models::Bridge::LinkBankAccountParams::AccountType] Body param
-        #
-        # @param customer_id [String] Body param: Unique identifier of the related customer object.
-        #
-        # @param routing_number [String] Body param: The routing number of the bank account.
-        #
-        # @param config [Straddle::Models::Bridge::LinkBankAccountParams::Config] Body param
-        #
-        # @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
-        #
-        # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
-        #
-        # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
-        #
-        # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
-        #
-        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::PaykeyV1]
-        #
-        # @see Straddle::Models::Bridge::LinkBankAccountParams
-        def bank_account(params)
-          parsed, options = Straddle::Bridge::LinkBankAccountParams.dump_request(params)
-          header_params =
-            {
-              correlation_id: "correlation-id",
-              idempotency_key: "idempotency-key",
-              request_id: "request-id",
-              straddle_account_id: "straddle-account-id"
-            }
-          @client.request(
-            method: :post,
-            path: "v1/bridge/bank_account",
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::PaykeyV1,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Bridge::LinkCreatePaykeyParams} for more details.
-        #
-        # Creates a new paykey using a Quiltt token as the source. This endpoint allows
-        # you to create a secure payment token linked to a bank account authenticated
-        # through Quiltt.
-        #
-        # @overload create_paykey(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: {})
-        #
-        # @param customer_id [String] Body param: Unique identifier of the related customer object.
-        #
-        # @param quiltt_token [String] Body param: Quiltt processor token generated by your application for use with th
-        #
-        # @param config [Straddle::Models::Bridge::LinkCreatePaykeyParams::Config] Body param
-        #
-        # @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
-        #
-        # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
-        #
-        # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
-        #
-        # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
-        #
-        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::Bridge::LinkCreatePaykeyResponse]
-        #
-        # @see Straddle::Models::Bridge::LinkCreatePaykeyParams
-        def create_paykey(params)
-          parsed, options = Straddle::Bridge::LinkCreatePaykeyParams.dump_request(params)
-          header_params =
-            {
-              correlation_id: "correlation-id",
-              idempotency_key: "idempotency-key",
-              request_id: "request-id",
-              straddle_account_id: "straddle-account-id"
-            }
-          @client.request(
-            method: :post,
-            path: "v1/bridge/quiltt",
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Models::Bridge::LinkCreatePaykeyResponse,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Bridge::LinkCreateTanParams} for more details.
-        #
-        # @overload create_tan(account_type:, customer_id:, routing_number:, tan:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
-        #
-        # @param account_type [Symbol, Straddle::Models::Bridge::LinkCreateTanParams::AccountType] Body param
-        #
-        # @param customer_id [String] Body param: Unique identifier of the related customer object.
-        #
-        # @param routing_number [String] Body param: Bank routing number.
-        #
-        # @param tan [String] Body param: Tokenized account number.
-        #
-        # @param config [Straddle::Models::Bridge::LinkCreateTanParams::Config] Body param
-        #
-        # @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
-        #
-        # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
-        #
-        # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
-        #
-        # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
-        #
-        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::Bridge::LinkCreateTanResponse]
-        #
-        # @see Straddle::Models::Bridge::LinkCreateTanParams
-        def create_tan(params)
-          parsed, options = Straddle::Bridge::LinkCreateTanParams.dump_request(params)
-          header_params =
-            {
-              correlation_id: "correlation-id",
-              idempotency_key: "idempotency-key",
-              request_id: "request-id",
-              straddle_account_id: "straddle-account-id"
-            }
-          @client.request(
-            method: :post,
-            path: "v1/bridge/tan",
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Models::Bridge::LinkCreateTanResponse,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Bridge::LinkPlaidParams} for more details.
-        #
-        # Use Bridge to create a new paykey using a Plaid token as the source. This
-        # endpoint allows you to create a secure payment token linked to a bank account
-        # authenticated through Plaid.
-        #
-        # @overload plaid(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: {})
-        #
-        # @param customer_id [String] Body param: Unique identifier of the related customer object.
-        #
-        # @param plaid_token [String] Body param: Plaid processor token generated by your application for use with the
-        #
-        # @param config [Straddle::Models::Bridge::LinkPlaidParams::Config] Body param
-        #
-        # @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
-        #
-        # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
-        #
-        # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
-        #
-        # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
-        #
-        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::PaykeyV1]
-        #
-        # @see Straddle::Models::Bridge::LinkPlaidParams
-        def plaid(params)
-          parsed, options = Straddle::Bridge::LinkPlaidParams.dump_request(params)
-          header_params =
-            {
-              correlation_id: "correlation-id",
-              idempotency_key: "idempotency-key",
-              request_id: "request-id",
-              straddle_account_id: "straddle-account-id"
-            }
-          @client.request(
-            method: :post,
-            path: "v1/bridge/plaid",
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::PaykeyV1,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [Straddle::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/straddle/resources/embed/accounts/capability_requests.rb

@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Resources
-    class Embed
-      class Accounts
-        # Capabilities enable specific features and services for an Account. Use
-        # capability requests to unlock higher processing limits, new payment types, or
-        # additional platform features as your users' businesses grow. Track approval
-        # status and manage documentation requirements through a single interface.
-        class CapabilityRequests
-          # Some parameter documentations has been truncated, see
-          # {Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams} for more
-          # details.
-          #
-          # Submits a request to enable a specific capability for an account. Use this
-          # endpoint to request additional features or services for an account.
-          #
-          # @overload create(account_id, businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
-          #
-          # @param account_id [String] Path param
-          #
-          # @param businesses [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Businesses] Body param: Allows the account to accept payments from businesses.
-          #
-          # @param charges [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Charges] Body param: The charges capability settings for the account.
-          #
-          # @param individuals [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Individuals] Body param: Allows the account to accept payments from individuals.
-          #
-          # @param internet [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Internet] Body param: Allows the account to accept payments authorized via the internet or
-          #
-          # @param payouts [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Payouts] Body param: The payouts capability settings for the account.
-          #
-          # @param signed_agreement [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::SignedAgreement] Body param: Allows the account to accept payments authorized by signed agreement
-          #
-          # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-          #
-          # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
-          #
-          # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
-          #
-          # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1]
-          #
-          # @see Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams
-          def create(account_id, params = {})
-            parsed, options = Straddle::Embed::Accounts::CapabilityRequestCreateParams.dump_request(params)
-            header_params =
-              {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
-            @client.request(
-              method: :post,
-              path: ["v1/accounts/%1$s/capability_requests", account_id],
-              headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-              body: parsed.except(*header_params.keys),
-              model: Straddle::Embed::Accounts::CapabilityRequestPagedV1,
-              options: options
-            )
-          end
-
-          # Some parameter documentations has been truncated, see
-          # {Straddle::Models::Embed::Accounts::CapabilityRequestListParams} for more
-          # details.
-          #
-          # Retrieves a list of capability requests associated with an account. The requests
-          # are returned sorted by creation date, with the most recent requests appearing
-          # first. This endpoint supports advanced sorting and filtering options.
-          #
-          # @overload list(account_id, category: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
-          #
-          # @param account_id [String] Path param
-          #
-          # @param category [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Category] Query param: Filter capability requests by category.
-          #
-          # @param page_number [Integer] Query param: Results page number. Starts at page 1.
-          #
-          # @param page_size [Integer] Query param: Page size.Max value: 1000
-          #
-          # @param sort_by [String] Query param: Sort By.
-          #
-          # @param sort_order [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::SortOrder] Query param: Sort Order.
-          #
-          # @param status [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Status] Query param: Filter capability requests by their current status.
-          #
-          # @param type [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Type] Query param: Filter capability requests by the specific type of capability.
-          #
-          # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-          #
-          # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
-          #
-          # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [Straddle::Internal::PageNumberSchema<Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data>]
-          #
-          # @see Straddle::Models::Embed::Accounts::CapabilityRequestListParams
-          def list(account_id, params = {})
-            query_params = [:category, :page_number, :page_size, :sort_by, :sort_order, :status, :type]
-            parsed, options = Straddle::Embed::Accounts::CapabilityRequestListParams.dump_request(params)
-            query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
-            @client.request(
-              method: :get,
-              path: ["v1/accounts/%1$s/capability_requests", account_id],
-              query: query,
-              headers: parsed.except(*query_params).transform_keys(
-                correlation_id: "correlation-id",
-                request_id: "request-id"
-              ),
-              page: Straddle::Internal::PageNumberSchema,
-              model: Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data,
-              options: options
-            )
-          end
-
-          # @api private
-          #
-          # @param client [Straddle::Client]
-          def initialize(client:)
-            @client = client
-          end
-        end
-      end
-    end
-  end
-end