straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/account_payout_settings.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountPayoutSettings < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountPayoutSettings, Straddle::Internal::AnyHash)
+        end
+
+      # Daily payout amount limit in cents.
+      sig { returns(Integer) }
+      attr_accessor :daily_amount
+
+      # Funding schedule for payouts. Straddle sets this value.
+      sig do
+        returns(Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol)
+      end
+      attr_accessor :funding_time
+
+      # ID of the linked bank account used for payout settlement.
+      sig { returns(String) }
+      attr_accessor :linked_bank_account_id
+
+      # Maximum amount in cents for one payout.
+      sig { returns(Integer) }
+      attr_accessor :max_amount
+
+      # Monthly payout amount limit in cents.
+      sig { returns(Integer) }
+      attr_accessor :monthly_amount
+
+      # Maximum number of payouts per calendar month.
+      sig { returns(Integer) }
+      attr_accessor :monthly_count
+
+      sig do
+        params(
+          daily_amount: Integer,
+          funding_time: Straddle::AccountPayoutSettings::FundingTime::OrSymbol,
+          linked_bank_account_id: String,
+          max_amount: Integer,
+          monthly_amount: Integer,
+          monthly_count: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Daily payout amount limit in cents.
+        daily_amount:,
+        # Funding schedule for payouts. Straddle sets this value.
+        funding_time:,
+        # ID of the linked bank account used for payout settlement.
+        linked_bank_account_id:,
+        # Maximum amount in cents for one payout.
+        max_amount:,
+        # Monthly payout amount limit in cents.
+        monthly_amount:,
+        # Maximum number of payouts per calendar month.
+        monthly_count:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            daily_amount: Integer,
+            funding_time:
+              Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol,
+            linked_bank_account_id: String,
+            max_amount: Integer,
+            monthly_amount: Integer,
+            monthly_count: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Funding schedule for payouts. Straddle sets this value.
+      module FundingTime
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::AccountPayoutSettings::FundingTime)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IMMEDIATE =
+          T.let(
+            :immediate,
+            Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol
+          )
+        NEXT_DAY =
+          T.let(
+            :next_day,
+            Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol
+          )
+        ONE_DAY =
+          T.let(
+            :one_day,
+            Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol
+          )
+        TWO_DAY =
+          T.let(
+            :two_day,
+            Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol
+          )
+        THREE_DAY =
+          T.let(
+            :three_day,
+            Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol
+          )
+        FOUR_DAY =
+          T.let(
+            :four_day,
+            Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol
+          )
+        FIVE_DAY =
+          T.let(
+            :five_day,
+            Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::AccountPayoutSettings::FundingTime::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_policy_controls.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountPolicyControls < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountPolicyControls, Straddle::Internal::AnyHash)
+        end
+
+      # Whether customer identity verification can be skipped.
+      sig { returns(T::Boolean) }
+      attr_accessor :allow_customer_identity_skip
+
+      # Whether the account can retrieve unmasked sensitive fields.
+      sig { returns(T::Boolean) }
+      attr_accessor :allow_data_unmask
+
+      # Whether multiple customers can share one email address.
+      sig { returns(T::Boolean) }
+      attr_accessor :allow_duplicate_email
+
+      # Whether paykey verification can be skipped.
+      sig { returns(T::Boolean) }
+      attr_accessor :allow_paykey_verification_skip
+
+      sig do
+        params(
+          allow_customer_identity_skip: T::Boolean,
+          allow_data_unmask: T::Boolean,
+          allow_duplicate_email: T::Boolean,
+          allow_paykey_verification_skip: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether customer identity verification can be skipped.
+        allow_customer_identity_skip:,
+        # Whether the account can retrieve unmasked sensitive fields.
+        allow_data_unmask:,
+        # Whether multiple customers can share one email address.
+        allow_duplicate_email:,
+        # Whether paykey verification can be skipped.
+        allow_paykey_verification_skip:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            allow_customer_identity_skip: T::Boolean,
+            allow_data_unmask: T::Boolean,
+            allow_duplicate_email: T::Boolean,
+            allow_paykey_verification_skip: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_response.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountResponse < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountResponse, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::Account) }
+      attr_reader :data
+
+      sig { params(data: Straddle::Account::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
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      sig { returns(Straddle::AccountResponse::ResponseType::TaggedSymbol) }
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: Straddle::Account::OrHash,
+          meta: Straddle::ResponseMetadata::OrHash,
+          response_type: Straddle::AccountResponse::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Metadata for an API request.
+        meta:,
+        # Indicates how the response content is structured.
+        #
+        # - `object` means `data` contains one JSON object.
+        # - `array` means `data` contains an array of objects.
+        # - `error` means `error` contains error details.
+        # - `none` means the response has no data.
+        response_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Straddle::Account,
+            meta: Straddle::ResponseMetadata,
+            response_type: Straddle::AccountResponse::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::AccountResponse::ResponseType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OBJECT =
+          T.let(:object, Straddle::AccountResponse::ResponseType::TaggedSymbol)
+        ARRAY =
+          T.let(:array, Straddle::AccountResponse::ResponseType::TaggedSymbol)
+        ERROR =
+          T.let(:error, Straddle::AccountResponse::ResponseType::TaggedSymbol)
+        NONE =
+          T.let(:none, Straddle::AccountResponse::ResponseType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Straddle::AccountResponse::ResponseType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_retrieve_params.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountRetrieveParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :account_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
+
+      sig do
+        params(
+          account_id: String,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_setting_retrieve_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountSettingRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::AccountSettingRetrieveParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :account_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
+
+      sig do
+        params(
+          account_id: String,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_settings.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountSettingsAPI < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountSettingsAPI, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::ChargeSettings) }
+      attr_reader :charges
+
+      sig { params(charges: Straddle::ChargeSettings::OrHash).void }
+      attr_writer :charges
+
+      sig { returns(Straddle::AccountPolicyControls) }
+      attr_reader :configuration
+
+      sig do
+        params(configuration: Straddle::AccountPolicyControls::OrHash).void
+      end
+      attr_writer :configuration
+
+      sig { returns(Straddle::AccountConsentSettings) }
+      attr_reader :consent_types
+
+      sig do
+        params(consent_types: Straddle::AccountConsentSettings::OrHash).void
+      end
+      attr_writer :consent_types
+
+      sig { returns(Straddle::AccountCustomerTypeSettings) }
+      attr_reader :customer_types
+
+      sig do
+        params(
+          customer_types: Straddle::AccountCustomerTypeSettings::OrHash
+        ).void
+      end
+      attr_writer :customer_types
+
+      sig { returns(Straddle::AccountPaymentTypeSettings) }
+      attr_reader :payment_types
+
+      sig do
+        params(payment_types: Straddle::AccountPaymentTypeSettings::OrHash).void
+      end
+      attr_writer :payment_types
+
+      sig { returns(Straddle::PayoutSettings) }
+      attr_reader :payouts
+
+      sig { params(payouts: Straddle::PayoutSettings::OrHash).void }
+      attr_writer :payouts
+
+      sig { returns(Straddle::AccountStatementSettings) }
+      attr_reader :statement_settings
+
+      sig do
+        params(
+          statement_settings: Straddle::AccountStatementSettings::OrHash
+        ).void
+      end
+      attr_writer :statement_settings
+
+      sig do
+        params(
+          charges: Straddle::ChargeSettings::OrHash,
+          configuration: Straddle::AccountPolicyControls::OrHash,
+          consent_types: Straddle::AccountConsentSettings::OrHash,
+          customer_types: Straddle::AccountCustomerTypeSettings::OrHash,
+          payment_types: Straddle::AccountPaymentTypeSettings::OrHash,
+          payouts: Straddle::PayoutSettings::OrHash,
+          statement_settings: Straddle::AccountStatementSettings::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        charges:,
+        configuration:,
+        consent_types:,
+        customer_types:,
+        payment_types:,
+        payouts:,
+        statement_settings:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            charges: Straddle::ChargeSettings,
+            configuration: Straddle::AccountPolicyControls,
+            consent_types: Straddle::AccountConsentSettings,
+            customer_types: Straddle::AccountCustomerTypeSettings,
+            payment_types: Straddle::AccountPaymentTypeSettings,
+            payouts: Straddle::PayoutSettings,
+            statement_settings: Straddle::AccountStatementSettings
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/account_settings_response.rbi

@@ -0,0 +1,118 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class AccountSettingsResponse < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::AccountSettingsResponse, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::AccountSettingsAPI) }
+      attr_reader :data
+
+      sig { params(data: Straddle::AccountSettingsAPI::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
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      sig do
+        returns(Straddle::AccountSettingsResponse::ResponseType::TaggedSymbol)
+      end
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: Straddle::AccountSettingsAPI::OrHash,
+          meta: Straddle::ResponseMetadata::OrHash,
+          response_type:
+            Straddle::AccountSettingsResponse::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Metadata for an API request.
+        meta:,
+        # Indicates how the response content is structured.
+        #
+        # - `object` means `data` contains one JSON object.
+        # - `array` means `data` contains an array of objects.
+        # - `error` means `error` contains error details.
+        # - `none` means the response has no data.
+        response_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Straddle::AccountSettingsAPI,
+            meta: Straddle::ResponseMetadata,
+            response_type:
+              Straddle::AccountSettingsResponse::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::AccountSettingsResponse::ResponseType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OBJECT =
+          T.let(
+            :object,
+            Straddle::AccountSettingsResponse::ResponseType::TaggedSymbol
+          )
+        ARRAY =
+          T.let(
+            :array,
+            Straddle::AccountSettingsResponse::ResponseType::TaggedSymbol
+          )
+        ERROR =
+          T.let(
+            :error,
+            Straddle::AccountSettingsResponse::ResponseType::TaggedSymbol
+          )
+        NONE =
+          T.let(
+            :none,
+            Straddle::AccountSettingsResponse::ResponseType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::AccountSettingsResponse::ResponseType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end