straddle 0.4.0 → 1.0.0

data/lib/straddle/models/customer_summary_paged_v1.rb

@@ -1,247 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    class CustomerSummaryPagedV1 < Straddle::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Array<Straddle::Models::CustomerSummaryPagedV1::Data>]
-      required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::CustomerSummaryPagedV1::Data] }
-
-      # @!attribute meta
-      #
-      #   @return [Straddle::Models::CustomerSummaryPagedV1::Meta]
-      required :meta, -> { Straddle::CustomerSummaryPagedV1::Meta }
-
-      # @!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::CustomerSummaryPagedV1::ResponseType]
-      required :response_type, enum: -> { Straddle::CustomerSummaryPagedV1::ResponseType }
-
-      # @!method initialize(data:, meta:, response_type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Straddle::Models::CustomerSummaryPagedV1} for more details.
-      #
-      #   @param data [Array<Straddle::Models::CustomerSummaryPagedV1::Data>]
-      #
-      #   @param meta [Straddle::Models::CustomerSummaryPagedV1::Meta]
-      #
-      #   @param response_type [Symbol, Straddle::Models::CustomerSummaryPagedV1::ResponseType] Indicates the structure of the returned content.
-
-      class Data < 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 of the individual or business name.
-        #
-        #   @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::CustomerSummaryPagedV1::Data::Status]
-        required :status, enum: -> { Straddle::CustomerSummaryPagedV1::Data::Status }
-
-        # @!attribute type
-        #
-        #   @return [Symbol, Straddle::Models::CustomerSummaryPagedV1::Data::Type]
-        required :type, enum: -> { Straddle::CustomerSummaryPagedV1::Data::Type }
-
-        # @!attribute updated_at
-        #   Timestamp of the most recent update to the customer record.
-        #
-        #   @return [Time]
-        required :updated_at, Time
-
-        # @!attribute external_id
-        #   Unique identifier for the customer in your database, used for cross-referencing
-        #   between Straddle and your systems.
-        #
-        #   @return [String, nil]
-        optional :external_id, String, nil?: true
-
-        # @!method initialize(id:, created_at:, email:, name:, phone:, status:, type:, updated_at:, external_id: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Straddle::Models::CustomerSummaryPagedV1::Data} 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 of the individual or business name.
-        #
-        #   @param phone [String] The customer's phone number in E.164 format.
-        #
-        #   @param status [Symbol, Straddle::Models::CustomerSummaryPagedV1::Data::Status]
-        #
-        #   @param type [Symbol, Straddle::Models::CustomerSummaryPagedV1::Data::Type]
-        #
-        #   @param updated_at [Time] Timestamp of the most recent update to the customer record.
-        #
-        #   @param external_id [String, nil] Unique identifier for the customer in your database, used for cross-referencing
-
-        # @see Straddle::Models::CustomerSummaryPagedV1::Data#status
-        module Status
-          extend Straddle::Internal::Type::Enum
-
-          PENDING = :pending
-          REVIEW = :review
-          VERIFIED = :verified
-          INACTIVE = :inactive
-          REJECTED = :rejected
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see Straddle::Models::CustomerSummaryPagedV1::Data#type
-        module Type
-          extend Straddle::Internal::Type::Enum
-
-          INDIVIDUAL = :individual
-          BUSINESS = :business
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      # @see Straddle::Models::CustomerSummaryPagedV1#meta
-      class Meta < Straddle::Internal::Type::BaseModel
-        # @!attribute api_request_id
-        #   Unique identifier for this API request, useful for troubleshooting.
-        #
-        #   @return [String]
-        required :api_request_id, String
-
-        # @!attribute api_request_timestamp
-        #   Timestamp for this API request, useful for troubleshooting.
-        #
-        #   @return [Time]
-        required :api_request_timestamp, Time
-
-        # @!attribute max_page_size
-        #   Maximum allowed page size for this endpoint.
-        #
-        #   @return [Integer]
-        required :max_page_size, Integer
-
-        # @!attribute page_number
-        #   Page number for paginated results.
-        #
-        #   @return [Integer]
-        required :page_number, Integer
-
-        # @!attribute page_size
-        #   Number of items per page in this response.
-        #
-        #   @return [Integer]
-        required :page_size, Integer
-
-        # @!attribute sort_by
-        #   The field that the results were sorted by.
-        #
-        #   @return [String]
-        required :sort_by, String
-
-        # @!attribute sort_order
-        #
-        #   @return [Symbol, Straddle::Models::CustomerSummaryPagedV1::Meta::SortOrder]
-        required :sort_order, enum: -> { Straddle::CustomerSummaryPagedV1::Meta::SortOrder }
-
-        # @!attribute total_items
-        #
-        #   @return [Integer]
-        required :total_items, Integer
-
-        # @!attribute total_pages
-        #   The number of pages available.
-        #
-        #   @return [Integer]
-        required :total_pages, Integer
-
-        # @!method initialize(api_request_id:, api_request_timestamp:, max_page_size:, page_number:, page_size:, sort_by:, sort_order:, total_items:, total_pages:)
-        #   @param api_request_id [String] Unique identifier for this API request, useful for troubleshooting.
-        #
-        #   @param api_request_timestamp [Time] Timestamp for this API request, useful for troubleshooting.
-        #
-        #   @param max_page_size [Integer] Maximum allowed page size for this endpoint.
-        #
-        #   @param page_number [Integer] Page number for paginated results.
-        #
-        #   @param page_size [Integer] Number of items per page in this response.
-        #
-        #   @param sort_by [String] The field that the results were sorted by.
-        #
-        #   @param sort_order [Symbol, Straddle::Models::CustomerSummaryPagedV1::Meta::SortOrder]
-        #
-        #   @param total_items [Integer]
-        #
-        #   @param total_pages [Integer] The number of pages available.
-
-        # @see Straddle::Models::CustomerSummaryPagedV1::Meta#sort_order
-        module SortOrder
-          extend Straddle::Internal::Type::Enum
-
-          ASC = :asc
-          DESC = :desc
-
-          # @!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::CustomerSummaryPagedV1#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_unmasked_params.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    # @see Straddle::Resources::Customers#unmasked
-    class CustomerUnmaskedParams < Straddle::Internal::Type::BaseModel
-      extend Straddle::Internal::Type::RequestParameters::Converter
-      include Straddle::Internal::Type::RequestParameters
-
-      # @!attribute id
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute correlation_id
-      #
-      #   @return [String, nil]
-      optional :correlation_id, String
-
-      # @!attribute request_id
-      #
-      #   @return [String, nil]
-      optional :request_id, String
-
-      # @!attribute straddle_account_id
-      #
-      #   @return [String, nil]
-      optional :straddle_account_id, String
-
-      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
-      #   @param id [String]
-      #   @param correlation_id [String]
-      #   @param request_id [String]
-      #   @param straddle_account_id [String]
-      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/straddle/models/customer_unmasked_v1.rb

