straddle 0.5.0 → 1.0.0

data/rbi/straddle/models/charge_hold_params.rbi

@@ -14,28 +14,32 @@ module Straddle
       sig { returns(String) }
       attr_accessor :id
 
-      # Details about why the charge status was updated.
+      # Message explaining the charge status change.
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # Optional client-generated identifier for tracing a series of related requests.
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
+      # Optional client-generated key for an idempotent request.
       sig { returns(T.nilable(String)) }
       attr_reader :idempotency_key
 
       sig { params(idempotency_key: String).void }
       attr_writer :idempotency_key
 
+      # Optional client-generated identifier for tracing one request.
       sig { returns(T.nilable(String)) }
       attr_reader :request_id
 
       sig { params(request_id: String).void }
       attr_writer :request_id
 
+      # For platform requests, the embedded account UUID that sets the request scope.
       sig { returns(T.nilable(String)) }
       attr_reader :straddle_account_id
 
@@ -55,11 +59,15 @@ module Straddle
       end
       def self.new(
         id:,
-        # Details about why the charge status was updated.
+        # Message explaining the charge status change.
         reason: nil,
+        # 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,
+        # For platform requests, the embedded account UUID that sets the request scope.
         straddle_account_id: nil,
         request_options: {}
       )

data/rbi/straddle/models/charge_list_unmasked_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class ChargeListUnmaskedParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::ChargeListUnmaskedParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      # For platform requests, the embedded account UUID that sets the request scope.
+      sig { returns(T.nilable(String)) }
+      attr_reader :straddle_account_id
+
+      sig { params(straddle_account_id: String).void }
+      attr_writer :straddle_account_id
+
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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,
+        # For platform requests, the embedded account UUID that sets the request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/charge_refund_params.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class ChargeRefundParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::ChargeRefundParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Refund amount in cents. `null` refunds the full original amount. A value must be
+      # greater than zero and no more than the original charge amount.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :amount
+
+      # Description for the refund payout. Defaults to a description that identifies the
+      # original charge.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Your unique identifier for the refund. Defaults to a new value if omitted.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
+      # User-defined string key-value pairs for the refund payout.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      # Date when Straddle submits the refund payout for processing. Defaults to today
+      # if omitted.
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :payment_date
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated key for an idempotent request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      # For platform requests, the embedded account UUID that sets the request scope.
+      sig { returns(T.nilable(String)) }
+      attr_reader :straddle_account_id
+
+      sig { params(straddle_account_id: String).void }
+      attr_writer :straddle_account_id
+
+      sig do
+        params(
+          id: String,
+          amount: T.nilable(Integer),
+          description: T.nilable(String),
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          payment_date: T.nilable(Date),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Refund amount in cents. `null` refunds the full original amount. A value must be
+        # greater than zero and no more than the original charge amount.
+        amount: nil,
+        # Description for the refund payout. Defaults to a description that identifies the
+        # original charge.
+        description: nil,
+        # Your unique identifier for the refund. Defaults to a new value if omitted.
+        external_id: nil,
+        # User-defined string key-value pairs for the refund payout.
+        metadata: nil,
+        # Date when Straddle submits the refund payout for processing. Defaults to today
+        # if omitted.
+        payment_date: nil,
+        # 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,
+        # For platform requests, the embedded account UUID that sets the request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            amount: T.nilable(Integer),
+            description: T.nilable(String),
+            external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            payment_date: T.nilable(Date),
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/charge_release_params.rbi

@@ -14,28 +14,32 @@ module Straddle
       sig { returns(String) }
       attr_accessor :id
 
-      # Details about why the charge status was updated.
+      # Message explaining the charge status change.
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # Optional client-generated identifier for tracing a series of related requests.
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
+      # Optional client-generated key for an idempotent request.
       sig { returns(T.nilable(String)) }
       attr_reader :idempotency_key
 
       sig { params(idempotency_key: String).void }
       attr_writer :idempotency_key
 
+      # Optional client-generated identifier for tracing one request.
       sig { returns(T.nilable(String)) }
       attr_reader :request_id
 
       sig { params(request_id: String).void }
       attr_writer :request_id
 
+      # For platform requests, the embedded account UUID that sets the request scope.
       sig { returns(T.nilable(String)) }
       attr_reader :straddle_account_id
 
@@ -55,11 +59,15 @@ module Straddle
       end
       def self.new(
         id:,
-        # Details about why the charge status was updated.
+        # Message explaining the charge status change.
         reason: nil,
+        # 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,
+        # For platform requests, the embedded account UUID that sets the request scope.
         straddle_account_id: nil,
         request_options: {}
       )

data/rbi/straddle/models/charge_response.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class ChargeResponse < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::ChargeResponse, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::Charge) }
+      attr_reader :data
+
+      sig { params(data: Straddle::Charge::OrHash).void }
+      attr_writer :data
+
+      # Metadata for an API request.
+      sig { returns(Straddle::ResponseMetadata) }
+      attr_reader :meta
+
+      sig { params(meta: Straddle::ResponseMetadata::OrHash).void }
+      attr_writer :meta
+
+      # Shape of the response envelope.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of JSON objects.
+      # - `error` means `error` contains the error details.
+      # - `none` means the response contains no data.
+      sig { returns(Straddle::ResponseType::TaggedSymbol) }
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: Straddle::Charge::OrHash,
+          meta: Straddle::ResponseMetadata::OrHash,
+          response_type: Straddle::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Metadata for an API request.
+        meta:,
+        # Shape of the response envelope.
+        #
+        # - `object` means `data` contains one JSON object.
+        # - `array` means `data` contains an array of JSON objects.
+        # - `error` means `error` contains the error details.
+        # - `none` means the response contains no data.
+        response_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Straddle::Charge,
+            meta: Straddle::ResponseMetadata,
+            response_type: Straddle::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/charge_resubmit_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class ChargeResubmitParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::ChargeResubmitParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Description for the resubmitted charge. Defaults to the original description if
+      # omitted.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Your unique identifier for the resubmitted charge. Defaults to a new value if
+      # omitted.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
+      # Date when Straddle submits the resubmitted charge for processing. Defaults to
+      # today if omitted.
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :payment_date
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated key for an idempotent request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      # For platform requests, the embedded account UUID that sets the request scope.
+      sig { returns(T.nilable(String)) }
+      attr_reader :straddle_account_id
+
+      sig { params(straddle_account_id: String).void }
+      attr_writer :straddle_account_id
+
+      sig do
+        params(
+          id: String,
+          description: T.nilable(String),
+          external_id: T.nilable(String),
+          payment_date: T.nilable(Date),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Description for the resubmitted charge. Defaults to the original description if
+        # omitted.
+        description: nil,
+        # Your unique identifier for the resubmitted charge. Defaults to a new value if
+        # omitted.
+        external_id: nil,
+        # Date when Straddle submits the resubmitted charge for processing. Defaults to
+        # today if omitted.
+        payment_date: nil,
+        # 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,
+        # For platform requests, the embedded account UUID that sets the request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            description: T.nilable(String),
+            external_id: T.nilable(String),
+            payment_date: T.nilable(Date),
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/charge_retrieve_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class ChargeRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::ChargeRetrieveParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      # For platform requests, the embedded account UUID that sets the request scope.
+      sig { returns(T.nilable(String)) }
+      attr_reader :straddle_account_id
+
+      sig { params(straddle_account_id: String).void }
+      attr_writer :straddle_account_id
+
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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,
+        # For platform requests, the embedded account UUID that sets the request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/charge_settings.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class ChargeSettings < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::ChargeSettings, Straddle::Internal::AnyHash)
+        end
+
+      # Daily charge amount limit in cents.
+      sig { returns(Integer) }
+      attr_accessor :daily_amount
+
+      # Maximum amount in cents for one charge.
+      sig { returns(Integer) }
+      attr_accessor :max_amount
+
+      # Monthly charge amount limit in cents.
+      sig { returns(Integer) }
+      attr_accessor :monthly_amount
+
+      # Maximum number of charges per calendar month.
+      sig { returns(Integer) }
+      attr_accessor :monthly_count
+
+      # Funding schedule applied to charges.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :funding_time
+
+      # ID of the linked bank account used for charge settlement.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :linked_bank_account_id
+
+      sig do
+        params(
+          daily_amount: Integer,
+          max_amount: Integer,
+          monthly_amount: Integer,
+          monthly_count: Integer,
+          funding_time: T.nilable(String),
+          linked_bank_account_id: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Daily charge amount limit in cents.
+        daily_amount:,
+        # Maximum amount in cents for one charge.
+        max_amount:,
+        # Monthly charge amount limit in cents.
+        monthly_amount:,
+        # Maximum number of charges per calendar month.
+        monthly_count:,
+        # Funding schedule applied to charges.
+        funding_time: nil,
+        # ID of the linked bank account used for charge settlement.
+        linked_bank_account_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            daily_amount: Integer,
+            max_amount: Integer,
+            monthly_amount: Integer,
+            monthly_count: Integer,
+            funding_time: T.nilable(String),
+            linked_bank_account_id: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end