straddle 0.5.0 → 1.0.0

data/lib/straddle/models/unmasked_compliance_profile.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module UnmaskedComplianceProfile
+      extend Straddle::Internal::Type::Union
+
+      variant -> { Straddle::UnmaskedComplianceProfile::IndividualComplianceProfile }
+
+      variant -> { Straddle::UnmaskedComplianceProfile::BusinessComplianceProfile }
+
+      class IndividualComplianceProfile < Straddle::Internal::Type::BaseModel
+        # @!attribute dob
+        #   Date of birth in `YYYY-MM-DD` format. Required for Patriot Act-compliant KYC
+        #   verification.
+        #
+        #   @return [Date, nil]
+        required :dob, Date, nil?: true
+
+        # @!attribute ssn
+        #   Social Security number in `XXX-XX-XXXX` format. Required for Patriot
+        #   Act-compliant KYC verification.
+        #
+        #   @return [String, nil]
+        required :ssn, String, nil?: true
+
+        # @!method initialize(dob:, ssn:)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile} for
+        #   more details.
+        #
+        #   @param dob [Date, nil] Date of birth in `YYYY-MM-DD` format. Required for Patriot Act-compliant KYC ver
+        #
+        #   @param ssn [String, nil] Social Security number in `XXX-XX-XXXX` format. Required for Patriot Act-complia
+      end
+
+      class BusinessComplianceProfile < Straddle::Internal::Type::BaseModel
+        # @!attribute ein
+        #   Employer Identification Number in `XX-XXXXXXX` format. Required for Patriot
+        #   Act-compliant KYB verification.
+        #
+        #   @return [String, nil]
+        required :ein, String, nil?: true
+
+        # @!attribute legal_business_name
+        #   Official business name registered with the IRS.
+        #
+        #   @return [String, nil]
+        required :legal_business_name, String, nil?: true
+
+        # @!attribute representatives
+        #   Representatives associated with the business. Valid only for `business`
+        #   customers.
+        #
+        #   @return [Array<Straddle::Models::BusinessCustomerRepresentative>, nil]
+        optional :representatives,
+                 -> { Straddle::Internal::Type::ArrayOf[Straddle::BusinessCustomerRepresentative] },
+                 nil?: true
+
+        # @!attribute website
+        #   Official business website URL.
+        #
+        #   @return [String, nil]
+        optional :website, String, nil?: true
+
+        # @!method initialize(ein:, legal_business_name:, representatives: nil, website: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::UnmaskedComplianceProfile::BusinessComplianceProfile} for
+        #   more details.
+        #
+        #   @param ein [String, nil] Employer Identification Number in `XX-XXXXXXX` format. Required for Patriot Act-
+        #
+        #   @param legal_business_name [String, nil] Official business name registered with the IRS.
+        #
+        #   @param representatives [Array<Straddle::Models::BusinessCustomerRepresentative>, nil] Representatives associated with the business. Valid only for `business` customer
+        #
+        #   @param website [String, nil] Official business website URL.
+      end
+
+      # @!method self.variants
+      #   @return [Array(Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile, Straddle::Models::UnmaskedComplianceProfile::BusinessComplianceProfile)]
+    end
+  end
+end

data/lib/straddle/models/unmasked_customer.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class UnmaskedCustomer < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the customer.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Timestamp of when the customer record was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute email
+      #   The customer's email address.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute name
+      #   Full name for an individual customer or business name for a business customer.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute phone
+      #   The customer's phone number in E.164 format.
+      #
+      #   @return [String]
+      required :phone, String
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Straddle::Models::CustomerStatus]
+      required :status, enum: -> { Straddle::CustomerStatus }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Straddle::Models::CustomerType]
+      required :type, enum: -> { Straddle::CustomerType }
+
+      # @!attribute updated_at
+      #   Timestamp of the most recent update to the customer record.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute address
+      #   Customer postal address. When provided, the object must include all required
+      #   fields.
+      #
+      #   @return [Straddle::Models::CustomerAddress, nil]
+      optional :address, -> { Straddle::CustomerAddress }, nil?: true
+
+      # @!attribute compliance_profile
+      #
+      #   @return [Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile, Straddle::Models::UnmaskedComplianceProfile::BusinessComplianceProfile, nil]
+      optional :compliance_profile, union: -> { Straddle::UnmaskedComplianceProfile }, nil?: true
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::CustomerConfiguration, nil]
+      optional :config, -> { Straddle::CustomerConfiguration }
+
+      # @!attribute device
+      #
+      #   @return [Straddle::Models::CustomerDevice, nil]
+      optional :device, -> { Straddle::CustomerDevice }
+
+      # @!attribute external_id
+      #   Unique identifier for the customer in your system.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs associated with the customer.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
+      # @!method initialize(id:, created_at:, email:, name:, phone:, status:, type:, updated_at:, address: nil, compliance_profile: nil, config: nil, device: nil, external_id: nil, metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::UnmaskedCustomer} for more details.
+      #
+      #   @param id [String] Unique identifier for the customer.
+      #
+      #   @param created_at [Time] Timestamp of when the customer record was created.
+      #
+      #   @param email [String] The customer's email address.
+      #
+      #   @param name [String] Full name for an individual customer or business name for a business customer.
+      #
+      #   @param phone [String] The customer's phone number in E.164 format.
+      #
+      #   @param status [Symbol, Straddle::Models::CustomerStatus]
+      #
+      #   @param type [Symbol, Straddle::Models::CustomerType]
+      #
+      #   @param updated_at [Time] Timestamp of the most recent update to the customer record.
+      #
+      #   @param address [Straddle::Models::CustomerAddress, nil] Customer postal address. When provided, the object must include all required fie
+      #
+      #   @param compliance_profile [Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile, Straddle::Models::UnmaskedComplianceProfile::BusinessComplianceProfile, nil]
+      #
+      #   @param config [Straddle::Models::CustomerConfiguration]
+      #
+      #   @param device [Straddle::Models::CustomerDevice]
+      #
+      #   @param external_id [String, nil] Unique identifier for the customer in your system.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 user-defined key-value pairs associated with the customer.
+    end
+  end
+end

