straddle 0.1.0.pre.alpha.1

data/lib/straddle/models/charge_v1.rb

@@ -0,0 +1,485 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Charges#create
+    class ChargeV1 < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::ChargeV1::Data]
+      required :data, -> { Straddle::ChargeV1::Data }
+
+      # @!attribute meta
+      #   Metadata about the API request, including an identifier and timestamp.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   Indicates the structure of the returned content.
+      #
+      #   - "object" means the `data` field contains a single JSON object.
+      #   - "array" means the `data` field contains an array of objects.
+      #   - "error" means the `data` field contains an error object with details of the
+      #     issue.
+      #   - "none" means no data is returned.
+      #
+      #   @return [Symbol, Straddle::Models::ChargeV1::ResponseType]
+      required :response_type, enum: -> { Straddle::ChargeV1::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::ChargeV1} for more details.
+      #
+      #   @param data [Straddle::Models::ChargeV1::Data]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata about the API request, including an identifier and timestamp.
+      #
+      #   @param response_type [Symbol, Straddle::Models::ChargeV1::ResponseType] Indicates the structure of the returned content.
+
+      # @see Straddle::Models::ChargeV1#data
+      class Data < Straddle::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the charge.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #   The amount of the charge in cents.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute config
+        #   Configuration options for the charge.
+        #
+        #   @return [Straddle::Models::ChargeV1::Data::Config]
+        required :config, -> { Straddle::ChargeV1::Data::Config }
+
+        # @!attribute consent_type
+        #   The channel or mechanism through which the payment was authorized. Use
+        #   `internet` for payments made online or through a mobile app and `signed` for
+        #   signed agreements where there is a consent form or contract. Use `signed` for
+        #   PDF signatures.
+        #
+        #   @return [Symbol, Straddle::Models::ChargeV1::Data::ConsentType]
+        required :consent_type, enum: -> { Straddle::ChargeV1::Data::ConsentType }
+
+        # @!attribute created_at
+        #   Timestamp of when the charge was created.
+        #
+        #   @return [Time, nil]
+        required :created_at, Time, nil?: true
+
+        # @!attribute currency
+        #   The currency of the charge. Only USD is supported.
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute description
+        #   An arbitrary description for the charge.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute device
+        #   Information about the device used when the customer authorized the payment.
+        #
+        #   @return [Straddle::Models::DeviceInfoV1]
+        required :device, -> { Straddle::DeviceInfoV1 }
+
+        # @!attribute external_id
+        #   Unique identifier for the charge in your database. This value must be unique
+        #   across all charges.
+        #
+        #   @return [String]
+        required :external_id, String
+
+        # @!attribute funding_ids
+        #   Funding Ids
+        #
+        #   @return [Array<String>]
+        required :funding_ids, Straddle::Internal::Type::ArrayOf[String]
+
+        # @!attribute paykey
+        #   Value of the `paykey` used for the charge.
+        #
+        #   @return [String]
+        required :paykey, String
+
+        # @!attribute payment_date
+        #   The desired date on which the payment should be occur. For charges, this means
+        #   the date you want the customer to be debited on.
+        #
+        #   @return [Date]
+        required :payment_date, Date
+
+        # @!attribute status
+        #   The current status of the charge.
+        #
+        #   @return [Symbol, Straddle::Models::ChargeV1::Data::Status]
+        required :status, enum: -> { Straddle::ChargeV1::Data::Status }
+
+        # @!attribute status_details
+        #   Additional details about the current status of the charge.
+        #
+        #   @return [Straddle::Models::StatusDetailsV1]
+        required :status_details, -> { Straddle::StatusDetailsV1 }
+
+        # @!attribute status_history
+        #   Status history.
+        #
+        #   @return [Array<Straddle::Models::ChargeV1::Data::StatusHistory>]
+        required :status_history,
+                 -> { Straddle::Internal::Type::ArrayOf[Straddle::ChargeV1::Data::StatusHistory] }
+
+        # @!attribute updated_at
+        #   Timestamp of when the charge was last updated.
+        #
+        #   @return [Time, nil]
+        required :updated_at, Time, nil?: true
+
+        # @!attribute customer_details
+        #   Information about the customer associated with the charge.
+        #
+        #   @return [Straddle::Models::CustomerDetailsV1, nil]
+        optional :customer_details, -> { Straddle::CustomerDetailsV1 }
+
+        # @!attribute effective_at
+        #   Timestamp of when the charge was effective in the customer's bank account,
+        #   otherwise known as the date on which the customer is debited.
+        #
+        #   @return [Time, nil]
+        optional :effective_at, Time, nil?: true
+
+        # @!attribute metadata
+        #   Up to 20 additional user-defined key-value pairs. Useful for storing additional
+        #   information about the charge in a structured format.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute paykey_details
+        #   Information about the paykey used for the charge.
+        #
+        #   @return [Straddle::Models::PaykeyDetailsV1, nil]
+        optional :paykey_details, -> { Straddle::PaykeyDetailsV1 }
+
+        # @!attribute payment_rail
+        #   The payment rail that the charge will be processed through.
+        #
+        #   @return [Symbol, Straddle::Models::ChargeV1::Data::PaymentRail, nil]
+        optional :payment_rail, enum: -> { Straddle::ChargeV1::Data::PaymentRail }
+
+        # @!attribute processed_at
+        #   Timestamp of when the charge was processed by Straddle and originated to the
+        #   payment rail.
+        #
+        #   @return [Time, nil]
+        optional :processed_at, Time, nil?: true
+
+        # @!method initialize(id:, amount:, config:, consent_type:, created_at:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, updated_at:, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::ChargeV1::Data} for more details.
+        #
+        #   @param id [String] Unique identifier for the charge.
+        #
+        #   @param amount [Integer] The amount of the charge in cents.
+        #
+        #   @param config [Straddle::Models::ChargeV1::Data::Config] Configuration options for the charge.
+        #
+        #   @param consent_type [Symbol, Straddle::Models::ChargeV1::Data::ConsentType] The channel or mechanism through which the payment was authorized. Use `internet
+        #
+        #   @param created_at [Time, nil] Timestamp of when the charge was created.
+        #
+        #   @param currency [String] The currency of the charge. Only USD is supported.
+        #
+        #   @param description [String] An arbitrary description for the charge.
+        #
+        #   @param device [Straddle::Models::DeviceInfoV1] Information about the device used when the customer authorized the payment.
+        #
+        #   @param external_id [String] Unique identifier for the charge in your database. This value must be unique acr
+        #
+        #   @param funding_ids [Array<String>] Funding Ids
+        #
+        #   @param paykey [String] Value of the `paykey` used for the charge.
+        #
+        #   @param payment_date [Date] The desired date on which the payment should be occur. For charges, this means t
+        #
+        #   @param status [Symbol, Straddle::Models::ChargeV1::Data::Status] The current status of the charge.
+        #
+        #   @param status_details [Straddle::Models::StatusDetailsV1] Additional details about the current status of the charge.
+        #
+        #   @param status_history [Array<Straddle::Models::ChargeV1::Data::StatusHistory>] Status history.
+        #
+        #   @param updated_at [Time, nil] Timestamp of when the charge was last updated.
+        #
+        #   @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the charge.
+        #
+        #   @param effective_at [Time, nil] Timestamp of when the charge was effective in the customer's bank account, other
+        #
+        #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
+        #
+        #   @param paykey_details [Straddle::Models::PaykeyDetailsV1] Information about the paykey used for the charge.
+        #
+        #   @param payment_rail [Symbol, Straddle::Models::ChargeV1::Data::PaymentRail] The payment rail that the charge will be processed through.
+        #
+        #   @param processed_at [Time, nil] Timestamp of when the charge was processed by Straddle and originated to the pay
+
+        # @see Straddle::Models::ChargeV1::Data#config
+        class Config < Straddle::Internal::Type::BaseModel
+          # @!attribute balance_check
+          #   Defines whether to check the customer's balance before processing the charge.
+          #
+          #   @return [Symbol, Straddle::Models::ChargeV1::Data::Config::BalanceCheck]
+          required :balance_check, enum: -> { Straddle::ChargeV1::Data::Config::BalanceCheck }
+
+          # @!attribute sandbox_outcome
+          #   Payment will simulate processing if not Standard.
+          #
+          #   @return [Symbol, Straddle::Models::ChargeV1::Data::Config::SandboxOutcome, nil]
+          optional :sandbox_outcome, enum: -> { Straddle::ChargeV1::Data::Config::SandboxOutcome }
+
+          # @!method initialize(balance_check:, sandbox_outcome: nil)
+          #   Configuration options for the charge.
+          #
+          #   @param balance_check [Symbol, Straddle::Models::ChargeV1::Data::Config::BalanceCheck] Defines whether to check the customer's balance before processing the charge.
+          #
+          #   @param sandbox_outcome [Symbol, Straddle::Models::ChargeV1::Data::Config::SandboxOutcome] Payment will simulate processing if not Standard.
+
+          # Defines whether to check the customer's balance before processing the charge.
+          #
+          # @see Straddle::Models::ChargeV1::Data::Config#balance_check
+          module BalanceCheck
+            extend Straddle::Internal::Type::Enum
+
+            REQUIRED = :required
+            ENABLED = :enabled
+            DISABLED = :disabled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Payment will simulate processing if not Standard.
+          #
+          # @see Straddle::Models::ChargeV1::Data::Config#sandbox_outcome
+          module SandboxOutcome
+            extend Straddle::Internal::Type::Enum
+
+            STANDARD = :standard
+            PAID = :paid
+            ON_HOLD_DAILY_LIMIT = :on_hold_daily_limit
+            CANCELLED_FOR_FRAUD_RISK = :cancelled_for_fraud_risk
+            CANCELLED_FOR_BALANCE_CHECK = :cancelled_for_balance_check
+            FAILED_INSUFFICIENT_FUNDS = :failed_insufficient_funds
+            REVERSED_INSUFFICIENT_FUNDS = :reversed_insufficient_funds
+            FAILED_CUSTOMER_DISPUTE = :failed_customer_dispute
+            REVERSED_CUSTOMER_DISPUTE = :reversed_customer_dispute
+            FAILED_CLOSED_BANK_ACCOUNT = :failed_closed_bank_account
+            REVERSED_CLOSED_BANK_ACCOUNT = :reversed_closed_bank_account
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The channel or mechanism through which the payment was authorized. Use
+        # `internet` for payments made online or through a mobile app and `signed` for
+        # signed agreements where there is a consent form or contract. Use `signed` for
+        # PDF signatures.
+        #
+        # @see Straddle::Models::ChargeV1::Data#consent_type
+        module ConsentType
+          extend Straddle::Internal::Type::Enum
+
+          INTERNET = :internet
+          SIGNED = :signed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The current status of the charge.
+        #
+        # @see Straddle::Models::ChargeV1::Data#status
+        module Status
+          extend Straddle::Internal::Type::Enum
+
+          CREATED = :created
+          SCHEDULED = :scheduled
+          FAILED = :failed
+          CANCELLED = :cancelled
+          ON_HOLD = :on_hold
+          PENDING = :pending
+          PAID = :paid
+          REVERSED = :reversed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class StatusHistory < Straddle::Internal::Type::BaseModel
+          # @!attribute changed_at
+          #   The time the status change occurred.
+          #
+          #   @return [Time]
+          required :changed_at, Time
+
+          # @!attribute message
+          #   A human-readable description of the status.
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute reason
+          #   A machine-readable identifier for the specific status, useful for programmatic
+          #   handling.
+          #
+          #   @return [Symbol, Straddle::Models::ChargeV1::Data::StatusHistory::Reason]
+          required :reason, enum: -> { Straddle::ChargeV1::Data::StatusHistory::Reason }
+
+          # @!attribute source
+          #   Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
+          #   This helps in tracking the cause of status updates.
+          #
+          #   @return [Symbol, Straddle::Models::ChargeV1::Data::StatusHistory::Source]
+          required :source, enum: -> { Straddle::ChargeV1::Data::StatusHistory::Source }
+
+          # @!attribute status
+          #   The current status of the `charge` or `payout`.
+          #
+          #   @return [Symbol, Straddle::Models::ChargeV1::Data::StatusHistory::Status]
+          required :status, enum: -> { Straddle::ChargeV1::Data::StatusHistory::Status }
+
+          # @!attribute code
+          #   The status code if applicable.
+          #
+          #   @return [String, nil]
+          optional :code, String, nil?: true
+
+          # @!method initialize(changed_at:, message:, reason:, source:, status:, code: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Straddle::Models::ChargeV1::Data::StatusHistory} for more details.
+          #
+          #   A record of the charge's status changes over time.
+          #
+          #   @param changed_at [Time] The time the status change occurred.
+          #
+          #   @param message [String] A human-readable description of the status.
+          #
+          #   @param reason [Symbol, Straddle::Models::ChargeV1::Data::StatusHistory::Reason] A machine-readable identifier for the specific status, useful for programmatic h
+          #
+          #   @param source [Symbol, Straddle::Models::ChargeV1::Data::StatusHistory::Source] Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
+          #
+          #   @param status [Symbol, Straddle::Models::ChargeV1::Data::StatusHistory::Status] The current status of the `charge` or `payout`.
+          #
+          #   @param code [String, nil] The status code if applicable.
+
+          # A machine-readable identifier for the specific status, useful for programmatic
+          # handling.
+          #
+          # @see Straddle::Models::ChargeV1::Data::StatusHistory#reason
+          module Reason
+            extend Straddle::Internal::Type::Enum
+
+            INSUFFICIENT_FUNDS = :insufficient_funds
+            CLOSED_BANK_ACCOUNT = :closed_bank_account
+            INVALID_BANK_ACCOUNT = :invalid_bank_account
+            INVALID_ROUTING = :invalid_routing
+            DISPUTED = :disputed
+            PAYMENT_STOPPED = :payment_stopped
+            OWNER_DECEASED = :owner_deceased
+            FROZEN_BANK_ACCOUNT = :frozen_bank_account
+            RISK_REVIEW = :risk_review
+            FRAUDULENT = :fraudulent
+            DUPLICATE_ENTRY = :duplicate_entry
+            INVALID_PAYKEY = :invalid_paykey
+            PAYMENT_BLOCKED = :payment_blocked
+            AMOUNT_TOO_LARGE = :amount_too_large
+            TOO_MANY_ATTEMPTS = :too_many_attempts
+            INTERNAL_SYSTEM_ERROR = :internal_system_error
+            USER_REQUEST = :user_request
+            OK = :ok
+            OTHER_NETWORK_RETURN = :other_network_return
+            PAYOUT_REFUSED = :payout_refused
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
+          # This helps in tracking the cause of status updates.
+          #
+          # @see Straddle::Models::ChargeV1::Data::StatusHistory#source
+          module Source
+            extend Straddle::Internal::Type::Enum
+
+            WATCHTOWER = :watchtower
+            BANK_DECLINE = :bank_decline
+            CUSTOMER_DISPUTE = :customer_dispute
+            USER_ACTION = :user_action
+            SYSTEM = :system
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The current status of the `charge` or `payout`.
+          #
+          # @see Straddle::Models::ChargeV1::Data::StatusHistory#status
+          module Status
+            extend Straddle::Internal::Type::Enum
+
+            CREATED = :created
+            SCHEDULED = :scheduled
+            FAILED = :failed
+            CANCELLED = :cancelled
+            ON_HOLD = :on_hold
+            PENDING = :pending
+            PAID = :paid
+            REVERSED = :reversed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The payment rail that the charge will be processed through.
+        #
+        # @see Straddle::Models::ChargeV1::Data#payment_rail
+        module PaymentRail
+          extend Straddle::Internal::Type::Enum
+
+          ACH = :ach
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Indicates the structure of the returned content.
+      #
+      # - "object" means the `data` field contains a single JSON object.
+      # - "array" means the `data` field contains an array of objects.
+      # - "error" means the `data` field contains an error object with details of the
+      #   issue.
+      # - "none" means no data is returned.
+      #
+      # @see Straddle::Models::ChargeV1#response_type
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        OBJECT = :object
+        ARRAY = :array
+        ERROR = :error
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/customer_address_v1.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class CustomerAddressV1 < Straddle::Internal::Type::BaseModel
+      # @!attribute address1
+      #   Primary address line (e.g., street, PO Box).
+      #
+      #   @return [String]
+      required :address1, String
+
+      # @!attribute city
+      #   City, district, suburb, town, or village.
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute state
+      #   Two-letter state code.
+      #
+      #   @return [String]
+      required :state, String
+
+      # @!attribute zip
+      #   Zip or postal code.
+      #
+      #   @return [String]
+      required :zip, String
+
+      # @!attribute address2
+      #   Secondary address line (e.g., apartment, suite, unit, or building).
+      #
+      #   @return [String, nil]
+      optional :address2, String, nil?: true
+
+      # @!method initialize(address1:, city:, state:, zip:, address2: nil)
+      #   An object containing the customer's address. This is optional, but if provided,
+      #   all required fields must be present.
+      #
+      #   @param address1 [String] Primary address line (e.g., street, PO Box).
+      #
+      #   @param city [String] City, district, suburb, town, or village.
+      #
+      #   @param state [String] Two-letter state code.
+      #
+      #   @param zip [String] Zip or postal code.
+      #
+      #   @param address2 [String, nil] Secondary address line (e.g., apartment, suite, unit, or building).
+    end
+  end
+end