straddle 0.3.0 → 0.5.0

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

@@ -3,7 +3,16 @@
 module Straddle
   module Resources
     class Embed
+      # Accounts represent businesses using Straddle through your platform. Each account
+      # must complete automated verification before processing payments. Use accounts to
+      # manage your users' payment capabilities, track verification status, and control
+      # access to features. Accounts can be instantly created in sandbox and require
+      # additional verification for production access.
       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.
         # @return [Straddle::Resources::Embed::Accounts::CapabilityRequests]
         attr_reader :capability_requests
 
@@ -20,7 +29,7 @@ module Straddle
         #
         # @param account_type [Symbol, Straddle::Models::Embed::AccountCreateParams::AccountType] Body param: The type of account to be created. Currently, only `business` is sup
         #
-        # @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param:
+        # @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param
         #
         # @param organization_id [String] Body param: The unique identifier of the organization related to this account.
         #
@@ -61,9 +70,9 @@ module Straddle
         #
         # @overload update(account_id, business_profile:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
-        # @param account_id [String] Path param:
+        # @param account_id [String] Path param
         #
-        # @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param:
+        # @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param
         #
         # @param external_id [String, nil] Body param: Unique identifier for the account in your database, used for cross-r
         #
@@ -102,21 +111,23 @@ module Straddle
         # created accounts appearing first. This endpoint supports advanced sorting and
         # filtering options.
         #
-        # @overload list(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: {})
+        # @overload list(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] Query param
         #
         # @param page_number [Integer] Query param: Results page number. Starts at page 1. Default value: 1
         #
         # @param page_size [Integer] Query param: Page size. Default value: 100. Max value: 1000
         #
-        # @param search_text [String] Query param:
+        # @param search_text [String] Query param
         #
         # @param sort_by [String] Query param: Sort By. Default value: 'id'.
         #
         # @param sort_order [Symbol, Straddle::Models::Embed::AccountListParams::SortOrder] Query param: Sort Order. Default value: 'asc'.
         #
-        # @param status [Symbol, Straddle::Models::Embed::AccountListParams::Status] Query param:
+        # @param status [Symbol, Straddle::Models::Embed::AccountListParams::Status] Query param
         #
-        # @param type [Symbol, Straddle::Models::Embed::AccountListParams::Type] Query param:
+        # @param type [Symbol, Straddle::Models::Embed::AccountListParams::Type] Query param
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
@@ -128,12 +139,14 @@ module Straddle
         #
         # @see Straddle::Models::Embed::AccountListParams
         def list(params = {})
+          query_params =
+            [:external_id, :page_number, :page_size, :search_text, :sort_by, :sort_order, :status, :type]
           parsed, options = Straddle::Embed::AccountListParams.dump_request(params)
