straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/transfer_direction.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Straddle
+  module Models
+    # Transfer direction relative to the linked bank account. `deposit` moves funds
+    # into the account, and `withdrawal` moves funds out.
+    module TransferDirection
+      extend Straddle::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Straddle::TransferDirection) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      DEPOSIT = T.let(:deposit, Straddle::TransferDirection::TaggedSymbol)
+      WITHDRAWAL = T.let(:withdrawal, Straddle::TransferDirection::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Straddle::TransferDirection::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/straddle/models/unmasked_charge.rbi

@@ -0,0 +1,273 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class UnmaskedCharge < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::UnmaskedCharge, Straddle::Internal::AnyHash)
+        end
+
+      # Unique identifier for this charge.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Amount in cents.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      sig { returns(Straddle::ChargeConfiguration) }
+      attr_reader :config
+
+      sig { params(config: Straddle::ChargeConfiguration::OrHash).void }
+      attr_writer :config
+
+      # How the customer authorized the charge. `internet` covers online and mobile
+      # authorization. `signed` covers written or PDF-signed agreements.
+      sig { returns(Straddle::ConsentType::TaggedSymbol) }
+      attr_accessor :consent_type
+
+      # Timestamp when this charge was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Currency code. Only `USD` is supported.
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # A human-readable description of the charge.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      sig { returns(Straddle::PaymentDevice) }
+      attr_reader :device
+
+      sig { params(device: Straddle::PaymentDevice::OrHash).void }
+      attr_writer :device
+
+      # Your unique identifier for this charge, used to correlate with your internal
+      # records.
+      sig { returns(String) }
+      attr_accessor :external_id
+
+      # IDs of the funding events that included this charge.
+      sig { returns(T::Array[String]) }
+      attr_accessor :funding_ids
+
+      # Whether an associated payout has refunded this charge.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_refund
+
+      # Whether this charge has been resubmitted.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_resubmit
+
+      # Whether this charge resubmits an original charge.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_resubmit
+
+      # Unmasked paykey token used for this charge.
+      sig { returns(String) }
+      attr_accessor :paykey
+
+      # Date when Straddle submits the charge for processing.
+      sig { returns(Date) }
+      attr_accessor :payment_date
+
+      # The current status of the `charge` or `payout`.
+      sig { returns(Straddle::PaymentStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(Straddle::PaymentStatusDetails) }
+      attr_reader :status_details
+
+      sig do
+        params(status_details: Straddle::PaymentStatusDetails::OrHash).void
+      end
+      attr_writer :status_details
+
+      # Complete ordered history of all status changes for this charge.
+      sig { returns(T::Array[Straddle::PaymentStatusHistory]) }
+      attr_accessor :status_history
+
+      # Trace identifiers from the payment network. Keys depend on the payment rail.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :trace_ids
+
+      # Timestamp when this charge was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Information about the customer associated with the charge or payout.
+      sig { returns(T.nilable(Straddle::CustomerDetails)) }
+      attr_reader :customer_details
+
+      sig { params(customer_details: Straddle::CustomerDetails::OrHash).void }
+      attr_writer :customer_details
+
+      # Authorization documents for this charge, ordered by upload time.
+      sig { returns(T.nilable(T::Array[Straddle::PaymentAuthorizationProof])) }
+      attr_accessor :documents
+
+      # Timestamp when funds were settled. Null until settlement is confirmed.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :effective_at
+
+      # Key-value metadata stored with this charge.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      sig { returns(T.nilable(Straddle::PaykeyDetails)) }
+      attr_reader :paykey_details
+
+      sig { params(paykey_details: Straddle::PaykeyDetails::OrHash).void }
+      attr_writer :paykey_details
+
+      # The payment rail used for the charge or payout.
+      sig { returns(T.nilable(Straddle::PaymentRail::TaggedSymbol)) }
+      attr_reader :payment_rail
+
+      sig { params(payment_rail: Straddle::PaymentRail::OrSymbol).void }
+      attr_writer :payment_rail
+
+      # Timestamp when this charge was submitted to the payment network. Null until
+      # processed.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :processed_at
+
+      # Related payments and their relationship to this charge.
+      sig { returns(T.nilable(T::Array[Straddle::RelatedPayment])) }
+      attr_accessor :related_payments
+
+      sig do
+        params(
+          id: String,
+          amount: Integer,
+          config: Straddle::ChargeConfiguration::OrHash,
+          consent_type: Straddle::ConsentType::OrSymbol,
+          created_at: Time,
+          currency: String,
+          description: T.nilable(String),
+          device: Straddle::PaymentDevice::OrHash,
+          external_id: String,
+          funding_ids: T::Array[String],
+          has_refund: T::Boolean,
+          has_resubmit: T::Boolean,
+          is_resubmit: T::Boolean,
+          paykey: String,
+          payment_date: Date,
+          status: Straddle::PaymentStatus::OrSymbol,
+          status_details: Straddle::PaymentStatusDetails::OrHash,
+          status_history: T::Array[Straddle::PaymentStatusHistory::OrHash],
+          trace_ids: T::Hash[Symbol, String],
+          updated_at: Time,
+          customer_details: Straddle::CustomerDetails::OrHash,
+          documents:
+            T.nilable(T::Array[Straddle::PaymentAuthorizationProof::OrHash]),
+          effective_at: T.nilable(Time),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          paykey_details: Straddle::PaykeyDetails::OrHash,
+          payment_rail: Straddle::PaymentRail::OrSymbol,
+          processed_at: T.nilable(Time),
+          related_payments:
+            T.nilable(T::Array[Straddle::RelatedPayment::OrHash])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for this charge.
+        id:,
+        # Amount in cents.
+        amount:,
+        config:,
+        # How the customer authorized the charge. `internet` covers online and mobile
+        # authorization. `signed` covers written or PDF-signed agreements.
+        consent_type:,
+        # Timestamp when this charge was created.
+        created_at:,
+        # Currency code. Only `USD` is supported.
+        currency:,
+        # A human-readable description of the charge.
+        description:,
+        device:,
+        # Your unique identifier for this charge, used to correlate with your internal
+        # records.
+        external_id:,
+        # IDs of the funding events that included this charge.
+        funding_ids:,
+        # Whether an associated payout has refunded this charge.
+        has_refund:,
+        # Whether this charge has been resubmitted.
+        has_resubmit:,
+        # Whether this charge resubmits an original charge.
+        is_resubmit:,
+        # Unmasked paykey token used for this charge.
+        paykey:,
+        # Date when Straddle submits the charge for processing.
+        payment_date:,
+        # The current status of the `charge` or `payout`.
+        status:,
+        status_details:,
+        # Complete ordered history of all status changes for this charge.
+        status_history:,
+        # Trace identifiers from the payment network. Keys depend on the payment rail.
+        trace_ids:,
+        # Timestamp when this charge was last updated.
+        updated_at:,
+        # Information about the customer associated with the charge or payout.
+        customer_details: nil,
+        # Authorization documents for this charge, ordered by upload time.
+        documents: nil,
+        # Timestamp when funds were settled. Null until settlement is confirmed.
+        effective_at: nil,
+        # Key-value metadata stored with this charge.
+        metadata: nil,
+        paykey_details: nil,
+        # The payment rail used for the charge or payout.
+        payment_rail: nil,
+        # Timestamp when this charge was submitted to the payment network. Null until
+        # processed.
+        processed_at: nil,
+        # Related payments and their relationship to this charge.
+        related_payments: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            amount: Integer,
+            config: Straddle::ChargeConfiguration,
+            consent_type: Straddle::ConsentType::TaggedSymbol,
+            created_at: Time,
+            currency: String,
+            description: T.nilable(String),
+            device: Straddle::PaymentDevice,
+            external_id: String,
+            funding_ids: T::Array[String],
+            has_refund: T::Boolean,
+            has_resubmit: T::Boolean,
+            is_resubmit: T::Boolean,
+            paykey: String,
+            payment_date: Date,
+            status: Straddle::PaymentStatus::TaggedSymbol,
+            status_details: Straddle::PaymentStatusDetails,
+            status_history: T::Array[Straddle::PaymentStatusHistory],
+            trace_ids: T::Hash[Symbol, String],
+            updated_at: Time,
+            customer_details: Straddle::CustomerDetails,
+            documents: T.nilable(T::Array[Straddle::PaymentAuthorizationProof]),
+            effective_at: T.nilable(Time),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            paykey_details: Straddle::PaykeyDetails,
+            payment_rail: Straddle::PaymentRail::TaggedSymbol,
+            processed_at: T.nilable(Time),
+            related_payments: T.nilable(T::Array[Straddle::RelatedPayment])
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/unmasked_charge_response.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class UnmaskedChargeResponse < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::UnmaskedChargeResponse, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::UnmaskedCharge) }
+      attr_reader :data
+
+      sig { params(data: Straddle::UnmaskedCharge::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::UnmaskedCharge::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::UnmaskedCharge,
+            meta: Straddle::ResponseMetadata,
+            response_type: Straddle::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/unmasked_compliance_profile.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module UnmaskedComplianceProfile
+      extend Straddle::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Straddle::UnmaskedComplianceProfile::IndividualComplianceProfile,
+            Straddle::UnmaskedComplianceProfile::BusinessComplianceProfile
+          )
+        end
+
+      class IndividualComplianceProfile < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::UnmaskedComplianceProfile::IndividualComplianceProfile,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # Date of birth in `YYYY-MM-DD` format. Required for Patriot Act-compliant KYC
+        # verification.
+        sig { returns(T.nilable(Date)) }
+        attr_accessor :dob
+
+        # Social Security number in `XXX-XX-XXXX` format. Required for Patriot
+        # Act-compliant KYC verification.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :ssn
+
+        sig do
+          params(dob: T.nilable(Date), ssn: T.nilable(String)).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Date of birth in `YYYY-MM-DD` format. Required for Patriot Act-compliant KYC
+          # verification.
+          dob:,
+          # Social Security number in `XXX-XX-XXXX` format. Required for Patriot
+          # Act-compliant KYC verification.
+          ssn:
+        )
+        end
+
+        sig do
+          override.returns({ dob: T.nilable(Date), ssn: T.nilable(String) })
+        end
+        def to_hash
+        end
+      end
+
+      class BusinessComplianceProfile < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::UnmaskedComplianceProfile::BusinessComplianceProfile,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # Employer Identification Number in `XX-XXXXXXX` format. Required for Patriot
+        # Act-compliant KYB verification.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :ein
+
+        # Official business name registered with the IRS.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :legal_business_name
+
+        # Representatives associated with the business. Valid only for `business`
+        # customers.
+        sig do
+          returns(T.nilable(T::Array[Straddle::BusinessCustomerRepresentative]))
+        end
+        attr_accessor :representatives
+
+        # Official business website URL.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :website
+
+        sig do
+          params(
+            ein: T.nilable(String),
+            legal_business_name: T.nilable(String),
+            representatives:
+              T.nilable(
+                T::Array[Straddle::BusinessCustomerRepresentative::OrHash]
+              ),
+            website: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Employer Identification Number in `XX-XXXXXXX` format. Required for Patriot
+          # Act-compliant KYB verification.
+          ein:,
+          # Official business name registered with the IRS.
+          legal_business_name:,
+          # Representatives associated with the business. Valid only for `business`
+          # customers.
+          representatives: nil,
+          # Official business website URL.
+          website: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              ein: T.nilable(String),
+              legal_business_name: T.nilable(String),
+              representatives:
+                T.nilable(T::Array[Straddle::BusinessCustomerRepresentative]),
+              website: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(
+          T::Array[Straddle::UnmaskedComplianceProfile::Variants]
+        )
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/straddle/models/unmasked_customer.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class UnmaskedCustomer < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::UnmaskedCustomer, Straddle::Internal::AnyHash)
+        end
+
+      # Unique identifier for the customer.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Timestamp of when the customer record was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The customer's email address.
+      sig { returns(String) }
+      attr_accessor :email
+
+      # Full name for an individual customer or business name for a business customer.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The customer's phone number in E.164 format.
+      sig { returns(String) }
+      attr_accessor :phone
+
+      sig { returns(Straddle::CustomerStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(Straddle::CustomerType::TaggedSymbol) }
+      attr_accessor :type
+
+      # Timestamp of the most recent update to the customer record.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Customer postal address. When provided, the object must include all required
+      # fields.
+      sig { returns(T.nilable(Straddle::CustomerAddress)) }
+      attr_reader :address
+
+      sig { params(address: T.nilable(Straddle::CustomerAddress::OrHash)).void }
+      attr_writer :address
+
+      sig { returns(T.nilable(Straddle::UnmaskedComplianceProfile::Variants)) }
+      attr_accessor :compliance_profile
+
+      sig { returns(T.nilable(Straddle::CustomerConfiguration)) }
+      attr_reader :config
+
+      sig { params(config: Straddle::CustomerConfiguration::OrHash).void }
+      attr_writer :config
+
+      sig { returns(T.nilable(Straddle::CustomerDevice)) }
+      attr_reader :device
+
+      sig { params(device: Straddle::CustomerDevice::OrHash).void }
+      attr_writer :device
+
+      # Unique identifier for the customer in your system.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
+      # Up to 20 user-defined key-value pairs associated with the customer.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          email: String,
+          name: String,
+          phone: String,
+          status: Straddle::CustomerStatus::OrSymbol,
+          type: Straddle::CustomerType::OrSymbol,
+          updated_at: Time,
+          address: T.nilable(Straddle::CustomerAddress::OrHash),
+          compliance_profile:
+            T.nilable(
+              T.any(
+                Straddle::UnmaskedComplianceProfile::IndividualComplianceProfile::OrHash,
+                Straddle::UnmaskedComplianceProfile::BusinessComplianceProfile::OrHash
+              )
+            ),
+          config: Straddle::CustomerConfiguration::OrHash,
+          device: Straddle::CustomerDevice::OrHash,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the customer.
+        id:,
+        # Timestamp of when the customer record was created.
+        created_at:,
+        # The customer's email address.
+        email:,
+        # Full name for an individual customer or business name for a business customer.
+        name:,
+        # The customer's phone number in E.164 format.
+        phone:,
+        status:,
+        type:,
+        # Timestamp of the most recent update to the customer record.
+        updated_at:,
+        # Customer postal address. When provided, the object must include all required
+        # fields.
+        address: nil,
+        compliance_profile: nil,
+        config: nil,
+        device: nil,
+        # Unique identifier for the customer in your system.
+        external_id: nil,
+        # Up to 20 user-defined key-value pairs associated with the customer.
+        metadata: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            email: String,
+            name: String,
+            phone: String,
+            status: Straddle::CustomerStatus::TaggedSymbol,
+            type: Straddle::CustomerType::TaggedSymbol,
+            updated_at: Time,
+            address: T.nilable(Straddle::CustomerAddress),
+            compliance_profile:
+              T.nilable(Straddle::UnmaskedComplianceProfile::Variants),
+            config: Straddle::CustomerConfiguration,
+            device: Straddle::CustomerDevice,
+            external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, String])
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end