straddle 0.3.0 → 0.5.0

data/rbi/straddle/resources/paykeys.rbi

@@ -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.
       sig { returns(Straddle::Resources::Paykeys::Review) }
       attr_reader :review
 
@@ -10,13 +20,17 @@ module Straddle
       # supports advanced sorting and filtering options.
       sig do
         params(
+          created_from: Time,
+          created_to: Time,
           customer_id: String,
           page_number: Integer,
           page_size: Integer,
+          search_text: String,
           sort_by: Straddle::PaykeyListParams::SortBy::OrSymbol,
           sort_order: Straddle::PaykeyListParams::SortOrder::OrSymbol,
           source: T::Array[Straddle::PaykeyListParams::Source::OrSymbol],
           status: T::Array[Straddle::PaykeyListParams::Status::OrSymbol],
+          unblock_eligible: T::Boolean,
           correlation_id: String,
           request_id: String,
           straddle_account_id: String,
@@ -28,20 +42,31 @@ module Straddle
         )
       end
       def list(
+        # Query param: Start date for filtering by creation date.
+        created_from: nil,
+        # Query param: End date for filtering by creation date.
+        created_to: nil,
         # Query param: Filter paykeys by related customer ID.
         customer_id: nil,
         # Query param: Page number for paginated results. Starts at 1.
         page_number: nil,
         # Query param: Number of results per page. Maximum: 1000.
         page_size: nil,
-        # Query param:
+        # Query param: General search term to filter paykeys.
+        search_text: nil,
+        # Query param
         sort_by: nil,
-        # Query param:
+        # Query param
         sort_order: nil,
         # Query param: Filter paykeys by their source.
         source: nil,
         # Query param: Filter paykeys by their current status.
         status: nil,
+        # Query param: 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.
+        unblock_eligible: nil,
         # Header param: Optional client generated identifier to trace and debug a series
         # of requests.
         correlation_id: nil,
@@ -66,9 +91,9 @@ module Straddle
         ).returns(Straddle::PaykeyV1)
       end
       def cancel(
-        # Path param:
+        # Path param
         id,
-        # Body param:
+        # Body param
         reason: nil,
         # Header param: Optional client generated identifier to trace and debug a series
         # of requests.
@@ -108,10 +133,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.
       sig do
         params(
           id: String,

data/rbi/straddle/resources/payments.rbi

@@ -2,6 +2,8 @@
 
 module Straddle
   module Resources
+    # Payments provide endpoints to filter both Charges and Payouts with multiple
+    # different parameters.
     class Payments
       # Search for payments, including `charges` and `payouts`, using a variety of
       # criteria. This endpoint supports advanced sorting and filtering options.
@@ -14,14 +16,21 @@ module Straddle
             Straddle::PaymentListParams::DefaultSortOrder::OrSymbol,
           external_id: String,
           funding_id: String,
+          has_refund: T::Boolean,
+          has_resubmit: T::Boolean,
+          include_metadata: T::Boolean,
+          is_refund: T::Boolean,
+          is_resubmit: T::Boolean,
           max_amount: Integer,
           max_created_at: Time,
           max_effective_at: Time,
           max_payment_date: Date,
+          max_updated_at: Time,
           min_amount: Integer,
           min_created_at: Time,
           min_effective_at: Time,
           min_payment_date: Date,
+          min_updated_at: Time,
           page_number: Integer,
           page_size: Integer,
           paykey: String,
@@ -51,16 +60,28 @@ module Straddle
       def list(
         # Query param: Search using the `customer_id` of a `charge` or `payout`.
         customer_id: nil,
-        # Query param:
+        # Query param
         default_page_size: nil,
         # Query param: The field to sort the results by.
         default_sort: nil,
-        # Query param:
+        # Query param
         default_sort_order: nil,
         # Query param: Search using the `external_id` of a `charge` or `payout`.
         external_id: nil,
         # Query param: Search using the `funding_id` of a `charge` or `payout`.
         funding_id: nil,
+        # Query param: Has the payment been refunded by an associated payout (only
+        # applicable to charges).
+        has_refund: nil,
+        # Query param: Has the payment been resubmitted.
+        has_resubmit: nil,
+        # Query param: Include the metadata for payments in the returned data.
+        include_metadata: nil,
+        # Query param: Is the payment a refund of an original charge (only applicable to
+        # payouts).
+        is_refund: nil,
+        # Query param: Is the payment a resubmit of an original payment.
+        is_resubmit: nil,
         # Query param: Search using a maximum `amount` of a `charge` or `payout`.
         max_amount: nil,
         # Query param: Search using the latest `created_at` date of a `charge` or
@@ -70,6 +91,8 @@ module Straddle
         max_effective_at: nil,
         # Query param: Search using the latest `payment_date` of a `charge` or `payout`.
         max_payment_date: nil,
+        # Query param: Filter to payments last updated on or before this timestamp.
+        max_updated_at: nil,
         # Query param: Search using the minimum `amount of a `charge`or`payout`.
         min_amount: nil,
         # Query param: Search using the earliest `created_at` date of a `charge` or
@@ -80,6 +103,8 @@ module Straddle
         min_effective_at: nil,
         # Query param: Search using the earliest ` `of a `charge` or `payout`.
         min_payment_date: nil,
+        # Query param: Filter to payments last updated on or after this timestamp.
+        min_updated_at: nil,
         # Query param: Results page number. Starts at page 1.
         page_number: nil,
         # Query param: Results page size. Max value: 1000
@@ -98,7 +123,7 @@ module Straddle
         search_text: nil,
         # Query param: The field to sort the results by.
         sort_by: nil,
-        # Query param:
+        # Query param
         sort_order: nil,
         # Query param: Reason for latest payment status change.
         status_reason: nil,

data/rbi/straddle/resources/payouts.rbi

@@ -2,13 +2,17 @@
 
 module Straddle
   module Resources
+    # Payouts represent transfers from Straddle to customer bank accounts. Create
+    # payouts to handle disbursements, process refunds, or manage marketplace
+    # settlements. Use payouts to send money quickly and securely with the most
+    # cost-effective rail automatically selected.
     class Payouts
       # Use payouts to send money to your customers.
       sig do
         params(
           amount: Integer,
           currency: String,
-          description: String,
+          description: T.nilable(String),
           device: Straddle::DeviceInfoV1::OrHash,
           external_id: String,
           paykey: String,
@@ -40,7 +44,7 @@ module Straddle
         # Body param: The desired date on which the payout should be occur. For payouts,
         # this means the date you want the funds to be sent from your bank account.
         payment_date:,
-        # Body param:
+        # Body param
         config: nil,
         # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
         # additional information about the payout in a structured format.
@@ -65,7 +69,7 @@ module Straddle
         params(
           id: String,
           amount: Integer,
-          description: String,
+          description: T.nilable(String),
           payment_date: Date,
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
@@ -76,7 +80,7 @@ module Straddle
         ).returns(Straddle::PayoutV1)
       end
       def update(
-        # Path param:
+        # Path param
         id,
         # Body param: The amount of the payout in cents.
         amount:,
@@ -116,7 +120,7 @@ module Straddle
         ).returns(Straddle::PayoutV1)
       end
       def cancel(
-        # Path param:
+        # Path param
         id,
         # Body param: Details about why the payout status was updated.
         reason:,
@@ -171,7 +175,7 @@ module Straddle
         ).returns(Straddle::PayoutV1)
       end
       def hold(
-        # Path param:
+        # Path param
         id,
         # Body param: Details about why the payout status was updated.
         reason:,
@@ -203,7 +207,7 @@ module Straddle
         ).returns(Straddle::PayoutV1)
       end
       def release(
-        # Path param:
+        # Path param
         id,
         # Body param: Details about why the payout status was updated.
         reason:,
@@ -243,6 +247,39 @@ module Straddle
       )
       end
 
+      # Uploads a document as proof of authorization for a payout. Uploading again adds
+      # another entry to documents rather than replacing the previous one.
+      sig do
+        params(
+          id: String,
+          file: Straddle::Internal::FileInput,
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PayoutV1)
+      end
+      def upload_authorization_document(
+        # Path param
+        id,
+        # Body param: The document file to upload as proof of authorization for this
+        # payout.
+        file:,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: nil,
+        # Header param: Optional client generated value to use for idempotent requests.
+        idempotency_key: nil,
+        # Header param: Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # Header param: For use by platforms to specify an account id and set scope of a
+        # request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Straddle::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/straddle/internal/util.rbs

@@ -45,8 +45,12 @@ module Straddle
         -> top?
       } -> top?
 
+      RFC_3986_NOT_PCHARS: Regexp
+
       def self?.uri_origin: (URI::Generic uri) -> String
 
+      def self?.encode_path: (String | Integer path) -> String
+
       def self?.interpolate_path: (String | ::Array[String] path) -> String
 
       def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]
@@ -106,6 +110,16 @@ module Straddle
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/straddle/models/bridge/link_create_paykey_response.rbs

@@ -201,7 +201,8 @@ module Straddle
             def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreatePaykeyResponse::Data::source]
           end
 
-          type status = :pending | :active | :inactive | :rejected | :review
+          type status =
+            :pending | :active | :inactive | :rejected | :review | :blocked
 
           module Status
             extend Straddle::Internal::Type::Enum
@@ -211,6 +212,7 @@ module Straddle
             INACTIVE: :inactive
             REJECTED: :rejected
             REVIEW: :review
+            BLOCKED: :blocked
 
             def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreatePaykeyResponse::Data::status]
           end
@@ -349,6 +351,13 @@ module Straddle
               | :ok
               | :other_network_return
               | :payout_refused
+              | :cancel_request
+              | :failed_verification
+              | :require_review
+              | :blocked_by_system
+              | :watchtower_review
+              | :validating
+              | :auto_hold
 
             module Reason
               extend Straddle::Internal::Type::Enum
@@ -373,6 +382,13 @@ module Straddle
               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
 
               def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreatePaykeyResponse::Data::StatusDetails::reason]
             end