@@ -1,362 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    # @see Straddle::Resources::Customers#unmasked
-    class CustomerUnmaskedV1 < Straddle::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Straddle::Models::CustomerUnmaskedV1::Data]
-      required :data, -> { Straddle::CustomerUnmaskedV1::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::CustomerUnmaskedV1::ResponseType]
-      required :response_type, enum: -> { Straddle::CustomerUnmaskedV1::ResponseType }
-
-      # @!method initialize(data:, meta:, response_type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Straddle::Models::CustomerUnmaskedV1} for more details.
-      #
-      #   @param data [Straddle::Models::CustomerUnmaskedV1::Data]
-      #
-      #   @param meta [Straddle::Models::ResponseMetadata] Metadata about the API request, including an identifier and timestamp.
-      #
-      #   @param response_type [Symbol, Straddle::Models::CustomerUnmaskedV1::ResponseType] Indicates the structure of the returned content.
-
-      # @see Straddle::Models::CustomerUnmaskedV1#data
-      class Data < 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 of the individual or business name.
-        #
-        #   @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::CustomerUnmaskedV1::Data::Status]
-        required :status, enum: -> { Straddle::CustomerUnmaskedV1::Data::Status }
-
-        # @!attribute type
-        #
-        #   @return [Symbol, Straddle::Models::CustomerUnmaskedV1::Data::Type]
-        required :type, enum: -> { Straddle::CustomerUnmaskedV1::Data::Type }
-
-        # @!attribute updated_at
-        #   Timestamp of the most recent update to the customer record.
-        #
-        #   @return [Time]
-        required :updated_at, Time
-
-        # @!attribute address
-        #   An object containing the customer's address. This is optional, but if provided,
-        #   all required fields must be present.
-        #
-        #   @return [Straddle::Models::CustomerAddressV1, nil]
-        optional :address, -> { Straddle::CustomerAddressV1 }, nil?: true
-
-        # @!attribute compliance_profile
-        #   Individual PII data required to trigger Patriot Act compliant KYC verification.
-        #
-        #   @return [Straddle::Models::CustomerUnmaskedV1::Data::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::CustomerUnmaskedV1::Data::ComplianceProfile::BusinessComplianceProfile, nil]
-        optional :compliance_profile,
-                 union: -> { Straddle::CustomerUnmaskedV1::Data::ComplianceProfile },
-                 nil?: true
-
-        # @!attribute config
-        #
-        #   @return [Straddle::Models::CustomerUnmaskedV1::Data::Config, nil]
-        optional :config, -> { Straddle::CustomerUnmaskedV1::Data::Config }
-
-        # @!attribute device
-        #
-        #   @return [Straddle::Models::DeviceUnmaskedV1, nil]
-        optional :device, -> { Straddle::DeviceUnmaskedV1 }
-
-        # @!attribute external_id
-        #   Unique identifier for the customer in your database, used for cross-referencing
-        #   between Straddle and your systems.
-        #
-        #   @return [String, nil]
-        optional :external_id, String, nil?: true
-
-        # @!attribute metadata
-        #   Up to 20 additional user-defined key-value pairs. Useful for storing additional
-        #   information about the customer in a structured format.
-        #
-        #   @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::CustomerUnmaskedV1::Data} 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 of the individual or business name.
-        #
-        #   @param phone [String] The customer's phone number in E.164 format.
-        #
-        #   @param status [Symbol, Straddle::Models::CustomerUnmaskedV1::Data::Status]
-        #
-        #   @param type [Symbol, Straddle::Models::CustomerUnmaskedV1::Data::Type]
-        #
-        #   @param updated_at [Time] Timestamp of the most recent update to the customer record.
-        #
-        #   @param address [Straddle::Models::CustomerAddressV1, nil] An object containing the customer's address. This is optional, but if provided,
-        #
-        #   @param compliance_profile [Straddle::Models::CustomerUnmaskedV1::Data::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::CustomerUnmaskedV1::Data::ComplianceProfile::BusinessComplianceProfile, nil] Individual PII data required to trigger Patriot Act compliant KYC verification.
-        #
-        #   @param config [Straddle::Models::CustomerUnmaskedV1::Data::Config]
-        #
-        #   @param device [Straddle::Models::DeviceUnmaskedV1]
-        #
-        #   @param external_id [String, nil] Unique identifier for the customer in your database, used for cross-referencing
-        #
-        #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
-
-        # @see Straddle::Models::CustomerUnmaskedV1::Data#status
-        module Status
-          extend Straddle::Internal::Type::Enum
-
-          PENDING = :pending
-          REVIEW = :review
-          VERIFIED = :verified
-          INACTIVE = :inactive
-          REJECTED = :rejected
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see Straddle::Models::CustomerUnmaskedV1::Data#type
-        module Type
-          extend Straddle::Internal::Type::Enum
-
-          INDIVIDUAL = :individual
-          BUSINESS = :business
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Individual PII data required to trigger Patriot Act compliant KYC verification.
-        #
-        # @see Straddle::Models::CustomerUnmaskedV1::Data#compliance_profile
-        module ComplianceProfile
-          extend Straddle::Internal::Type::Union
-
-          # Individual PII data required to trigger Patriot Act compliant KYC verification.
-          variant -> { Straddle::CustomerUnmaskedV1::Data::ComplianceProfile::IndividualComplianceProfile }
-
-          # Business registration data required to trigger Patriot Act compliant KYB verification.
-          variant -> { Straddle::CustomerUnmaskedV1::Data::ComplianceProfile::BusinessComplianceProfile }
-
-          class IndividualComplianceProfile < Straddle::Internal::Type::BaseModel
-            # @!attribute dob
-            #   Date of birth (YYYY-MM-DD). Required for Patriot Act-compliant KYC verification.
-            #
-            #   @return [Date, nil]
-            required :dob, Date, nil?: true
-
-            # @!attribute ssn
-            #   Social Security Number (format XXX-XX-XXXX). 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::CustomerUnmaskedV1::Data::ComplianceProfile::IndividualComplianceProfile}
-            #   for more details.
-            #
-            #   Individual PII data required to trigger Patriot Act compliant KYC verification.
-            #
-            #   @param dob [Date, nil] Date of birth (YYYY-MM-DD). Required for Patriot Act-compliant KYC verification.
-            #
-            #   @param ssn [String, nil] Social Security Number (format XXX-XX-XXXX). Required for Patriot Act-compliant
-          end
-
-          class BusinessComplianceProfile < Straddle::Internal::Type::BaseModel
-            # @!attribute ein
-            #   Employer Identification Number (format XX-XXXXXXX). Required for Patriot
-            #   Act-compliant KYB verification.
-            #
-            #   @return [String, nil]
-            required :ein, String, nil?: true
-
-            # @!attribute legal_business_name
-            #   Official registered business name as listed with the IRS. This value will be
-            #   matched against the 'legal_business name'.
-            #
-            #   @return [String, nil]
-            required :legal_business_name, String, nil?: true
-
-            # @!attribute representatives
-            #   A list of people related to the company. Only valid where customer type is
-            #   'business'.
-            #
-            #   @return [Array<Straddle::Models::CustomerUnmaskedV1::Data::ComplianceProfile::BusinessComplianceProfile::Representative>, nil]
-            optional :representatives,
-                     -> {
-                       Straddle::Internal::Type::ArrayOf[Straddle::CustomerUnmaskedV1::Data::ComplianceProfile::BusinessComplianceProfile::Representative]
-                     },
-                     nil?: true
-
-            # @!attribute website
-            #   Official business website URL. Optional but recommended for enhanced KYB.
-            #
-            #   @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::CustomerUnmaskedV1::Data::ComplianceProfile::BusinessComplianceProfile}
-            #   for more details.
-            #
-            #   Business registration data required to trigger Patriot Act compliant KYB
-            #   verification.
-            #
-            #   @param ein [String, nil] Employer Identification Number (format XX-XXXXXXX). Required for Patriot Act-com
-            #
-            #   @param legal_business_name [String, nil] Official registered business name as listed with the IRS. This value will be mat
-            #
-            #   @param representatives [Array<Straddle::Models::CustomerUnmaskedV1::Data::ComplianceProfile::BusinessComplianceProfile::Representative>, nil] A list of people related to the company. Only valid where customer type is 'busi
-            #
-            #   @param website [String, nil] Official business website URL. Optional but recommended for enhanced KYB.
-
-            class Representative < Straddle::Internal::Type::BaseModel
-              # @!attribute name
-              #
-              #   @return [String]
-              required :name, String
-
-              # @!attribute email
-              #
-              #   @return [String, nil]
-              optional :email, String, nil?: true
-
-              # @!attribute phone
-              #
-              #   @return [String, nil]
-              optional :phone, String, nil?: true
-
-              # @!method initialize(name:, email: nil, phone: nil)
-              #   @param name [String]
-              #   @param email [String, nil]
-              #   @param phone [String, nil]
-            end
-          end
-
-          # @!method self.variants
-          #   @return [Array(Straddle::Models::CustomerUnmaskedV1::Data::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::CustomerUnmaskedV1::Data::ComplianceProfile::BusinessComplianceProfile)]
-        end
-
-        # @see Straddle::Models::CustomerUnmaskedV1::Data#config
-        class Config < Straddle::Internal::Type::BaseModel
-          # @!attribute processing_method
-          #
-          #   @return [Symbol, Straddle::Models::CustomerUnmaskedV1::Data::Config::ProcessingMethod, nil]
-          optional :processing_method, enum: -> { Straddle::CustomerUnmaskedV1::Data::Config::ProcessingMethod }
-
-          # @!attribute sandbox_outcome
-          #
-          #   @return [Symbol, Straddle::Models::CustomerUnmaskedV1::Data::Config::SandboxOutcome, nil]
-          optional :sandbox_outcome, enum: -> { Straddle::CustomerUnmaskedV1::Data::Config::SandboxOutcome }
-
-          # @!method initialize(processing_method: nil, sandbox_outcome: nil)
-          #   @param processing_method [Symbol, Straddle::Models::CustomerUnmaskedV1::Data::Config::ProcessingMethod]
-          #   @param sandbox_outcome [Symbol, Straddle::Models::CustomerUnmaskedV1::Data::Config::SandboxOutcome]
-
-          # @see Straddle::Models::CustomerUnmaskedV1::Data::Config#processing_method
-          module ProcessingMethod
-            extend Straddle::Internal::Type::Enum
-
-            INLINE = :inline
-            BACKGROUND = :background
-            SKIP = :skip
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
-          # @see Straddle::Models::CustomerUnmaskedV1::Data::Config#sandbox_outcome
-          module SandboxOutcome
-            extend Straddle::Internal::Type::Enum
-
-            STANDARD = :standard
-            VERIFIED = :verified
-            REJECTED = :rejected
-            REVIEW = :review
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        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::CustomerUnmaskedV1#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