straddle 0.5.0 → 1.0.0

data/lib/straddle/models/revealed_paykey.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class RevealedPaykey < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the paykey.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::PaykeyConfiguration]
+      required :config, -> { Straddle::PaykeyConfiguration }
+
+      # @!attribute created_at
+      #   Timestamp of when the paykey was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute label
+      #   Display label combining the bank name and masked account number.
+      #
+      #   @return [String]
+      required :label, String
+
+      # @!attribute paykey
+      #   Full paykey value for creating payments. Store this value securely.
+      #
+      #   @return [String]
+      required :paykey, String
+
+      # @!attribute source
+      #
+      #   @return [Symbol, Straddle::Models::PaykeySource]
+      required :source, enum: -> { Straddle::PaykeySource }
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Straddle::Models::PaykeyStatus]
+      required :status, enum: -> { Straddle::PaykeyStatus }
+
+      # @!attribute updated_at
+      #   Timestamp of the most recent update to the paykey.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute balance
+      #
+      #   @return [Straddle::Models::PaykeyBalanceDetails, nil]
+      optional :balance, -> { Straddle::PaykeyBalanceDetails }
+
+      # @!attribute bank_data
+      #
+      #   @return [Straddle::Models::PaykeyBankDetails, nil]
+      optional :bank_data, -> { Straddle::PaykeyBankDetails }
+
+      # @!attribute customer_id
+      #   Unique identifier for the customer associated with the paykey.
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute expires_at
+      #   Expiration date and time of the paykey, if applicable.
+      #
+      #   @return [Time, nil]
+      optional :expires_at, Time, nil?: true
+
+      # @!attribute external_id
+      #   Unique identifier for the paykey in your system.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute institution_name
+      #   Name of the financial institution.
+      #
+      #   @return [String, nil]
+      optional :institution_name, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute status_details
+      #
+      #   @return [Straddle::Models::PaymentStatusDetails, nil]
+      optional :status_details, -> { Straddle::PaymentStatusDetails }
+
+      # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil)
+      #   @param id [String] Unique identifier for the paykey.
+      #
+      #   @param config [Straddle::Models::PaykeyConfiguration]
+      #
+      #   @param created_at [Time] Timestamp of when the paykey was created.
+      #
+      #   @param label [String] Display label combining the bank name and masked account number.
+      #
+      #   @param paykey [String] Full paykey value for creating payments. Store this value securely.
+      #
+      #   @param source [Symbol, Straddle::Models::PaykeySource]
+      #
+      #   @param status [Symbol, Straddle::Models::PaykeyStatus]
+      #
+      #   @param updated_at [Time] Timestamp of the most recent update to the paykey.
+      #
+      #   @param balance [Straddle::Models::PaykeyBalanceDetails]
+      #
+      #   @param bank_data [Straddle::Models::PaykeyBankDetails]
+      #
+      #   @param customer_id [String, nil] Unique identifier for the customer associated with the paykey.
+      #
+      #   @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
+      #
+      #   @param external_id [String, nil] Unique identifier for the paykey in your system.
+      #
+      #   @param institution_name [String, nil] Name of the financial institution.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @param status_details [Straddle::Models::PaymentStatusDetails]
+    end
+  end
+end

data/lib/straddle/models/revealed_paykey_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Bridge#create_quiltt_paykey
+    class RevealedPaykeyResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::RevealedPaykey]
+      required :data, -> { Straddle::RevealedPaykey }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   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.
+      #
+      #   @return [Symbol, Straddle::Models::ResponseType]
+      required :response_type, enum: -> { Straddle::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::RevealedPaykeyResponse} for more details.
+      #
+      #   @param data [Straddle::Models::RevealedPaykey]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::ResponseType] Shape of the response envelope.
+    end
+  end
+end

