straddle 0.1.0.pre.alpha.1 → 0.2.0

data/lib/straddle/resources/payouts.rb

@@ -8,7 +8,7 @@ module Straddle
       #
       # Use payouts to send money to your customers.
       #
-      # @overload create(amount:, currency:, description:, device:, external_id:, paykey:, payment_date:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload create(amount:, currency:, description:, device:, external_id:, paykey:, payment_date:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param amount [Integer] Body param: The amount of the payout in cents.
       #
@@ -30,6 +30,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -44,6 +46,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -63,7 +66,7 @@ module Straddle
       # Update the details of a payout prior to processing. The status of the payout
       # must be `created`, `scheduled`, or `on_hold`.
       #
-      # @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -77,6 +80,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -91,6 +96,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -110,7 +116,7 @@ module Straddle
       # Cancel a payout to prevent it from being processed. The status of the payout
       # must be `created`, `scheduled`, or `on_hold`.
       #
-      # @overload cancel(id, reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload cancel(id, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -118,6 +124,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -132,6 +140,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -184,7 +193,7 @@ module Straddle
       # Hold a payout to prevent it from being processed. The status of the payout must
       # be `created`, `scheduled`, or `on_hold`.
       #
-      # @overload hold(id, reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload hold(id, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -192,6 +201,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -206,6 +217,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }
@@ -225,7 +237,7 @@ module Straddle
       # Release a payout from a `hold` status to allow it to be rescheduled for
       # processing.
       #
-      # @overload release(id, reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload release(id, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String] Path param:
       #
@@ -233,6 +245,8 @@ module Straddle
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
+      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -247,6 +261,7 @@ module Straddle
         header_params =
           {
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           }

data/lib/straddle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Straddle
-  VERSION = "0.1.0.pre.alpha.1"
+  VERSION = "0.2.0"
 end

data/lib/straddle.rb

@@ -101,6 +101,7 @@ require_relative "straddle/models/embed/address_v1"
 require_relative "straddle/models/embed/business_profile_v1"
 require_relative "straddle/models/embed/capability_v1"
 require_relative "straddle/models/embed/industry_v1"
+require_relative "straddle/models/embed/linked_bank_account_cancel_params"
 require_relative "straddle/models/embed/linked_bank_account_create_params"
 require_relative "straddle/models/embed/linked_bank_account_get_params"
 require_relative "straddle/models/embed/linked_bank_account_list_params"
@@ -134,6 +135,7 @@ require_relative "straddle/models/paykey_get_params"
 require_relative "straddle/models/paykey_list_params"
 require_relative "straddle/models/paykey_reveal_params"
 require_relative "straddle/models/paykey_reveal_response"
+require_relative "straddle/models/paykey_review_params"
 require_relative "straddle/models/paykey_summary_paged_v1"
 require_relative "straddle/models/paykey_unmasked_params"
 require_relative "straddle/models/paykey_unmasked_v1"

data/rbi/straddle/client.rbi

@@ -13,8 +13,8 @@ module Straddle
     ENVIRONMENTS =
       T.let(
         {
-          production: "https://production.straddle.io",
-          sandbox: "https://sandbox.straddle.io"
+          sandbox: "https://sandbox.straddle.com",
+          production: "https://production.straddle.com"
         },
         T::Hash[Symbol, String]
       )
@@ -76,8 +76,8 @@ module Straddle
       #
       # Each environment maps to a different base URL:
       #
