straddle 0.5.0 → 1.0.0

data/lib/straddle/models/paykey_list_params.rb

@@ -44,47 +44,51 @@ module Straddle
       optional :search_text, String
 
       # @!attribute sort_by
+      #   Field used to sort the results.
       #
       #   @return [Symbol, Straddle::Models::PaykeyListParams::SortBy, nil]
       optional :sort_by, enum: -> { Straddle::PaykeyListParams::SortBy }
 
       # @!attribute sort_order
+      #   Order in which to sort the results.
       #
-      #   @return [Symbol, Straddle::Models::PaykeyListParams::SortOrder, nil]
-      optional :sort_order, enum: -> { Straddle::PaykeyListParams::SortOrder }
+      #   @return [Symbol, Straddle::Models::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::SortOrder }
 
       # @!attribute source
       #   Filter paykeys by their source.
       #
-      #   @return [Array<Symbol, Straddle::Models::PaykeyListParams::Source>, nil]
-      optional :source, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeyListParams::Source] }
+      #   @return [Array<Symbol, Straddle::Models::PaykeySource>, nil]
+      optional :source, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeySource] }
 
       # @!attribute status
       #   Filter paykeys by their current status.
       #
-      #   @return [Array<Symbol, Straddle::Models::PaykeyListParams::Status>, nil]
-      optional :status, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeyListParams::Status] }
+      #   @return [Array<Symbol, Straddle::Models::PaykeyStatus>, nil]
+      optional :status, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeyStatus] }
 
       # @!attribute unblock_eligible
-      #   Filter paykeys by unblock eligibility. When true, returns only blocked paykeys
-      #   eligible for client-initiated unblocking (blocked due to R29 returns and not
-      #   previously unblocked). When false, returns only blocked paykeys that are not
-      #   eligible for unblocking.
+      #   Filters paykeys by unblock eligibility. `true` returns blocked paykeys that are
+      #   eligible because of an `R29` return and have not been unblocked before. `false`
+      #   returns blocked paykeys that are not eligible.
       #
       #   @return [Boolean, nil]
       optional :unblock_eligible, Straddle::Internal::Type::Boolean
 
       # @!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
 
       # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
       #
       #   @return [String, nil]
       optional :straddle_account_id, String
@@ -105,21 +109,21 @@ module Straddle
       #
       #   @param search_text [String] General search term to filter paykeys.
       #
-      #   @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy]
+      #   @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy] Field used to sort the results.
       #
-      #   @param sort_order [Symbol, Straddle::Models::PaykeyListParams::SortOrder]
+      #   @param sort_order [Symbol, Straddle::Models::SortOrder] Order in which to sort the results.
       #
-      #   @param source [Array<Symbol, Straddle::Models::PaykeyListParams::Source>] Filter paykeys by their source.
+      #   @param source [Array<Symbol, Straddle::Models::PaykeySource>] Filter paykeys by their source.
       #
-      #   @param status [Array<Symbol, Straddle::Models::PaykeyListParams::Status>] Filter paykeys by their current status.
+      #   @param status [Array<Symbol, Straddle::Models::PaykeyStatus>] Filter paykeys by their current status.
       #
-      #   @param unblock_eligible [Boolean] Filter paykeys by unblock eligibility. When true, returns only blocked paykeys e
+      #   @param unblock_eligible [Boolean] Filters paykeys by unblock eligibility. `true` returns blocked paykeys that are
       #
-      #   @param correlation_id [String]
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
       #
-      #   @param request_id [String]
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
       #
-      #   @param straddle_account_id [String]
+      #   @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}]
 