data/lib/straddle/models/simulated_customer_outcome.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module SimulatedCustomerOutcome
+      extend Straddle::Internal::Type::Enum
+
+      STANDARD = :standard
+      VERIFIED = :verified
+      REJECTED = :rejected
+      REVIEW = :review
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/simulated_paykey_outcome.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module SimulatedPaykeyOutcome
+      extend Straddle::Internal::Type::Enum
+
+      STANDARD = :standard
+      ACTIVE = :active
+      REJECTED = :rejected
+      REVIEW = :review
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/simulated_payment_outcome.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # Payment will simulate processing if not Standard.
+    module SimulatedPaymentOutcome
+      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
+      FAILED_NOT_AUTHORIZED = :failed_not_authorized
+      REVERSED_NOT_AUTHORIZED = :reversed_not_authorized
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/sort_order.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # Sort direction for the results.
+    module SortOrder
+      extend Straddle::Internal::Type::Enum
+
+      ASC = :asc
+      DESC = :desc
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/terms_of_service.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class TermsOfService < Straddle::Internal::Type::BaseModel
+      # @!attribute accepted_date
+      #   Date and time when the account accepted the Terms of Service.
+      #
+      #   @return [Time]
+      required :accepted_date, Time
+
+      # @!attribute agreement_type
+      #   Agreement type. Use `embedded` unless Straddle has enabled the platform for
+      #   `direct` agreements.
+      #
+      #   @return [Symbol, Straddle::Models::TermsOfService::AgreementType]
+      required :agreement_type, enum: -> { Straddle::TermsOfService::AgreementType }
+
+      # @!attribute agreement_url
+      #   URL of the accepted agreement.
+      #
+      #   @return [String, nil]
+      required :agreement_url, String, nil?: true
+
+      # @!attribute accepted_ip
+      #   IP address used to accept the Terms of Service.
+      #
+      #   @return [String, nil]
+      optional :accepted_ip, String, nil?: true
+
+      # @!attribute accepted_user_agent
+      #   User agent of the browser or application that accepted the Terms of Service.
+      #
+      #   @return [String, nil]
+      optional :accepted_user_agent, String, nil?: true
+
+      # @!method initialize(accepted_date:, agreement_type:, agreement_url:, accepted_ip: nil, accepted_user_agent: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::TermsOfService} for more details.
+      #
+      #   @param accepted_date [Time] Date and time when the account accepted the Terms of Service.
+      #
+      #   @param agreement_type [Symbol, Straddle::Models::TermsOfService::AgreementType] Agreement type. Use `embedded` unless Straddle has enabled the platform for `dir
+      #
+      #   @param agreement_url [String, nil] URL of the accepted agreement.
+      #
+      #   @param accepted_ip [String, nil] IP address used to accept the Terms of Service.
+      #
+      #   @param accepted_user_agent [String, nil] User agent of the browser or application that accepted the Terms of Service.
+
+      # Agreement type. Use `embedded` unless Straddle has enabled the platform for
+      # `direct` agreements.
+      #
+      # @see Straddle::Models::TermsOfService#agreement_type
+      module AgreementType
+        extend Straddle::Internal::Type::Enum
+
+        EMBEDDED = :embedded
+        DIRECT = :direct
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/transfer_direction.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+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
+
+      DEPOSIT = :deposit
+      WITHDRAWAL = :withdrawal
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/unmasked_charge.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class UnmaskedCharge < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for this charge.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   Amount in cents.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::ChargeConfiguration]
+      required :config, -> { Straddle::ChargeConfiguration }
+
+      # @!attribute consent_type
+      #   How the customer authorized the charge. `internet` covers online and mobile
+      #   authorization. `signed` covers written or PDF-signed agreements.
+      #
+      #   @return [Symbol, Straddle::Models::ConsentType]
+      required :consent_type, enum: -> { Straddle::ConsentType }
+
+      # @!attribute created_at
+      #   Timestamp when this charge was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   Currency code. Only `USD` is supported.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute description
+      #   A human-readable description of the charge.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute device
+      #
+      #   @return [Straddle::Models::PaymentDevice]
+      required :device, -> { Straddle::PaymentDevice }
+
+      # @!attribute external_id
+      #   Your unique identifier for this charge, used to correlate with your internal
+      #   records.
+      #
+      #   @return [String]
+      required :external_id, String
+
+      # @!attribute funding_ids
+      #   IDs of the funding events that included this charge.
+      #
+      #   @return [Array<String>]
+      required :funding_ids, Straddle::Internal::Type::ArrayOf[String]
+
+      # @!attribute has_refund
+      #   Whether an associated payout has refunded this charge.
+      #
+      #   @return [Boolean]
+      required :has_refund, Straddle::Internal::Type::Boolean
+
+      # @!attribute has_resubmit
+      #   Whether this charge has been resubmitted.
+      #
+      #   @return [Boolean]
+      required :has_resubmit, Straddle::Internal::Type::Boolean
+
+      # @!attribute is_resubmit
+      #   Whether this charge resubmits an original charge.
+      #
+      #   @return [Boolean]
+      required :is_resubmit, Straddle::Internal::Type::Boolean
+
+      # @!attribute paykey
+      #   Unmasked paykey token used for this charge.
+      #
+      #   @return [String]
+      required :paykey, String
+
+      # @!attribute payment_date
+      #   Date when Straddle submits the charge for processing.
+      #
+      #   @return [Date]
+      required :payment_date, Date
+
+      # @!attribute status
+      #   The current status of the `charge` or `payout`.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentStatus]
+      required :status, enum: -> { Straddle::PaymentStatus }
+
+      # @!attribute status_details
+      #
+      #   @return [Straddle::Models::PaymentStatusDetails]
+      required :status_details, -> { Straddle::PaymentStatusDetails }
+
+      # @!attribute status_history
+      #   Complete ordered history of all status changes for this charge.
+      #
+      #   @return [Array<Straddle::Models::PaymentStatusHistory>]
+      required :status_history, -> { Straddle::Internal::Type::ArrayOf[Straddle::PaymentStatusHistory] }
+
+      # @!attribute trace_ids
+      #   Trace identifiers from the payment network. Keys depend on the payment rail.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :trace_ids, Straddle::Internal::Type::HashOf[String]
+
+      # @!attribute updated_at
+      #   Timestamp when this charge was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute customer_details
+      #   Information about the customer associated with the charge or payout.
+      #
+      #   @return [Straddle::Models::CustomerDetails, nil]
+      optional :customer_details, -> { Straddle::CustomerDetails }
+
+      # @!attribute documents
+      #   Authorization documents for this charge, ordered by upload time.
+      #
+      #   @return [Array<Straddle::Models::PaymentAuthorizationProof>, nil]
+      optional :documents,
+               -> { Straddle::Internal::Type::ArrayOf[Straddle::PaymentAuthorizationProof] },
+               nil?: true
+
+      # @!attribute effective_at
+      #   Timestamp when funds were settled. Null until settlement is confirmed.
+      #
+      #   @return [Time, nil]
+      optional :effective_at, Time, nil?: true
+
+      # @!attribute metadata
+      #   Key-value metadata stored with this charge.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute paykey_details
+      #
+      #   @return [Straddle::Models::PaykeyDetails, nil]
+      optional :paykey_details, -> { Straddle::PaykeyDetails }
+
+      # @!attribute payment_rail
+      #   The payment rail used for the charge or payout.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentRail, nil]
+      optional :payment_rail, enum: -> { Straddle::PaymentRail }
+
+      # @!attribute processed_at
+      #   Timestamp when this charge was submitted to the payment network. Null until
+      #   processed.
+      #
+      #   @return [Time, nil]
+      optional :processed_at, Time, nil?: true
+
+      # @!attribute related_payments
+      #   Related payments and their relationship to this charge.
+      #
+      #   @return [Array<Straddle::Models::RelatedPayment>, nil]
+      optional :related_payments,
+               -> { Straddle::Internal::Type::ArrayOf[Straddle::RelatedPayment] },
+               nil?: true
+
+      # @!method initialize(id:, amount:, config:, consent_type:, created_at:, currency:, description:, device:, external_id:, funding_ids:, has_refund:, has_resubmit:, is_resubmit:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, updated_at:, customer_details: nil, documents: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::UnmaskedCharge} for more details.
+      #
+      #   @param id [String] Unique identifier for this charge.
+      #
+      #   @param amount [Integer] Amount in cents.
+      #
+      #   @param config [Straddle::Models::ChargeConfiguration]
+      #
+      #   @param consent_type [Symbol, Straddle::Models::ConsentType] How the customer authorized the charge. `internet` covers online and mobile auth
+      #
+      #   @param created_at [Time] Timestamp when this charge was created.
+      #
+      #   @param currency [String] Currency code. Only `USD` is supported.
+      #
+      #   @param description [String, nil] A human-readable description of the charge.
+      #
+      #   @param device [Straddle::Models::PaymentDevice]
+      #
+      #   @param external_id [String] Your unique identifier for this charge, used to correlate with your internal rec
+      #
+      #   @param funding_ids [Array<String>] IDs of the funding events that included this charge.
+      #
+      #   @param has_refund [Boolean] Whether an associated payout has refunded this charge.
+      #
+      #   @param has_resubmit [Boolean] Whether this charge has been resubmitted.
+      #
+      #   @param is_resubmit [Boolean] Whether this charge resubmits an original charge.
+      #
+      #   @param paykey [String] Unmasked paykey token used for this charge.
+      #
+      #   @param payment_date [Date] Date when Straddle submits the charge for processing.
+      #
+      #   @param status [Symbol, Straddle::Models::PaymentStatus] The current status of the `charge` or `payout`.
+      #
+      #   @param status_details [Straddle::Models::PaymentStatusDetails]
+      #
+      #   @param status_history [Array<Straddle::Models::PaymentStatusHistory>] Complete ordered history of all status changes for this charge.
+      #
+      #   @param trace_ids [Hash{Symbol=>String}] Trace identifiers from the payment network. Keys depend on the payment rail.
+      #
+      #   @param updated_at [Time] Timestamp when this charge was last updated.
+      #
+      #   @param customer_details [Straddle::Models::CustomerDetails] Information about the customer associated with the charge or payout.
+      #
+      #   @param documents [Array<Straddle::Models::PaymentAuthorizationProof>, nil] Authorization documents for this charge, ordered by upload time.
+      #
+      #   @param effective_at [Time, nil] Timestamp when funds were settled. Null until settlement is confirmed.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Key-value metadata stored with this charge.
+      #
+      #   @param paykey_details [Straddle::Models::PaykeyDetails]
+      #
+      #   @param payment_rail [Symbol, Straddle::Models::PaymentRail] The payment rail used for the charge or payout.
+      #
+      #   @param processed_at [Time, nil] Timestamp when this charge was submitted to the payment network. Null until proc
+      #
+      #   @param related_payments [Array<Straddle::Models::RelatedPayment>, nil] Related payments and their relationship to this charge.
+    end
+  end
+end

data/lib/straddle/models/unmasked_charge_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Charges#list_unmasked
+    class UnmaskedChargeResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::UnmaskedCharge]
+      required :data, -> { Straddle::UnmaskedCharge }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   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.
+      #
+      #   @return [Symbol, Straddle::Models::ResponseType]
+      required :response_type, enum: -> { Straddle::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::UnmaskedChargeResponse} for more details.
+      #
+      #   @param data [Straddle::Models::UnmaskedCharge]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::ResponseType] Shape of the response envelope.
+    end
+  end
+end