straddle 0.5.0 → 1.0.0

data/lib/straddle/models/unmasked_payout.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class UnmaskedPayout < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for this payout.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   Amount in cents.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::PayoutConfiguration]
+      required :config, -> { Straddle::PayoutConfiguration }
+
+      # @!attribute currency
+      #   Currency code. Only `USD` is supported.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute description
+      #   A human-readable description of the payout.
+      #
+      #   @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 payout, used to correlate with your internal
+      #   records.
+      #
+      #   @return [String]
+      required :external_id, String
+
+      # @!attribute funding_ids
+      #   IDs of the funding events that included this payout.
+      #
+      #   @return [Array<String>]
+      required :funding_ids, Straddle::Internal::Type::ArrayOf[String]
+
+      # @!attribute has_resubmit
+      #   Whether this payout has been resubmitted.
+      #
+      #   @return [Boolean]
+      required :has_resubmit, Straddle::Internal::Type::Boolean
+
+      # @!attribute is_refund
+      #   Whether this payout refunds an original charge.
+      #
+      #   @return [Boolean]
+      required :is_refund, Straddle::Internal::Type::Boolean
+
+      # @!attribute is_resubmit
+      #   Whether this payout resubmits an original payout.
+      #
+      #   @return [Boolean]
+      required :is_resubmit, Straddle::Internal::Type::Boolean
+
+      # @!attribute paykey
+      #   Unmasked paykey token used for this payout.
+      #
+      #   @return [String]
+      required :paykey, String
+
+      # @!attribute payment_date
+      #   Date when Straddle submits the payout 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 payout.
+      #
+      #   @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 created_at
+      #   Timestamp when this payout was created.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, nil?: true
+
+      # @!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 payout, 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 payout.
+      #
+      #   @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 payout 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 payout.
+      #
+      #   @return [Array<Straddle::Models::RelatedPayment>, nil]
+      optional :related_payments,
+               -> { Straddle::Internal::Type::ArrayOf[Straddle::RelatedPayment] },
+               nil?: true
+
+      # @!attribute updated_at
+      #   Timestamp when this payout was last updated.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, nil?: true
+
+      # @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, has_resubmit:, is_refund:, is_resubmit:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, created_at: nil, customer_details: nil, documents: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::UnmaskedPayout} for more details.
+      #
+      #   @param id [String] Unique identifier for this payout.
+      #
+      #   @param amount [Integer] Amount in cents.
+      #
+      #   @param config [Straddle::Models::PayoutConfiguration]
+      #
+      #   @param currency [String] Currency code. Only `USD` is supported.
+      #
+      #   @param description [String, nil] A human-readable description of the payout.
+      #
+      #   @param device [Straddle::Models::PaymentDevice]
+      #
+      #   @param external_id [String] Your unique identifier for this payout, used to correlate with your internal rec
+      #
+      #   @param funding_ids [Array<String>] IDs of the funding events that included this payout.
+      #
+      #   @param has_resubmit [Boolean] Whether this payout has been resubmitted.
+      #
+      #   @param is_refund [Boolean] Whether this payout refunds an original charge.
+      #
+      #   @param is_resubmit [Boolean] Whether this payout resubmits an original payout.
+      #
+      #   @param paykey [String] Unmasked paykey token used for this payout.
+      #
+      #   @param payment_date [Date] Date when Straddle submits the payout 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 payout.
+      #
+      #   @param trace_ids [Hash{Symbol=>String}] Trace identifiers from the payment network. Keys depend on the payment rail.
+      #
+      #   @param created_at [Time, nil] Timestamp when this payout was created.
+      #
+      #   @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 payout, 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 payout.
+      #
+      #   @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 payout was submitted to the payment network. Null until proc
+      #
+      #   @param related_payments [Array<Straddle::Models::RelatedPayment>, nil] Related payments and their relationship to this payout.
+      #
+      #   @param updated_at [Time, nil] Timestamp when this payout was last updated.
+    end
+  end
+end