data/lib/straddle/models/unmasked_customer_response.rb

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class UnmaskedLinkedBankAccount < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Straddle's unique ID for the linked bank account.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   ID of the Straddle account associated with the linked bank account.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute bank_account
+      #   Unmasked bank account details.
+      #
+      #   @return [Straddle::Models::UnmaskedLinkedBankAccountDetails]
+      required :bank_account, -> { Straddle::UnmaskedLinkedBankAccountDetails }
+
+      # @!attribute created_at
+      #   Date and time when Straddle created the linked bank account.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute status
+      #   Status of the linked bank account.
+      #
+      #   @return [Symbol, Straddle::Models::UnmaskedLinkedBankAccount::Status]
+      required :status, enum: -> { Straddle::UnmaskedLinkedBankAccount::Status }
+
+      # @!attribute status_detail
+      #   Details about the linked bank account's status.
+      #
+      #   @return [Straddle::Models::LinkedBankAccountStatusDetail]
+      required :status_detail, -> { Straddle::LinkedBankAccountStatusDetail }
+
+      # @!attribute updated_at
+      #   Date and time of the most recent linked bank account update.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String, nil?: true], nil?: true
+
+      # @!method initialize(id:, account_id:, bank_account:, created_at:, status:, status_detail:, updated_at:, metadata: nil)
+      #   @param id [String] Straddle's unique ID for the linked bank account.
+      #
+      #   @param account_id [String] ID of the Straddle account associated with the linked bank account.
+      #
+      #   @param bank_account [Straddle::Models::UnmaskedLinkedBankAccountDetails] Unmasked bank account details.
+      #
+      #   @param created_at [Time] Date and time when Straddle created the linked bank account.
+      #
+      #   @param status [Symbol, Straddle::Models::UnmaskedLinkedBankAccount::Status] Status of the linked bank account.
+      #
+      #   @param status_detail [Straddle::Models::LinkedBankAccountStatusDetail] Details about the linked bank account's status.
+      #
+      #   @param updated_at [Time] Date and time of the most recent linked bank account update.
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil]
+
+      # Status of the linked bank account.
+      #
+      # @see Straddle::Models::UnmaskedLinkedBankAccount#status
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        CREATED = :created
+        ONBOARDING = :onboarding
+        ACTIVE = :active
+        REJECTED = :rejected
+        INACTIVE = :inactive
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/unmasked_linked_bank_account_details.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class UnmaskedLinkedBankAccountDetails < Straddle::Internal::Type::BaseModel
+      # @!attribute account_holder
+      #   Name of the account holder as it appears on the bank account.
+      #
+      #   @return [String]
+      required :account_holder, String
+
+      # @!attribute account_number
+      #   Bank account number.
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!attribute institution_name
+      #   Name of the financial institution.
+      #
+      #   @return [String]
+      required :institution_name, String
+
+      # @!attribute routing_number
+      #   Nine-digit ABA routing number for the bank account.
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!method initialize(account_holder:, account_number:, institution_name:, routing_number:)
+      #   @param account_holder [String] Name of the account holder as it appears on the bank account.
+      #
+      #   @param account_number [String] Bank account number.
+      #
+      #   @param institution_name [String] Name of the financial institution.
+      #
+      #   @param routing_number [String] Nine-digit ABA routing number for the bank account.
+    end
+  end
+end

data/lib/straddle/models/unmasked_linked_bank_account_response.rb

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

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class UnmaskedPaykey < 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
+      #   Human-readable label for the paykey.
+      #
+      #   @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::UnmaskedPaykeyBankDetails, nil]
+      optional :bank_data, -> { Straddle::UnmaskedPaykeyBankDetails }
+
+      # @!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] Human-readable label for the paykey.
+      #
+      #   @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::UnmaskedPaykeyBankDetails]
+      #
+      #   @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/unmasked_paykey_bank_details.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class UnmaskedPaykeyBankDetails < Straddle::Internal::Type::BaseModel
+      # @!attribute account_number
+      #   Bank account number.
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!attribute account_type
+      #
+      #   @return [Symbol, Straddle::Models::AccountType]
+      required :account_type, enum: -> { Straddle::AccountType }
+
+      # @!attribute routing_number
+      #   Bank routing number.
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!method initialize(account_number:, account_type:, routing_number:)
+      #   @param account_number [String] Bank account number.
+      #
+      #   @param account_type [Symbol, Straddle::Models::AccountType]
+      #
+      #   @param routing_number [String] Bank routing number.
+    end
+  end
+end

data/lib/straddle/models/unmasked_paykey_response.rb

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