straddle 0.4.0 → 1.0.0

data/rbi/straddle/resources/linked_bank_accounts.rbi

@@ -0,0 +1,208 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    # Linked bank accounts connect external bank accounts to an account or platform
+    # for charges, payouts, or billing.
+    class LinkedBankAccounts
+      # Creates a linked bank account for an account or platform, assigns its payment
+      # purposes, and returns the linked bank account.
+      sig do
+        params(
+          bank_account:
+            Straddle::LinkedBankAccountCreateParams::BankAccount::OrHash,
+          account_id: T.nilable(String),
+          description: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          platform_id: T.nilable(String),
+          purposes:
+            T.nilable(
+              T::Array[
+                Straddle::LinkedBankAccountCreateParams::Purpose::OrSymbol
+              ]
+            ),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::LinkedBankAccountResponse)
+      end
+      def create(
+        # Body param
+        bank_account:,
+        # Body param: ID of the account that will own the linked bank account. Omit this
+        # field to assign ownership to the platform in the authenticated request context.
+        account_id: nil,
+        # Body param: Your description for the linked bank account.
+        description: nil,
+        # Body param: Up to 20 user-defined key-value pairs.
+        metadata: nil,
+        # Body param: ID of the platform to associate with the linked bank account.
+        platform_id: nil,
+        # Body param: Payment purposes for the linked bank account. Defaults to `charges`,
+        # `payouts`, and `billing`.
+        purposes: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns the linked bank account with the specified ID. The response masks the
+      # account number.
+      sig do
+        params(
+          linked_bank_account_id: String,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::LinkedBankAccountResponse)
+      end
+      def retrieve(
+        # The ID of the linked bank account.
+        linked_bank_account_id,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Updates bank account details and metadata, then returns the linked bank account.
+      # The linked bank account must have status `created`, or status `onboarding` with
+      # `status_detail.reason` set to `stuck`.
+      sig do
+        params(
+          linked_bank_account_id: String,
+          bank_account:
+            Straddle::LinkedBankAccountUpdateParams::BankAccount::OrHash,
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::LinkedBankAccountResponse)
+      end
+      def update(
+        # Path param: The ID of the linked bank account.
+        linked_bank_account_id,
+        # Body param
+        bank_account:,
+        # Body param: Up to 20 user-defined key-value pairs.
+        metadata: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a paginated list of linked bank accounts. Filter the list by account,
+      # scope, purpose, or status.
+      sig do
+        params(
+          account_id: String,
+          level: Straddle::LinkedBankAccountListParams::Level::OrSymbol,
+          page_number: Integer,
+          page_size: Integer,
+          purpose: Straddle::LinkedBankAccountListParams::Purpose::OrSymbol,
+          sort_by: String,
+          sort_order:
+            Straddle::LinkedBankAccountListParams::SortOrder::OrSymbol,
+          status: Straddle::LinkedBankAccountListParams::Status::OrSymbol,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::LinkedBankAccountList)
+      end
+      def list(
+        # Query param: Account ID used to filter the results.
+        account_id: nil,
+        # Query param: Scope of linked bank accounts to return.
+        level: nil,
+        # Query param: Page number. Defaults to `1`.
+        page_number: nil,
+        # Query param: Number of results per page. Defaults to `100`. Maximum `1000`.
+        page_size: nil,
+        # Query param: Linked bank account purpose. Accepted values are `charges`,
+        # `payouts`, and `billing`.
+        purpose: nil,
+        # Query param: Field used to sort results. Defaults to `id`.
+        sort_by: nil,
+        # Query param: Sort direction. Defaults to `asc`.
+        sort_order: nil,
+        # Query param: Linked bank account status. Accepted values are `created`,
+        # `onboarding`, `active`, `rejected`, `inactive`, and `canceled`.
+        status: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Cancels a linked bank account and returns it with status `canceled`. The linked
+      # bank account must have status `created`.
+      sig do
+        params(
+          linked_bank_account_id: String,
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::LinkedBankAccountResponse)
+      end
+      def cancel(
+        # The ID of the linked bank account.
+        linked_bank_account_id,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns the linked bank account with the specified ID without masking its
+      # account number. This endpoint is available only when Straddle enables data
+      # unmasking for the account.
+      sig do
+        params(
+          linked_bank_account_id: String,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::UnmaskedLinkedBankAccountResponse)
+      end
+      def list_unmasked(
+        # The ID of the linked bank account.
+        linked_bank_account_id,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_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/organizations.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    # Organizations group related Straddle accounts.
+    class Organizations
+      # Creates an organization for your platform and returns it. Organizations group
+      # related accounts and users.
+      sig do
+        params(
+          name: String,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::OrganizationResponse)
+      end
+      def create(
+        # Body param: Organization name.
+        name:,
+        # Body param: Your unique ID for the organization.
+        external_id: nil,
+        # Body param: Up to 20 user-defined key-value pairs.
+        metadata: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns the organization with the specified ID.
+      sig do
+        params(
+          organization_id: String,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::OrganizationResponse)
+      end
+      def retrieve(
+        # The ID of the organization.
+        organization_id,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a paginated list of organizations for your platform. Filter the list by
+      # name or external ID.
+      sig do
+        params(
+          external_id: String,
+          name: String,
+          page_number: Integer,
+          page_size: Integer,
+          sort_by: String,
+          sort_order: Straddle::OrganizationListParams::SortOrder::OrSymbol,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::OrganizationList)
+      end
+      def list(
+        # Query param: Your external ID for the organization.
+        external_id: nil,
+        # Query param: Organization name. Supports partial matches.
+        name: nil,
+        # Query param: Page number. Defaults to `1`.
+        page_number: nil,
+        # Query param: Number of results per page. Defaults to `100`. Maximum `1000`.
+        page_size: nil,
+        # Query param: Field used to sort results. Defaults to `id`.
+        sort_by: nil,
+        # Query param: Sort direction. Defaults to `asc`.
+        sort_order: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_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/paykeys/review.rbi

@@ -3,44 +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.
+      # A paykey links a verified customer to a bank account without exposing bank
+      # account details. Use a paykey to create charges and payouts.
       class Review
-        # Update the status of a paykey when in review status
-        sig do
-          params(
-            id: String,
-            status: Straddle::Paykeys::ReviewDecisionParams::Status::OrSymbol,
-            correlation_id: String,
-            idempotency_key: String,
-            request_id: String,
-            straddle_account_id: String,
-            request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::PaykeyV1)
-        end
-        def decision(
-          # Path param
-          id,
-          # Body param
-          status:,
-          # 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
-
-        # Get additional details about a paykey.
+        # Returns a paykey verification review, including the decision, score breakdowns,
+        # and result codes.
         sig do
           params(
             id: String,
@@ -48,42 +15,49 @@ module Straddle
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::Models::Paykeys::ReviewGetResponse)
+          ).returns(Straddle::Paykeys::PaykeyReviewResponse)
         end
-        def get(
+        def list(
+          # Unique identifier for the paykey.
           id,
-          # Optional client generated identifier to trace and debug a series of requests.
+          # Optional client-generated identifier for tracing a series of related requests.
           correlation_id: nil,
-          # Optional client generated identifier to trace and debug a request.
+          # Optional client-generated identifier for tracing one request.
           request_id: nil,
-          # For use by platforms to specify an account id and set scope of a request.
+          # For platform requests, the embedded account UUID that sets the request scope.
           straddle_account_id: nil,
           request_options: {}
         )
         end
 
-        # Updates the decision of a paykey's review validation. This endpoint allows you
-        # to refresh the outcome of a paykey's decision and is useful for correcting or
-        # updating the status of a paykey's verification.
+        # Updates the verification decision for a paykey. The paykey's current `status`
+        # must be `review`.
         sig do
           params(
             id: String,
+            status:
+              Straddle::Paykeys::ReviewSetVerificationDecisionParams::Status::OrSymbol,
             correlation_id: String,
             idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
-          ).returns(Straddle::PaykeyV1)
+          ).returns(Straddle::PaykeyResponse)
         end
-        def refresh_review(
+        def set_verification_decision(
+          # Path param: Unique identifier for the paykey.
           id,
-          # Optional client generated identifier to trace and debug a series of requests.
+          # Body param
+          status:,
+          # Header param: Optional client-generated identifier for tracing a series of
+          # related requests.
           correlation_id: nil,
-          # Optional client generated value to use for idempotent requests.
+          # Header param: Optional client-generated key for an idempotent request.
           idempotency_key: nil,
-          # Optional client generated identifier to trace and debug a request.
+          # Header param: Optional client-generated identifier for tracing one request.
           request_id: nil,
-          # For use by platforms to specify an account id and set scope of a request.
+          # Header param: For platform requests, the embedded account UUID that sets the
+          # request scope.
           straddle_account_id: nil,
           request_options: {}
         )