data/lib/straddle/models/unmasked_payout_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Payouts#list_unmasked
+    class UnmaskedPayoutResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::UnmaskedPayout]
+      required :data, -> { Straddle::UnmaskedPayout }
+
+      # @!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::UnmaskedPayoutResponse} for more details.
+      #
+      #   @param data [Straddle::Models::UnmaskedPayout]
+      #
+      #   @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/unmasked_representative.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class UnmaskedRepresentative < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Straddle's unique ID for the representative.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   ID of the account associated with the representative.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute created_at
+      #   Date and time when Straddle created the representative.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute dob
+      #   Representative's date of birth in `YYYY-MM-DD` format.
+      #
+      #   @return [Date]
+      required :dob, Date
+
+      # @!attribute email
+      #   Representative's email address.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute first_name
+      #   Representative's first name.
+      #
+      #   @return [String]
+      required :first_name, String
+
+      # @!attribute last_name
+      #   Representative's last name.
+      #
+      #   @return [String]
+      required :last_name, String
+
+      # @!attribute mobile_number
+      #   Representative's mobile phone number.
+      #
+      #   @return [String]
+      required :mobile_number, String
+
+      # @!attribute relationship
+      #
+      #   @return [Straddle::Models::RepresentativeRelationship]
+      required :relationship, -> { Straddle::RepresentativeRelationship }
+
+      # @!attribute ssn_last4
+      #   Last four digits of the representative's Social Security number.
+      #
+      #   @return [String]
+      required :ssn_last4, String
+
+      # @!attribute status
+      #   Status of the representative.
+      #
+      #   @return [Symbol, Straddle::Models::UnmaskedRepresentative::Status]
+      required :status, enum: -> { Straddle::UnmaskedRepresentative::Status }
+
+      # @!attribute status_detail
+      #
+      #   @return [Straddle::Models::RepresentativeStatusDetail]
+      required :status_detail, -> { Straddle::RepresentativeStatusDetail }
+
+      # @!attribute updated_at
+      #   Date and time of the most recent representative update.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute external_id
+      #   Your unique ID for the representative.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute user_id
+      #   ID of the Straddle user linked to the representative, if any.
+      #
+      #   @return [String, nil]
+      optional :user_id, String, nil?: true
+
+      # @!method initialize(id:, account_id:, created_at:, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, status:, status_detail:, updated_at:, external_id: nil, metadata: nil, user_id: nil)
+      #   @param id [String] Straddle's unique ID for the representative.
+      #
+      #   @param account_id [String] ID of the account associated with the representative.
+      #
+      #   @param created_at [Time] Date and time when Straddle created the representative.
+      #
+      #   @param dob [Date] Representative's date of birth in `YYYY-MM-DD` format.
+      #
+      #   @param email [String] Representative's email address.
+      #
+      #   @param first_name [String] Representative's first name.
+      #
+      #   @param last_name [String] Representative's last name.
+      #
+      #   @param mobile_number [String] Representative's mobile phone number.
+      #
+      #   @param relationship [Straddle::Models::RepresentativeRelationship]
+      #
+      #   @param ssn_last4 [String] Last four digits of the representative's Social Security number.
+      #
+      #   @param status [Symbol, Straddle::Models::UnmaskedRepresentative::Status] Status of the representative.
+      #
+      #   @param status_detail [Straddle::Models::RepresentativeStatusDetail]
+      #
+      #   @param updated_at [Time] Date and time of the most recent representative update.
+      #
+      #   @param external_id [String, nil] Your unique ID for the representative.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 user-defined key-value pairs.
+      #
+      #   @param user_id [String, nil] ID of the Straddle user linked to the representative, if any.
+
+      # Status of the representative.
+      #
+      # @see Straddle::Models::UnmaskedRepresentative#status
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        CREATED = :created
+        ONBOARDING = :onboarding
+        ACTIVE = :active
+        REJECTED = :rejected
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/unmasked_representative_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Representatives#list_unmasked
+    class UnmaskedRepresentativeResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::UnmaskedRepresentative]
+      required :data, -> { Straddle::UnmaskedRepresentative }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   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.
+      #
+      #   @return [Symbol, Straddle::Models::UnmaskedRepresentativeResponse::ResponseType]
+      required :response_type, enum: -> { Straddle::UnmaskedRepresentativeResponse::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::UnmaskedRepresentativeResponse} for more details.
+      #
+      #   @param data [Straddle::Models::UnmaskedRepresentative]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::UnmaskedRepresentativeResponse::ResponseType] Indicates how the response content is structured.
+
+      # 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.
+      #
+      # @see Straddle::Models::UnmaskedRepresentativeResponse#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/unwrap_webhook_event.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module UnwrapWebhookEvent
+      extend Straddle::Internal::Type::Union
+
+      variant -> { Straddle::AccountCreatedV1WebhookEvent }
+
+      variant -> { Straddle::AccountEventV1WebhookEvent }
+
+      variant -> { Straddle::RepresentativeEventV1WebhookEvent }
+
+      variant -> { Straddle::RepresentativeCreatedV1WebhookEvent }
+
+      variant -> { Straddle::LinkedBankAccountEventV1WebhookEvent }
+
+      variant -> { Straddle::LinkedBankAccountCreatedV1WebhookEvent }
+
+      variant -> { Straddle::CapabilityRequestEventV1WebhookEvent }
+
+      variant -> { Straddle::CapabilityRequestCreatedV1WebhookEvent }
+
+      variant -> { Straddle::CustomerEventV1WebhookEvent }
+
+      variant -> { Straddle::CustomerCreatedV1WebhookEvent }
+
+      variant -> { Straddle::PaykeyEventV1WebhookEvent }
+
+      variant -> { Straddle::PaykeyCreatedV1WebhookEvent }
+
+      variant -> { Straddle::ChargeCreatedV1WebhookEvent }
+
+      variant -> { Straddle::ChargeEventV1WebhookEvent }
+
+      variant -> { Straddle::PayoutCreatedV1WebhookEvent }
+
+      variant -> { Straddle::PayoutEventV1WebhookEvent }
+
+      variant -> { Straddle::PlatformEventV1WebhookEvent }
+
+      variant -> { Straddle::PlatformCreatedV1WebhookEvent }
+
+      variant -> { Straddle::UserEventV1WebhookEvent }
+
+      variant -> { Straddle::UserCreatedV1WebhookEvent }
+
+      variant -> { Straddle::FundingEventCreatedV1WebhookEvent }
+
+      variant -> { Straddle::FundingEventEventV1WebhookEvent }
+
+      # @!method self.variants
+      #   @return [Array(Straddle::Models::AccountCreatedV1WebhookEvent, Straddle::Models::AccountEventV1WebhookEvent, Straddle::Models::RepresentativeEventV1WebhookEvent, Straddle::Models::RepresentativeCreatedV1WebhookEvent, Straddle::Models::LinkedBankAccountEventV1WebhookEvent, Straddle::Models::LinkedBankAccountCreatedV1WebhookEvent, Straddle::Models::CapabilityRequestEventV1WebhookEvent, Straddle::Models::CapabilityRequestCreatedV1WebhookEvent, Straddle::Models::CustomerEventV1WebhookEvent, Straddle::Models::CustomerCreatedV1WebhookEvent, Straddle::Models::PaykeyEventV1WebhookEvent, Straddle::Models::PaykeyCreatedV1WebhookEvent, Straddle::Models::ChargeCreatedV1WebhookEvent, Straddle::Models::ChargeEventV1WebhookEvent, Straddle::Models::PayoutCreatedV1WebhookEvent, Straddle::Models::PayoutEventV1WebhookEvent, Straddle::Models::PlatformEventV1WebhookEvent, Straddle::Models::PlatformCreatedV1WebhookEvent, Straddle::Models::UserEventV1WebhookEvent, Straddle::Models::UserCreatedV1WebhookEvent, Straddle::Models::FundingEventCreatedV1WebhookEvent, Straddle::Models::FundingEventEventV1WebhookEvent)]
+    end
+  end
+end