-      # - `production` corresponds to `https://production.straddle.io`
-      # - `sandbox` corresponds to `https://sandbox.straddle.io`
+      # - `sandbox` corresponds to `https://sandbox.straddle.com`
+      # - `production` corresponds to `https://production.straddle.com`
       environment: nil,
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["STRADDLE_BASE_URL"]`

data/rbi/straddle/errors.rbi

@@ -33,6 +33,9 @@ module Straddle
       sig { returns(T.nilable(Integer)) }
       attr_accessor :status
 
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
       sig { returns(T.nilable(T.anything)) }
       attr_accessor :body
 
@@ -41,6 +44,7 @@ module Straddle
         params(
           url: URI::Generic,
           status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
@@ -50,6 +54,7 @@ module Straddle
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -59,10 +64,10 @@ module Straddle
     end
 
     class APIConnectionError < Straddle::Errors::APIError
-      sig { void }
+      sig { returns(NilClass) }
       attr_accessor :status
 
-      sig { void }
+      sig { returns(NilClass) }
       attr_accessor :body
 
       # @api private
@@ -70,6 +75,7 @@ module Straddle
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -79,6 +85,7 @@ module Straddle
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -93,6 +100,7 @@ module Straddle
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -102,6 +110,7 @@ module Straddle
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,13 +125,22 @@ module Straddle
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil)
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
 
       sig { returns(Integer) }
@@ -133,13 +151,22 @@ module Straddle
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil)
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
     end
 

data/rbi/straddle/file_part.rbi

@@ -27,7 +27,7 @@ module Straddle
     sig do
       params(
         content: T.any(Pathname, StringIO, IO, String),
-        filename: T.nilable(String),
+        filename: T.nilable(T.any(Pathname, String)),
         content_type: T.nilable(String)
       ).returns(T.attached_class)
     end

data/rbi/straddle/internal/transport/base_client.rbi

@@ -84,10 +84,9 @@ module Straddle
 
           # @api private
           sig do
-            params(
-              status: Integer,
-              headers: T.any(T::Hash[String, String], Net::HTTPHeader)
-            ).returns(T::Boolean)
+            params(status: Integer, headers: T::Hash[String, String]).returns(
+              T::Boolean
+            )
           end
           def should_retry?(status, headers:)
           end
@@ -97,7 +96,7 @@ module Straddle
             params(
               request: Straddle::Internal::Transport::BaseClient::RequestInput,
               status: Integer,
-              response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+              response_headers: T::Hash[String, String]
             ).returns(Straddle::Internal::Transport::BaseClient::RequestInput)
           end
           def follow_redirect(request, status:, response_headers:)
@@ -213,7 +212,7 @@ module Straddle
             send_retry_header: T::Boolean
           ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
         end
-        private def send_request(
+        def send_request(
           request,
           redirect_count:,
           retry_count:,

data/rbi/straddle/internal/type/base_page.rbi

@@ -30,7 +30,7 @@ module Straddle
           params(
             client: Straddle::Internal::Transport::BaseClient,
             req: Straddle::Internal::Transport::BaseClient::RequestComponents,
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             page_data: T.anything
           ).void
         end

data/rbi/straddle/internal/type/converter.rbi

@@ -90,6 +90,60 @@ module Straddle
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(
+              type_info:
+                T.any(
+                  {
+                    const:
+                      T.nilable(
+                        T.any(NilClass, T::Boolean, Integer, Float, Symbol)
+                      ),
+                    enum:
+                      T.nilable(
+                        T.proc.returns(
+                          Straddle::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          Straddle::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(Straddle::Internal::Type::Converter::Input),
+                  Straddle::Internal::Type::Converter::Input
+                ),
+              spec:
+                T.any(
+                  {
+                    const:
+                      T.nilable(
+                        T.any(NilClass, T::Boolean, Integer, Float, Symbol)
+                      ),
+                    enum:
+                      T.nilable(
+                        T.proc.returns(
+                          Straddle::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          Straddle::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(Straddle::Internal::Type::Converter::Input),
+                  Straddle::Internal::Type::Converter::Input
+                )
+            ).returns(Straddle::Internal::AnyHash)
+          end
+          def self.meta_info(type_info, spec)
+          end
+
           # @api private
           sig do
             params(translate_names: T::Boolean).returns(

data/rbi/straddle/internal/type/union.rbi

@@ -16,7 +16,8 @@ module Straddle
             T::Array[
               [
                 T.nilable(Symbol),
-                T.proc.returns(Straddle::Internal::Type::Converter::Input)
+                T.proc.returns(Straddle::Internal::Type::Converter::Input),
+                Straddle::Internal::AnyHash
               ]
             ]
           )
@@ -25,7 +26,13 @@ module Straddle
         end
 
         # @api private
-        sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) }
+        sig do
+          returns(
+            T::Array[
+              [T.nilable(Symbol), T.anything, Straddle::Internal::AnyHash]
+            ]
+          )
+        end
         protected def derefed_variants
         end
 

data/rbi/straddle/internal/util.rbi

@@ -361,7 +361,7 @@ module Straddle
         # Assumes each chunk in stream has `Encoding::BINARY`.
         sig do
           params(
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             stream: T::Enumerable[String],
             suppress_error: T::Boolean
           ).returns(T.anything)

data/rbi/straddle/models/bridge/link_bank_account_params.rbi

@@ -57,6 +57,12 @@ module Straddle
         sig { params(correlation_id: String).void }
         attr_writer :correlation_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig { returns(T.nilable(String)) }
         attr_reader :request_id
 
@@ -79,6 +85,7 @@ module Straddle
             config: Straddle::Bridge::LinkBankAccountParams::Config::OrHash,
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
@@ -97,6 +104,7 @@ module Straddle
           # information about the paykey in a structured format.
           metadata: nil,
           correlation_id: nil,
+          idempotency_key: nil,
           request_id: nil,
           straddle_account_id: nil,
           request_options: {}
@@ -114,6 +122,7 @@ module Straddle
               config: Straddle::Bridge::LinkBankAccountParams::Config,
               metadata: T.nilable(T::Hash[Symbol, String]),
               correlation_id: String,
+              idempotency_key: String,
               request_id: String,
               straddle_account_id: String,
               request_options: Straddle::RequestOptions

data/rbi/straddle/models/bridge/link_create_paykey_params.rbi

@@ -47,6 +47,12 @@ module Straddle
         sig { params(correlation_id: String).void }
         attr_writer :correlation_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig { returns(T.nilable(String)) }
         attr_reader :request_id
 
@@ -66,6 +72,7 @@ module Straddle
             config: Straddle::Bridge::LinkCreatePaykeyParams::Config::OrHash,
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
@@ -82,6 +89,7 @@ module Straddle
           # information about the paykey in a structured format.
           metadata: nil,
           correlation_id: nil,
+          idempotency_key: nil,
           request_id: nil,
           straddle_account_id: nil,
           request_options: {}
@@ -96,6 +104,7 @@ module Straddle
               config: Straddle::Bridge::LinkCreatePaykeyParams::Config,
               metadata: T.nilable(T::Hash[Symbol, String]),
               correlation_id: String,
+              idempotency_key: String,
               request_id: String,
               straddle_account_id: String,
               request_options: Straddle::RequestOptions

data/rbi/straddle/models/bridge/link_create_tan_params.rbi

@@ -55,6 +55,12 @@ module Straddle
         sig { params(correlation_id: String).void }
         attr_writer :correlation_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig { returns(T.nilable(String)) }
         attr_reader :request_id
 
@@ -77,6 +83,7 @@ module Straddle
             config: Straddle::Bridge::LinkCreateTanParams::Config::OrHash,
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
@@ -95,6 +102,7 @@ module Straddle
           # information about the paykey in a structured format.
           metadata: nil,
           correlation_id: nil,
+          idempotency_key: nil,
           request_id: nil,
           straddle_account_id: nil,
           request_options: {}
@@ -112,6 +120,7 @@ module Straddle
               config: Straddle::Bridge::LinkCreateTanParams::Config,
               metadata: T.nilable(T::Hash[Symbol, String]),
               correlation_id: String,
+              idempotency_key: String,
               request_id: String,
               straddle_account_id: String,
               request_options: Straddle::RequestOptions

data/rbi/straddle/models/bridge/link_plaid_params.rbi

@@ -43,6 +43,12 @@ module Straddle
         sig { params(correlation_id: String).void }
         attr_writer :correlation_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig { returns(T.nilable(String)) }
         attr_reader :request_id
 
@@ -62,6 +68,7 @@ module Straddle
             config: Straddle::Bridge::LinkPlaidParams::Config::OrHash,
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions::OrHash
@@ -78,6 +85,7 @@ module Straddle
           # information about the paykey in a structured format.
           metadata: nil,
           correlation_id: nil,
+          idempotency_key: nil,
           request_id: nil,
           straddle_account_id: nil,
           request_options: {}
@@ -92,6 +100,7 @@ module Straddle
               config: Straddle::Bridge::LinkPlaidParams::Config,
               metadata: T.nilable(T::Hash[Symbol, String]),
               correlation_id: String,
+              idempotency_key: String,
               request_id: String,
               straddle_account_id: String,
               request_options: Straddle::RequestOptions

data/rbi/straddle/models/bridge_initialize_params.rbi

@@ -30,6 +30,12 @@ module Straddle
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
       sig { returns(T.nilable(String)) }
       attr_reader :request_id
 
@@ -47,6 +53,7 @@ module Straddle
           customer_id: String,
           config: Straddle::BridgeInitializeParams::Config::OrHash,
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -58,6 +65,7 @@ module Straddle
         customer_id:,
         config: nil,
         correlation_id: nil,
+        idempotency_key: nil,
         request_id: nil,
         straddle_account_id: nil,
         request_options: {}
@@ -70,6 +78,7 @@ module Straddle
             customer_id: String,
             config: Straddle::BridgeInitializeParams::Config,
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions

data/rbi/straddle/models/charge_cancel_params.rbi

@@ -21,6 +21,12 @@ module Straddle
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
       sig { returns(T.nilable(String)) }
       attr_reader :request_id
 
@@ -37,6 +43,7 @@ module Straddle
         params(
           reason: T.nilable(String),
           correlation_id: String,
+          idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
@@ -46,6 +53,7 @@ module Straddle
         # Details about why the charge status was updated.
         reason: nil,
         correlation_id: nil,
+        idempotency_key: nil,
         request_id: nil,
         straddle_account_id: nil,
         request_options: {}
@@ -57,6 +65,7 @@ module Straddle
           {
             reason: T.nilable(String),
             correlation_id: String,
+            idempotency_key: String,
             request_id: String,
             straddle_account_id: String,
             request_options: Straddle::RequestOptions