data/sig/straddle/models/bridge/link_create_tan_response.rbs

@@ -201,7 +201,8 @@ module Straddle
             def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreateTanResponse::Data::source]
           end
 
-          type status = :pending | :active | :inactive | :rejected | :review
+          type status =
+            :pending | :active | :inactive | :rejected | :review | :blocked
 
           module Status
             extend Straddle::Internal::Type::Enum
@@ -211,6 +212,7 @@ module Straddle
             INACTIVE: :inactive
             REJECTED: :rejected
             REVIEW: :review
+            BLOCKED: :blocked
 
             def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreateTanResponse::Data::status]
           end
@@ -349,6 +351,13 @@ module Straddle
               | :ok
               | :other_network_return
               | :payout_refused
+              | :cancel_request
+              | :failed_verification
+              | :require_review
+              | :blocked_by_system
+              | :watchtower_review
+              | :validating
+              | :auto_hold
 
             module Reason
               extend Straddle::Internal::Type::Enum
@@ -373,6 +382,13 @@ module Straddle
               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
 
               def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreateTanResponse::Data::StatusDetails::reason]
             end

data/sig/straddle/models/charge_cancel_params.rbs

@@ -2,6 +2,7 @@ module Straddle
   module Models
     type charge_cancel_params =
       {
+        id: String,
         reason: String?,
         correlation_id: String,
         idempotency_key: String,
@@ -14,6 +15,8 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor reason: String?
 
       attr_reader correlation_id: String?
@@ -33,6 +36,7 @@ module Straddle
       def straddle_account_id=: (String) -> String
 
       def initialize: (
+        id: String,
         ?reason: String?,
         ?correlation_id: String,
         ?idempotency_key: String,
@@ -42,6 +46,7 @@ module Straddle
       ) -> void
 
       def to_hash: -> {
+        id: String,
         reason: String?,
         correlation_id: String,
         idempotency_key: String,

data/sig/straddle/models/charge_create_params.rbs

@@ -6,7 +6,7 @@ module Straddle
         config: Straddle::ChargeCreateParams::Config,
         consent_type: Straddle::Models::ChargeCreateParams::consent_type,
         currency: String,
-        description: String,
+        description: String?,
         device: Straddle::DeviceInfoV1,
         external_id: String,
         paykey: String,
@@ -31,7 +31,7 @@ module Straddle
 
       attr_accessor currency: String
 
-      attr_accessor description: String
+      attr_accessor description: String?
 
       attr_accessor device: Straddle::DeviceInfoV1
 
@@ -64,7 +64,7 @@ module Straddle
         config: Straddle::ChargeCreateParams::Config,
         consent_type: Straddle::Models::ChargeCreateParams::consent_type,
         currency: String,
-        description: String,
+        description: String?,
         device: Straddle::DeviceInfoV1,
         external_id: String,
         paykey: String,
@@ -82,7 +82,7 @@ module Straddle
         config: Straddle::ChargeCreateParams::Config,
         consent_type: Straddle::Models::ChargeCreateParams::consent_type,
         currency: String,
-        description: String,
+        description: String?,
         device: Straddle::DeviceInfoV1,
         external_id: String,
         paykey: String,
@@ -98,12 +98,18 @@ module Straddle
       type config =
         {
           balance_check: Straddle::Models::ChargeCreateParams::Config::balance_check,
+          auto_hold: bool?,
+          auto_hold_message: String?,
           sandbox_outcome: Straddle::Models::ChargeCreateParams::Config::sandbox_outcome
         }
 
       class Config < Straddle::Internal::Type::BaseModel
         attr_accessor balance_check: Straddle::Models::ChargeCreateParams::Config::balance_check
 
+        attr_accessor auto_hold: bool?
+
+        attr_accessor auto_hold_message: String?
+
         attr_reader sandbox_outcome: Straddle::Models::ChargeCreateParams::Config::sandbox_outcome?
 
         def sandbox_outcome=: (
@@ -112,11 +118,15 @@ module Straddle
 
         def initialize: (
           balance_check: Straddle::Models::ChargeCreateParams::Config::balance_check,
+          ?auto_hold: bool?,
+          ?auto_hold_message: String?,
           ?sandbox_outcome: Straddle::Models::ChargeCreateParams::Config::sandbox_outcome
         ) -> void
 
         def to_hash: -> {
           balance_check: Straddle::Models::ChargeCreateParams::Config::balance_check,
+          auto_hold: bool?,
+          auto_hold_message: String?,
           sandbox_outcome: Straddle::Models::ChargeCreateParams::Config::sandbox_outcome
         }
 
@@ -144,6 +154,8 @@ module Straddle
           | :reversed_customer_dispute
           | :failed_closed_bank_account
           | :reversed_closed_bank_account
+          | :failed_not_authorized
+          | :reversed_not_authorized
 
         module SandboxOutcome
           extend Straddle::Internal::Type::Enum
@@ -159,6 +171,8 @@ module Straddle
           REVERSED_CUSTOMER_DISPUTE: :reversed_customer_dispute
           FAILED_CLOSED_BANK_ACCOUNT: :failed_closed_bank_account
           REVERSED_CLOSED_BANK_ACCOUNT: :reversed_closed_bank_account
+          FAILED_NOT_AUTHORIZED: :failed_not_authorized
+          REVERSED_NOT_AUTHORIZED: :reversed_not_authorized
 
           def self?.values: -> ::Array[Straddle::Models::ChargeCreateParams::Config::sandbox_outcome]
         end

data/sig/straddle/models/charge_get_params.rbs

@@ -2,6 +2,7 @@ module Straddle
   module Models
     type charge_get_params =
       {
+        id: String,
         correlation_id: String,
         request_id: String,
         straddle_account_id: String
@@ -12,6 +13,8 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_reader correlation_id: String?
 
       def correlation_id=: (String) -> String
@@ -25,6 +28,7 @@ module Straddle
       def straddle_account_id=: (String) -> String
 
       def initialize: (
+        id: String,
         ?correlation_id: String,
         ?request_id: String,
         ?straddle_account_id: String,
@@ -32,6 +36,7 @@ module Straddle
       ) -> void
 
       def to_hash: -> {
+        id: String,
         correlation_id: String,
         request_id: String,
         straddle_account_id: String,

data/sig/straddle/models/charge_hold_params.rbs

@@ -2,6 +2,7 @@ module Straddle
   module Models
     type charge_hold_params =
       {
+        id: String,
         reason: String?,
         correlation_id: String,
         idempotency_key: String,
@@ -14,6 +15,8 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor reason: String?
 
       attr_reader correlation_id: String?
@@ -33,6 +36,7 @@ module Straddle
       def straddle_account_id=: (String) -> String
 
       def initialize: (
+        id: String,
         ?reason: String?,
         ?correlation_id: String,
         ?idempotency_key: String,
@@ -42,6 +46,7 @@ module Straddle
       ) -> void
 
       def to_hash: -> {
+        id: String,
         reason: String?,
         correlation_id: String,
         idempotency_key: String,

data/sig/straddle/models/charge_release_params.rbs

@@ -2,6 +2,7 @@ module Straddle
   module Models
     type charge_release_params =
       {
+        id: String,
         reason: String?,
         correlation_id: String,
         idempotency_key: String,
@@ -14,6 +15,8 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor reason: String?
 
       attr_reader correlation_id: String?
@@ -33,6 +36,7 @@ module Straddle
       def straddle_account_id=: (String) -> String
 
       def initialize: (
+        id: String,
         ?reason: String?,
         ?correlation_id: String,
         ?idempotency_key: String,
@@ -42,6 +46,7 @@ module Straddle
       ) -> void
 
       def to_hash: -> {
+        id: String,
         reason: String?,
         correlation_id: String,
         idempotency_key: String,

data/sig/straddle/models/charge_unmask_params.rbs

@@ -2,6 +2,7 @@ module Straddle
   module Models
     type charge_unmask_params =
       {
+        id: String,
         correlation_id: String,
         request_id: String,
         straddle_account_id: String
@@ -12,6 +13,8 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_reader correlation_id: String?
 
       def correlation_id=: (String) -> String
@@ -25,6 +28,7 @@ module Straddle
       def straddle_account_id=: (String) -> String
 
       def initialize: (
+        id: String,
         ?correlation_id: String,
         ?request_id: String,
         ?straddle_account_id: String,
@@ -32,6 +36,7 @@ module Straddle
       ) -> void
 
       def to_hash: -> {
+        id: String,
         correlation_id: String,
         request_id: String,
         straddle_account_id: String,