@@ -133,44 +137,6 @@ module Straddle
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      module SortOrder
-        extend Straddle::Internal::Type::Enum
-
-        ASC = :asc
-        DESC = :desc
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      module Source
-        extend Straddle::Internal::Type::Enum
-
-        BANK_ACCOUNT = :bank_account
-        STRADDLE = :straddle
-        MX = :mx
-        PLAID = :plaid
-        TAN = :tan
-        QUILTT = :quiltt
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      module Status
-        extend Straddle::Internal::Type::Enum
-
-        PENDING = :pending
-        ACTIVE = :active
-        INACTIVE = :inactive
-        REJECTED = :rejected
-        REVIEW = :review
-        BLOCKED = :blocked
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/straddle/models/paykey_list_unmasked_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Paykeys#list_unmasked
+    class PaykeyListUnmaskedParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :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
+
+      # @!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(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param 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 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/paykey_processing_mode.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module PaykeyProcessingMode
+      extend Straddle::Internal::Type::Enum
+
+      INLINE = :inline
+      BACKGROUND = :background
+      SKIP = :skip
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/paykey_refresh_balance_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Paykeys#refresh_balance
+    class PaykeyRefreshBalanceParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!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(id:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param 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/paykey_refresh_review_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Paykeys#refresh_review
+    class PaykeyRefreshReviewParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!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(id:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param 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/paykey_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Bridge#create_bank_account_paykey
+    class PaykeyResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::Paykey]
+      required :data, -> { Straddle::Paykey }
+
+      # @!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::PaykeyResponse} for more details.
+      #
+      #   @param data [Straddle::Models::Paykey]
+      #
+      #   @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/paykey_retrieve_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Paykeys#retrieve
+    class PaykeyRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :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
+
+      # @!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(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param 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 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/paykey_reveal_params.rb

@@ -13,25 +13,32 @@ module Straddle
       required :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
 
       # @!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(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #   @param id [String]
-      #   @param correlation_id [String]
-      #   @param request_id [String]
-      #   @param straddle_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 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

data/lib/straddle/models/paykey_source.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module PaykeySource
+      extend Straddle::Internal::Type::Enum
+
+      BANK_ACCOUNT = :bank_account
+      STRADDLE = :straddle
+      MX = :mx
+      PLAID = :plaid
+      TAN = :tan
+      QUILTT = :quiltt
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/paykey_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module PaykeyStatus
+      extend Straddle::Internal::Type::Enum
+
+      PENDING = :pending
+      ACTIVE = :active
+      INACTIVE = :inactive
+      REJECTED = :rejected
+      REVIEW = :review
+      BLOCKED = :blocked
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/paykey_summary.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PaykeySummary < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the paykey.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::PaykeyConfiguration]
+      required :config, -> { Straddle::PaykeyConfiguration }
+
+      # @!attribute created_at
+      #   Timestamp of when the paykey was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute label
+      #   Display label combining the bank name and masked account number.
+      #
+      #   @return [String]
+      required :label, String
+
+      # @!attribute paykey
+      #   Masked paykey value.
+      #
+      #   @return [String]
+      required :paykey, String
+
+      # @!attribute source
+      #
+      #   @return [Symbol, Straddle::Models::PaykeySource]
+      required :source, enum: -> { Straddle::PaykeySource }
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Straddle::Models::PaykeyStatus]
+      required :status, enum: -> { Straddle::PaykeyStatus }
+
+      # @!attribute updated_at
+      #   Timestamp of the most recent update to the paykey.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute bank_data
+      #
+      #   @return [Straddle::Models::PaykeyBankDetails, nil]
+      optional :bank_data, -> { Straddle::PaykeyBankDetails }
+
+      # @!attribute customer_id
+      #   Unique identifier for the customer associated with the paykey.
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute expires_at
+      #   Expiration date and time of the paykey, if applicable.
+      #
+      #   @return [Time, nil]
+      optional :expires_at, Time, nil?: true
+
+      # @!attribute external_id
+      #   Unique identifier for the paykey in your system.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute institution_name
+      #   Name of the financial institution.
+      #
+      #   @return [String, nil]
+      optional :institution_name, String, nil?: true
+
+      # @!attribute status_details
+      #
+      #   @return [Straddle::Models::PaymentStatusDetails, nil]
+      optional :status_details, -> { Straddle::PaymentStatusDetails }
+
+      # @!attribute unblock_eligible
+      #   Whether the paykey is eligible for client-initiated unblocking. `true` only when
+      #   the paykey is blocked by an `R29` return and has not been unblocked before.
+      #   `false` for other blocked paykeys. `null` when the paykey is not blocked.
+      #
+      #   @return [Boolean, nil]
+      optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, status_details: nil, unblock_eligible: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::PaykeySummary} for more details.
+      #
+      #   @param id [String] Unique identifier for the paykey.
+      #
+      #   @param config [Straddle::Models::PaykeyConfiguration]
+      #
+      #   @param created_at [Time] Timestamp of when the paykey was created.
+      #
+      #   @param label [String] Display label combining the bank name and masked account number.
+      #
+      #   @param paykey [String] Masked paykey value.
+      #
+      #   @param source [Symbol, Straddle::Models::PaykeySource]
+      #
+      #   @param status [Symbol, Straddle::Models::PaykeyStatus]
+      #
+      #   @param updated_at [Time] Timestamp of the most recent update to the paykey.
+      #
+      #   @param bank_data [Straddle::Models::PaykeyBankDetails]
+      #
+      #   @param customer_id [String, nil] Unique identifier for the customer associated with the paykey.
+      #
+      #   @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
+      #
+      #   @param external_id [String, nil] Unique identifier for the paykey in your system.
+      #
+      #   @param institution_name [String, nil] Name of the financial institution.
+      #
+      #   @param status_details [Straddle::Models::PaymentStatusDetails]
+      #
+      #   @param unblock_eligible [Boolean, nil] Whether the paykey is eligible for client-initiated unblocking. `true` only when
+    end
+  end
+end

data/lib/straddle/models/paykey_summary_list.rb

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