straddle 0.1.0.pre.alpha.1

data/rbi/straddle/resources/paykeys.rbi

@@ -0,0 +1,161 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Paykeys
+      # Returns a list of paykeys associated with a Straddle account. This endpoint
+      # supports advanced sorting and filtering options.
+      sig do
+        params(
+          customer_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          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],
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(
+          Straddle::Internal::PageNumberSchema[
+            Straddle::PaykeySummaryPagedV1::Data
+          ]
+        )
+      end
+      def list(
+        # 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:
+        sort_by: nil,
+        # Query param:
+        sort_order: nil,
+        # Query param: Filter paykeys by their source.
+        source: nil,
+        # Query param: Filter paykeys by their current status.
+        status: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: 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
+
+      sig do
+        params(
+          id: String,
+          reason: T.nilable(String),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PaykeyV1)
+      end
+      def cancel(
+        # Path param:
+        id,
+        # Body param:
+        reason: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: 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
+
+      # Retrieves the details of an existing paykey. Supply the unique paykey `id` and
+      # Straddle will return the corresponding paykey record , including the `paykey`
+      # token value and masked bank account details.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PaykeyV1)
+      end
+      def get(
+        id,
+        # Optional client generated identifier to trace and debug a series of requests.
+        correlation_id: nil,
+        # Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # For use by platforms to specify an account id and set scope of a request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      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.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::Models::PaykeyRevealResponse)
+      end
+      def reveal(
+        id,
+        # Optional client generated identifier to trace and debug a series of requests.
+        correlation_id: nil,
+        # Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # For use by platforms to specify an account id and set scope of a request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves the unmasked details of an existing paykey. Supply the unique paykey
+      # `id` and Straddle will return the corresponding paykey record, including the
+      # unmasked bank account details. This endpoint needs to be enabled by Straddle for
+      # your account and should only be used when absolutely necessary.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PaykeyUnmaskedV1)
+      end
+      def unmasked(
+        id,
+        # Optional client generated identifier to trace and debug a series of requests.
+        correlation_id: nil,
+        # Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # 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:)
+      end
+    end
+  end
+end

data/rbi/straddle/resources/payments.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Payments
+      # Search for payments, including `charges` and `payouts`, using a variety of
+      # criteria. This endpoint supports advanced sorting and filtering options.
+      sig do
+        params(
+          customer_id: String,
+          default_page_size: Integer,
+          default_sort: Straddle::PaymentListParams::DefaultSort::OrSymbol,
+          default_sort_order:
+            Straddle::PaymentListParams::DefaultSortOrder::OrSymbol,
+          external_id: String,
+          funding_id: String,
+          max_amount: Integer,
+          max_created_at: Time,
+          max_effective_at: Time,
+          max_payment_date: Date,
+          min_amount: Integer,
+          min_created_at: Time,
+          min_effective_at: Time,
+          min_payment_date: Date,
+          page_number: Integer,
+          page_size: Integer,
+          paykey: String,
+          paykey_id: String,
+          payment_id: String,
+          payment_status:
+            T::Array[Straddle::PaymentListParams::PaymentStatus::OrSymbol],
+          payment_type:
+            T::Array[Straddle::PaymentListParams::PaymentType::OrSymbol],
+          search_text: String,
+          sort_by: Straddle::PaymentListParams::SortBy::OrSymbol,
+          sort_order: Straddle::PaymentListParams::SortOrder::OrSymbol,
+          status_reason:
+            T::Array[Straddle::PaymentListParams::StatusReason::OrSymbol],
+          status_source:
+            T::Array[Straddle::PaymentListParams::StatusSource::OrSymbol],
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(
+          Straddle::Internal::PageNumberSchema[
+            Straddle::PaymentSummaryPagedV1::Data
+          ]
+        )
+      end
+      def list(
+        # Query param: Search using the `customer_id` of a `charge` or `payout`.
+        customer_id: nil,
+        # Query param:
+        default_page_size: nil,
+        # Query param: The field to sort the results by.
+        default_sort: nil,
+        # 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: 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
+        # `payout`.
+        max_created_at: nil,
+        # Query param: Search using the latest `effective_date` of a `charge` or `payout`.
+        max_effective_at: nil,
+        # Query param: Search using the latest `payment_date` of a `charge` or `payout`.
+        max_payment_date: 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
+        # `payout`.
+        min_created_at: nil,
+        # Query param: Search using the earliest `effective_date` of a `charge` or
+        # `payout`.
+        min_effective_at: nil,
+        # Query param: Search using the earliest ` `of a `charge` or `payout`.
+        min_payment_date: nil,
+        # Query param: Results page number. Starts at page 1.
+        page_number: nil,
+        # Query param: Results page size. Max value: 1000
+        page_size: nil,
+        # Query param: Search using the `paykey` of a `charge` or `payout`.
+        paykey: nil,
+        # Query param: Search using the `paykey_id` of a `charge` or `payout`.
+        paykey_id: nil,
+        # Query param: Search using the `id` of a `charge` or `payout`.
+        payment_id: nil,
+        # Query param: Search by the status of a `charge` or `payout`.
+        payment_status: nil,
+        # Query param: Search by the type of a `charge` or `payout`.
+        payment_type: nil,
+        # Query param: Search using a text string associated with a `charge` or `payout`.
+        search_text: nil,
+        # Query param: The field to sort the results by.
+        sort_by: nil,
+        # Query param:
+        sort_order: nil,
+        # Query param: Reason for latest payment status change.
+        status_reason: nil,
+        # Query param: Source of latest payment status change.
+        status_source: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: 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:)
+      end
+    end
+  end
+end

data/rbi/straddle/resources/payouts.rbi

@@ -0,0 +1,237 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Payouts
+      # Use payouts to send money to your customers.
+      sig do
+        params(
+          amount: Integer,
+          currency: String,
+          description: String,
+          device: Straddle::DeviceInfoV1::OrHash,
+          external_id: String,
+          paykey: String,
+          payment_date: Date,
+          config: Straddle::PayoutCreateParams::Config::OrHash,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PayoutV1)
+      end
+      def create(
+        # Body param: The amount of the payout in cents.
+        amount:,
+        # Body param: The currency of the payout. Only USD is supported.
+        currency:,
+        # Body param: An arbitrary description for the payout.
+        description:,
+        # Body param: Information about the device used when the customer authorized the
+        # payout.
+        device:,
+        # Body param: Unique identifier for the payout in your database. This value must
+        # be unique across all payouts.
+        external_id:,
+        # Body param: Value of the `paykey` used for the payout.
+        paykey:,
+        # 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:
+        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.
+        metadata: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: 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
+
+      # Update the details of a payout prior to processing. The status of the payout
+      # must be `created`, `scheduled`, or `on_hold`.
+      sig do
+        params(
+          id: String,
+          amount: Integer,
+          description: String,
+          payment_date: Date,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PayoutV1)
+      end
+      def update(
+        # Path param:
+        id,
+        # Body param: The amount of the payout in cents.
+        amount:,
+        # Body param: An arbitrary description for the payout.
+        description:,
+        # Body param: The desired date on which the payment should be occur. For payouts,
+        # this means the date you want the funds to be sent from your bank account.
+        payment_date:,
+        # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+        # additional information about the payout in a structured format.
+        metadata: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: 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
+
+      # Cancel a payout to prevent it from being processed. The status of the payout
+      # must be `created`, `scheduled`, or `on_hold`.
+      sig do
+        params(
+          id: String,
+          reason: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PayoutV1)
+      end
+      def cancel(
+        # Path param:
+        id,
+        # Body param: Details about why the payout status was updated.
+        reason:,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: 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
+
+      # Retrieves the details of an existing payout. Supply the unique payout `id` to
+      # retrieve the corresponding payout information.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PayoutV1)
+      end
+      def get(
+        id,
+        # Optional client generated identifier to trace and debug a series of requests.
+        correlation_id: nil,
+        # Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # For use by platforms to specify an account id and set scope of a request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Hold a payout to prevent it from being processed. The status of the payout must
+      # be `created`, `scheduled`, or `on_hold`.
+      sig do
+        params(
+          id: String,
+          reason: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PayoutV1)
+      end
+      def hold(
+        # Path param:
+        id,
+        # Body param: Details about why the payout status was updated.
+        reason:,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: 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
+
+      # Release a payout from a `hold` status to allow it to be rescheduled for
+      # processing.
+      sig do
+        params(
+          id: String,
+          reason: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PayoutV1)
+      end
+      def release(
+        # Path param:
+        id,
+        # Body param: Details about why the payout status was updated.
+        reason:,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: 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
+
+      # Get a payout by id.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::Models::PayoutUnmaskResponse)
+      end
+      def unmask(
+        id,
+        # Optional client generated identifier to trace and debug a series of requests.
+        correlation_id: nil,
+        # Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # 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:)
+      end
+    end
+  end
+end

data/rbi/straddle/resources/reports.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Reports
+      sig do
+        params(
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::Models::ReportCreateTotalCustomersByStatusResponse)
+      end
+      def create_total_customers_by_status(
+        # Optional client generated identifier to trace and debug a series of requests.
+        correlation_id: nil,
+        # Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # 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:)
+      end
+    end
+  end
+end

data/rbi/straddle/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module Straddle
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/straddle/client.rbs

@@ -0,0 +1,48 @@
+module Straddle
+  class Client < Straddle::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    ENVIRONMENTS: {
+      production: "https://production.straddle.io",
+      sandbox: "https://sandbox.straddle.io"
+    }
+
+    attr_reader api_key: String
+
+    attr_reader embed: Straddle::Resources::Embed
+
+    attr_reader bridge: Straddle::Resources::Bridge
+
+    attr_reader customers: Straddle::Resources::Customers
+
+    attr_reader paykeys: Straddle::Resources::Paykeys
+
+    attr_reader charges: Straddle::Resources::Charges
+
+    attr_reader funding_events: Straddle::Resources::FundingEvents
+
+    attr_reader payments: Straddle::Resources::Payments
+
+    attr_reader payouts: Straddle::Resources::Payouts
+
+    attr_reader reports: Straddle::Resources::Reports
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?environment: :production | :sandbox | nil,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end