-          query_params = [:page_number, :page_size, :search_text, :sort_by, :sort_order, :status, :type]
+          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
           @client.request(
             method: :get,
             path: "v1/accounts",
-            query: parsed.slice(*query_params),
+            query: query,
             headers: parsed.except(*query_params).transform_keys(
               correlation_id: "correlation-id",
               request_id: "request-id"
@@ -181,9 +194,9 @@ module Straddle
         #
         # @overload onboard(account_id, terms_of_service:, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
-        # @param account_id [String] Path param:
+        # @param account_id [String] Path param
         #
-        # @param terms_of_service [Straddle::Models::Embed::TermsOfServiceV1] Body param:
+        # @param terms_of_service [Straddle::Models::Embed::TermsOfServiceV1] Body param
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
@@ -218,9 +231,9 @@ module Straddle
         #
         # @overload simulate(account_id, final_status: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
-        # @param account_id [String] Path param:
+        # @param account_id [String] Path param
         #
-        # @param final_status [Symbol, Straddle::Models::Embed::AccountSimulateParams::FinalStatus] Query param:
+        # @param final_status [Symbol, Straddle::Models::Embed::AccountSimulateParams::FinalStatus] Query param
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #
@@ -234,12 +247,13 @@ module Straddle
         #
         # @see Straddle::Models::Embed::AccountSimulateParams
         def simulate(account_id, params = {})
-          parsed, options = Straddle::Embed::AccountSimulateParams.dump_request(params)
           query_params = [:final_status]
+          parsed, options = Straddle::Embed::AccountSimulateParams.dump_request(params)
+          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
           @client.request(
             method: :post,
             path: ["v1/accounts/%1$s/simulate", account_id],
-            query: parsed.slice(*query_params),
+            query: query,
             headers: parsed.except(*query_params).transform_keys(
               correlation_id: "correlation-id",
               idempotency_key: "idempotency-key",

data/lib/straddle/resources/embed/linked_bank_accounts.rb

@@ -3,6 +3,10 @@
 module Straddle
   module Resources
     class Embed
+      # Linked bank accounts connect your platform users' external bank accounts to
+      # Straddle for settlements and payment funding. Each linked account undergoes
+      # automated verification and continuous monitoring. Use linked accounts to manage
+      # where clients receive deposits, fund payouts, and track settlement preferences.
       class LinkedBankAccounts
         # Some parameter documentations has been truncated, see
         # {Straddle::Models::Embed::LinkedBankAccountCreateParams} for more details.
@@ -16,7 +20,7 @@ module Straddle
         #
         # @param account_id [String, nil] Body param: The unique identifier of the Straddle account to associate this bank
         #
-        # @param bank_account [Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount] Body param:
+        # @param bank_account [Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount] Body param
         #
         # @param description [String, nil] Body param: Optional description for the bank account.
         #
@@ -61,9 +65,9 @@ module Straddle
         #
         # @overload update(linked_bank_account_id, bank_account:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
-        # @param linked_bank_account_id [String] Path param:
+        # @param linked_bank_account_id [String] Path param
         #
-        # @param bank_account [Straddle::Models::Embed::LinkedBankAccountUpdateParams::BankAccount] Body param:
+        # @param bank_account [Straddle::Models::Embed::LinkedBankAccountUpdateParams::BankAccount] Body param
         #
         # @param metadata [Hash{Symbol=>String, nil}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
         #
@@ -104,7 +108,7 @@ module Straddle
         #
         # @param account_id [String] Query param: The unique identifier of the related account.
         #
-        # @param level [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Level] Query param:
+        # @param level [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Level] Query param
         #
         # @param page_number [Integer] Query param: Results page number. Starts at page 1.
         #
@@ -128,7 +132,6 @@ module Straddle
         #
         # @see Straddle::Models::Embed::LinkedBankAccountListParams
         def list(params = {})
-          parsed, options = Straddle::Embed::LinkedBankAccountListParams.dump_request(params)
           query_params = [
             :account_id,
             :level,
@@ -139,10 +142,12 @@ module Straddle
             :sort_order,
             :status
           ]
+          parsed, options = Straddle::Embed::LinkedBankAccountListParams.dump_request(params)
+          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
           @client.request(
             method: :get,
             path: "v1/linked_bank_accounts",
-            query: parsed.slice(*query_params),
+            query: query,
             headers: parsed.except(*query_params).transform_keys(
               correlation_id: "correlation-id",
               request_id: "request-id"

data/lib/straddle/resources/embed/organizations.rb

@@ -3,6 +3,10 @@
 module Straddle
   module Resources
     class Embed
+      # Organizations are a powerful feature in Straddle that allow you to manage
+      # multiple accounts under a single umbrella. This hierarchical structure is
+      # particularly useful for businesses with complex operations, multiple
+      # departments, or legally related entities.
       class Organizations
         # Some parameter documentations has been truncated, see
         # {Straddle::Models::Embed::OrganizationCreateParams} for more details.
@@ -76,12 +80,13 @@ module Straddle
         #
         # @see Straddle::Models::Embed::OrganizationListParams
         def list(params = {})
-          parsed, options = Straddle::Embed::OrganizationListParams.dump_request(params)
           query_params = [:external_id, :name, :page_number, :page_size, :sort_by, :sort_order]
+          parsed, options = Straddle::Embed::OrganizationListParams.dump_request(params)
+          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
           @client.request(
             method: :get,
             path: "v1/organizations",
-            query: parsed.slice(*query_params),
+            query: query,
             headers: parsed.except(*query_params).transform_keys(
               correlation_id: "correlation-id",
               request_id: "request-id"

data/lib/straddle/resources/embed/representatives.rb

@@ -3,6 +3,12 @@
 module Straddle
   module Resources
     class Embed
+      # Representatives are individuals who have legal authority or significant
+      # responsibility within a business entity associated with a Straddle account. Each
+      # representative undergoes automated verification as part of KYC/KYB compliance.
+      # Use representatives to collect and verify beneficial owners, control persons,
+      # and authorized signers required for account onboarding. Representatives also
+      # determine who can legally operate the account and make important changes.
       class Representatives
         # Some parameter documentations has been truncated, see
         # {Straddle::Models::Embed::RepresentativeCreateParams} for more details.
@@ -25,7 +31,7 @@ module Straddle
         #
         # @param mobile_number [String] Body param: The mobile phone number of the representative.
         #
-        # @param relationship [Straddle::Models::Embed::RepresentativeCreateParams::Relationship] Body param:
+        # @param relationship [Straddle::Models::Embed::RepresentativeCreateParams::Relationship] Body param
         #
         # @param ssn_last4 [String] Body param: The last 4 digits of the representative's Social Security Number.
         #
@@ -67,7 +73,7 @@ module Straddle
         #
         # @overload update(representative_id, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
         #
-        # @param representative_id [String] Path param:
+        # @param representative_id [String] Path param
         #
         # @param dob [Date] Body param: The date of birth of the representative, in ISO 8601 format (YYYY-MM
         #
@@ -79,7 +85,7 @@ module Straddle
         #
         # @param mobile_number [String] Body param: The mobile phone number of the representative.
         #
-        # @param relationship [Straddle::Models::Embed::RepresentativeUpdateParams::Relationship] Body param:
+        # @param relationship [Straddle::Models::Embed::RepresentativeUpdateParams::Relationship] Body param
         #
         # @param ssn_last4 [String] Body param: The last 4 digits of the representative's Social Security Number.
         #
@@ -124,15 +130,15 @@ module Straddle
         #
         # @param account_id [String] Query param: The unique identifier of the account to list representatives for.
         #
-        # @param level [Symbol, Straddle::Models::Embed::RepresentativeListParams::Level] Query param:
+        # @param level [Symbol, Straddle::Models::Embed::RepresentativeListParams::Level] Query param
         #
-        # @param organization_id [String] Query param:
+        # @param organization_id [String] Query param
         #
         # @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 platform_id [String] Query param:
+        # @param platform_id [String] Query param
         #
         # @param sort_by [String] Query param: Sort By.
         #
@@ -148,7 +154,6 @@ module Straddle
         #
         # @see Straddle::Models::Embed::RepresentativeListParams
         def list(params = {})
-          parsed, options = Straddle::Embed::RepresentativeListParams.dump_request(params)
           query_params =
             [
               :account_id,
@@ -160,10 +165,12 @@ module Straddle
               :sort_by,
               :sort_order
             ]
+          parsed, options = Straddle::Embed::RepresentativeListParams.dump_request(params)
+          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
           @client.request(
             method: :get,
             path: "v1/representatives",
-            query: parsed.slice(*query_params),
+            query: query,
             headers: parsed.except(*query_params).transform_keys(
               correlation_id: "correlation-id",
               request_id: "request-id"

data/lib/straddle/resources/embed.rb

@@ -3,15 +3,34 @@
 module Straddle
   module Resources
     class Embed
+      # Accounts represent businesses using Straddle through your platform. Each account
+      # must complete automated verification before processing payments. Use accounts to
+      # manage your users' payment capabilities, track verification status, and control
+      # access to features. Accounts can be instantly created in sandbox and require
+      # additional verification for production access.
       # @return [Straddle::Resources::Embed::Accounts]
       attr_reader :accounts
 
+      # Linked bank accounts connect your platform users' external bank accounts to
+      # Straddle for settlements and payment funding. Each linked account undergoes
+      # automated verification and continuous monitoring. Use linked accounts to manage
+      # where clients receive deposits, fund payouts, and track settlement preferences.
       # @return [Straddle::Resources::Embed::LinkedBankAccounts]
       attr_reader :linked_bank_accounts
 
+      # Organizations are a powerful feature in Straddle that allow you to manage
+      # multiple accounts under a single umbrella. This hierarchical structure is
+      # particularly useful for businesses with complex operations, multiple
+      # departments, or legally related entities.
       # @return [Straddle::Resources::Embed::Organizations]
       attr_reader :organizations
 
+      # Representatives are individuals who have legal authority or significant
+      # responsibility within a business entity associated with a Straddle account. Each
+      # representative undergoes automated verification as part of KYC/KYB compliance.
+      # Use representatives to collect and verify beneficial owners, control persons,
+      # and authorized signers required for account onboarding. Representatives also
+      # determine who can legally operate the account and make important changes.
       # @return [Straddle::Resources::Embed::Representatives]
       attr_reader :representatives
 

data/lib/straddle/resources/funding_events.rb

@@ -2,6 +2,12 @@
 
 module Straddle
   module Resources
+    # Funding events represent all money movement between Straddle and an Account's
+    # external bank accounts. They are automatically generated when charges settle or
+    # payouts are initiated. Each event provides detailed tracking of settlement
+    # status, fee breakdowns, and reconciliation data across both incoming and
+    # outgoing transfers. Use funding events to monitor your platform's entire money
+    # movement lifecycle.
     class FundingEvents
       # Some parameter documentations has been truncated, see
       # {Straddle::Models::FundingEventListParams} for more details.
@@ -9,7 +15,7 @@ module Straddle
       # Retrieves a list of funding events for your account. This endpoint supports
       # advanced sorting and filtering options.
       #
-      # @overload list(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload list(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, status: nil, status_reason: nil, status_source: nil, trace_id: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param created_from [Date, nil] Query param: The start date of the range to filter by using the `YYYY-MM-DD` for
       #
@@ -29,6 +35,14 @@ module Straddle
       #
       # @param sort_order [Symbol, Straddle::Models::FundingEventListParams::SortOrder] Query param: The order in which to sort the results.
       #
+      # @param status [Array<Symbol, Straddle::Models::FundingEventListParams::Status>, nil] Query param: Funding Event status.
+      #
+      # @param status_reason [Array<Symbol, Straddle::Models::FundingEventListParams::StatusReason>, nil] Query param: Reason for latest payment status change.
+      #
+      # @param status_source [Array<Symbol, Straddle::Models::FundingEventListParams::StatusSource>, nil] Query param: Source of latest payment status change.
+      #
+      # @param trace_id [String, nil] Query param: Trace Id.
+      #
       # @param trace_number [String, nil] Query param: Trace number.
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
@@ -43,7 +57,6 @@ module Straddle
       #
       # @see Straddle::Models::FundingEventListParams
       def list(params = {})
-        parsed, options = Straddle::FundingEventListParams.dump_request(params)
         query_params =
           [
             :created_from,
@@ -55,12 +68,18 @@ module Straddle
             :search_text,
             :sort_by,
             :sort_order,
+            :status,
+            :status_reason,
+            :status_source,
+            :trace_id,
             :trace_number
           ]
+        parsed, options = Straddle::FundingEventListParams.dump_request(params)
+        query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :get,
           path: "v1/funding_events",
-          query: parsed.slice(*query_params),
+          query: query,
           headers: parsed.except(*query_params).transform_keys(
             correlation_id: "correlation-id",
             request_id: "request-id",

data/lib/straddle/resources/paykeys/review.rb

@@ -3,6 +3,11 @@
 module Straddle
   module Resources
     class Paykeys
+      # Paykeys are secure tokens that link verified customer identities to their bank
+      # accounts. Each Paykey includes built-in balance checking, fraud detection
+      # through LSTM machine learning models, and can be reused for subscriptions and
+      # recurring payments without storing sensitive data. Paykeys eliminate fraud by
+      # ensuring the person initiating payment owns the funding account.
       class Review
         # Some parameter documentations has been truncated, see
         # {Straddle::Models::Paykeys::ReviewDecisionParams} for more details.
@@ -11,9 +16,9 @@ module Straddle
         #
         # @overload decision(id, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
         #
-        # @param id [String] Path param:
+        # @param id [String] Path param
         #
-        # @param status [Symbol, Straddle::Models::Paykeys::ReviewDecisionParams::Status] Body param:
+        # @param status [Symbol, Straddle::Models::Paykeys::ReviewDecisionParams::Status] Body param
         #
         # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
         #

data/lib/straddle/resources/paykeys.rb

@@ -2,7 +2,17 @@
 
 module Straddle
   module Resources
+    # Paykeys are secure tokens that link verified customer identities to their bank
+    # accounts. Each Paykey includes built-in balance checking, fraud detection
+    # through LSTM machine learning models, and can be reused for subscriptions and
+    # recurring payments without storing sensitive data. Paykeys eliminate fraud by
+    # ensuring the person initiating payment owns the funding account.
     class Paykeys
+      # Paykeys are secure tokens that link verified customer identities to their bank
+      # accounts. Each Paykey includes built-in balance checking, fraud detection
+      # through LSTM machine learning models, and can be reused for subscriptions and
+      # recurring payments without storing sensitive data. Paykeys eliminate fraud by
+      # ensuring the person initiating payment owns the funding account.
       # @return [Straddle::Resources::Paykeys::Review]
       attr_reader :review
 
@@ -12,7 +22,11 @@ module Straddle
       # Returns a list of paykeys associated with a Straddle account. This endpoint
       # supports advanced sorting and filtering options.
       #
-      # @overload list(customer_id: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload list(created_from: nil, created_to: nil, customer_id: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, unblock_eligible: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param created_from [Time] Query param: Start date for filtering by creation date.
+      #
+      # @param created_to [Time] Query param: End date for filtering by creation date.
       #
       # @param customer_id [String] Query param: Filter paykeys by related customer ID.
       #
@@ -20,14 +34,18 @@ module Straddle
       #
       # @param page_size [Integer] Query param: Number of results per page. Maximum: 1000.
       #
-      # @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy] Query param:
+      # @param search_text [String] Query param: General search term to filter paykeys.
       #
-      # @param sort_order [Symbol, Straddle::Models::PaykeyListParams::SortOrder] Query param:
+      # @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy] Query param
+      #
+      # @param sort_order [Symbol, Straddle::Models::PaykeyListParams::SortOrder] Query param
       #
       # @param source [Array<Symbol, Straddle::Models::PaykeyListParams::Source>] Query param: Filter paykeys by their source.
       #
       # @param status [Array<Symbol, Straddle::Models::PaykeyListParams::Status>] Query param: Filter paykeys by their current status.
       #
+      # @param unblock_eligible [Boolean] Query param: Filter paykeys by unblock eligibility. When true, returns only bloc
+      #
       # @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.
@@ -40,12 +58,26 @@ module Straddle
       #
       # @see Straddle::Models::PaykeyListParams
       def list(params = {})
+        query_params =
+          [
+            :created_from,
+            :created_to,
+            :customer_id,
+            :page_number,
+            :page_size,
+            :search_text,
+            :sort_by,
+            :sort_order,
+            :source,
+            :status,
+            :unblock_eligible
+          ]
         parsed, options = Straddle::PaykeyListParams.dump_request(params)
-        query_params = [:customer_id, :page_number, :page_size, :sort_by, :sort_order, :source, :status]
+        query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :get,
           path: "v1/paykeys",
-          query: parsed.slice(*query_params),
+          query: query,
           headers: parsed.except(*query_params).transform_keys(
             correlation_id: "correlation-id",
             request_id: "request-id",
@@ -62,9 +94,9 @@ module Straddle
       #
       # @overload cancel(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
-      # @param id [String] Path param:
+      # @param id [String] Path param
       #
-      # @param reason [String, nil] Body param:
+      # @param reason [String, nil] Body param
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
@@ -132,10 +164,9 @@ module Straddle
         )
       end
 
-      # Retrieves the details of a paykey that has previously been created, including
-      # unmasked bank account fields. Supply the unique paykey ID that was returned from
-      # your previous request, and Straddle will return the corresponding paykey
-      # information.
+      # Retrieves the details of a paykey that has previously been created. Supply the
+      # unique paykey ID that was returned from your previous request, and Straddle will
+      # return the corresponding paykey information including the unmasked token.
       #
       # @overload reveal(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #

data/lib/straddle/resources/payments.rb

@@ -2,6 +2,8 @@
 
 module Straddle
   module Resources
+    # Payments provide endpoints to filter both Charges and Payouts with multiple
+    # different parameters.
     class Payments
       # Some parameter documentations has been truncated, see
       # {Straddle::Models::PaymentListParams} for more details.
@@ -9,20 +11,30 @@ module Straddle
       # Search for payments, including `charges` and `payouts`, using a variety of
       # criteria. This endpoint supports advanced sorting and filtering options.
       #
-      # @overload list(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload list(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, has_refund: nil, has_resubmit: nil, include_metadata: nil, is_refund: nil, is_resubmit: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, max_updated_at: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, min_updated_at: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param customer_id [String] Query param: Search using the `customer_id` of a `charge` or `payout`.
       #
-      # @param default_page_size [Integer] Query param:
+      # @param default_page_size [Integer] Query param
       #
       # @param default_sort [Symbol, Straddle::Models::PaymentListParams::DefaultSort] Query param: The field to sort the results by.
       #
-      # @param default_sort_order [Symbol, Straddle::Models::PaymentListParams::DefaultSortOrder] Query param:
+      # @param default_sort_order [Symbol, Straddle::Models::PaymentListParams::DefaultSortOrder] Query param
       #
       # @param external_id [String] Query param: Search using the `external_id` of a `charge` or `payout`.
       #
       # @param funding_id [String] Query param: Search using the `funding_id` of a `charge` or `payout`.
       #
+      # @param has_refund [Boolean] Query param: Has the payment been refunded by an associated payout (only applica
+      #
+      # @param has_resubmit [Boolean] Query param: Has the payment been resubmitted.
+      #
+      # @param include_metadata [Boolean] Query param: Include the metadata for payments in the returned data.
+      #
+      # @param is_refund [Boolean] Query param: Is the payment a refund of an original charge (only applicable to p
+      #
+      # @param is_resubmit [Boolean] Query param: Is the payment a resubmit of an original payment.
+      #
       # @param max_amount [Integer] Query param: Search using a maximum `amount` of a `charge` or `payout`.
       #
       # @param max_created_at [Time] Query param: Search using the latest `created_at` date of a `charge` or `payout`
@@ -31,6 +43,8 @@ module Straddle
       #
       # @param max_payment_date [Date] Query param: Search using the latest `payment_date` of a `charge` or `payout`.
       #
+      # @param max_updated_at [Time] Query param: Filter to payments last updated on or before this timestamp.
+      #
       # @param min_amount [Integer] Query param: Search using the minimum `amount of a `charge`or`payout`.
       #
       # @param min_created_at [Time] Query param: Search using the earliest `created_at` date of a `charge` or `payou
@@ -39,6 +53,8 @@ module Straddle
       #
       # @param min_payment_date [Date] Query param: Search using the earliest ` `of a `charge` or `payout`.
       #
+      # @param min_updated_at [Time] Query param: Filter to payments last updated on or after this timestamp.
+      #
       # @param page_number [Integer] Query param: Results page number. Starts at page 1.
       #
       # @param page_size [Integer] Query param: Results page size. Max value: 1000
@@ -57,7 +73,7 @@ module Straddle
       #
       # @param sort_by [Symbol, Straddle::Models::PaymentListParams::SortBy] Query param: The field to sort the results by.
       #
-      # @param sort_order [Symbol, Straddle::Models::PaymentListParams::SortOrder] Query param:
+      # @param sort_order [Symbol, Straddle::Models::PaymentListParams::SortOrder] Query param
       #
       # @param status_reason [Array<Symbol, Straddle::Models::PaymentListParams::StatusReason>] Query param: Reason for latest payment status change.
       #
@@ -75,7 +91,6 @@ module Straddle
       #
       # @see Straddle::Models::PaymentListParams
       def list(params = {})
-        parsed, options = Straddle::PaymentListParams.dump_request(params)
         query_params =
           [
             :customer_id,
@@ -84,14 +99,21 @@ module Straddle
             :default_sort_order,
             :external_id,
             :funding_id,
+            :has_refund,
+            :has_resubmit,
+            :include_metadata,
+            :is_refund,
+            :is_resubmit,
             :max_amount,
             :max_created_at,
             :max_effective_at,
             :max_payment_date,
+            :max_updated_at,
             :min_amount,
             :min_created_at,
             :min_effective_at,
             :min_payment_date,
+            :min_updated_at,
             :page_number,
             :page_size,
             :paykey,
@@ -105,10 +127,12 @@ module Straddle
             :status_reason,
             :status_source
           ]
+        parsed, options = Straddle::PaymentListParams.dump_request(params)
+        query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :get,
           path: "v1/payments",
-          query: parsed.slice(*query_params),
+          query: query,
           headers: parsed.except(*query_params).transform_keys(
             correlation_id: "correlation-id",
             request_id: "request-id",