straddle 0.5.0 → 1.0.0

data/lib/straddle/models/customer.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class Customer < 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::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::ComplianceProfile::BusinessComplianceProfile, nil]
+      optional :compliance_profile, union: -> { Straddle::ComplianceProfile }, nil?: true
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::CustomerConfiguration, nil]
+      optional :config, -> { Straddle::CustomerConfiguration }
+
+      # @!attribute device
+      #
+      #   @return [Straddle::Models::MaskedCustomerDevice, nil]
+      optional :device, -> { Straddle::MaskedCustomerDevice }
+
+      # @!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::Customer} 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::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::ComplianceProfile::BusinessComplianceProfile, nil]
+      #
+      #   @param config [Straddle::Models::CustomerConfiguration]
+      #
+      #   @param device [Straddle::Models::MaskedCustomerDevice]
+      #
+      #   @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/customer_address.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class CustomerAddress < Straddle::Internal::Type::BaseModel
+      # @!attribute address1
+      #   Primary address line, such as a street address or PO Box.
+      #
+      #   @return [String]
+      required :address1, String
+
+      # @!attribute city
+      #   City, district, suburb, town, or village.
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute state
+      #   Two-letter state code.
+      #
+      #   @return [String]
+      required :state, String
+
+      # @!attribute zip
+      #   ZIP or postal code.
+      #
+      #   @return [String]
+      required :zip, String
+
+      # @!attribute address2
+      #   Secondary address line, such as an apartment, suite, unit, or building.
+      #
+      #   @return [String, nil]
+      optional :address2, String, nil?: true
+
+      # @!method initialize(address1:, city:, state:, zip:, address2: nil)
+      #   Customer postal address. When provided, the object must include all required
+      #   fields.
+      #
+      #   @param address1 [String] Primary address line, such as a street address or PO Box.
+      #
+      #   @param city [String] City, district, suburb, town, or village.
+      #
+      #   @param state [String] Two-letter state code.
+      #
+      #   @param zip [String] ZIP or postal code.
+      #
+      #   @param address2 [String, nil] Secondary address line, such as an apartment, suite, unit, or building.
+    end
+  end
+end

data/lib/straddle/models/customer_configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class CustomerConfiguration < Straddle::Internal::Type::BaseModel
+      # @!attribute processing_method
+      #
+      #   @return [Symbol, Straddle::Models::PaykeyProcessingMode, nil]
+      optional :processing_method, enum: -> { Straddle::PaykeyProcessingMode }
+
+      # @!attribute sandbox_outcome
+      #
+      #   @return [Symbol, Straddle::Models::SimulatedCustomerOutcome, nil]
+      optional :sandbox_outcome, enum: -> { Straddle::SimulatedCustomerOutcome }
+
+      # @!method initialize(processing_method: nil, sandbox_outcome: nil)
+      #   @param processing_method [Symbol, Straddle::Models::PaykeyProcessingMode]
+      #   @param sandbox_outcome [Symbol, Straddle::Models::SimulatedCustomerOutcome]
+    end
+  end
+end

data/lib/straddle/models/customer_create_params.rb

@@ -9,85 +9,83 @@ module Straddle
 
       # @!attribute device
       #
-      #   @return [Straddle::Models::DeviceUnmaskedV1]
-      required :device, -> { Straddle::DeviceUnmaskedV1 }
+      #   @return [Straddle::Models::CustomerDevice]
+      required :device, -> { Straddle::CustomerDevice }
 
       # @!attribute email
-      #   The customer's email address.
+      #   Customer email address.
       #
       #   @return [String]
       required :email, String
 
       # @!attribute name
-      #   Full name of the individual or business 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. Mobile number is preferred.
+      #   Customer phone number in E.164 format. A mobile number is preferred.
       #
       #   @return [String]
       required :phone, String
 
       # @!attribute type
       #
-      #   @return [Symbol, Straddle::Models::CustomerCreateParams::Type]
-      required :type, enum: -> { Straddle::CustomerCreateParams::Type }
+      #   @return [Symbol, Straddle::Models::CustomerType]
+      required :type, enum: -> { Straddle::CustomerType }
 
       # @!attribute address
-      #   An object containing the customer's address. **This is optional.** If used, all
-      #   required fields must be present.
+      #   Customer postal address. When provided, the object must include all required
+      #   fields.
       #
-      #   @return [Straddle::Models::CustomerAddressV1, nil]
-      optional :address, -> { Straddle::CustomerAddressV1 }, nil?: true
+      #   @return [Straddle::Models::CustomerAddress, nil]
+      optional :address, -> { Straddle::CustomerAddress }, nil?: true
 
       # @!attribute compliance_profile
-      #   An object containing the customer's compliance profile. **This is optional.** If
-      #   all required fields must be present for the appropriate customer type.
+      #   Customer compliance profile. When provided, the object must include all fields
+      #   required for the customer type.
       #
-      #   @return [Straddle::Models::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile, nil]
-      optional :compliance_profile,
-               union: -> {
-                 Straddle::CustomerCreateParams::ComplianceProfile
-               },
-               nil?: true
+      #   @return [Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile, Straddle::Models::UnmaskedComplianceProfile::BusinessComplianceProfile, nil]
+      optional :compliance_profile, union: -> { Straddle::UnmaskedComplianceProfile }, nil?: true
 
       # @!attribute config
       #
-      #   @return [Straddle::Models::CustomerCreateParams::Config, nil]
-      optional :config, -> { Straddle::CustomerCreateParams::Config }
+      #   @return [Straddle::Models::CustomerConfiguration, nil]
+      optional :config, -> { Straddle::CustomerConfiguration }
 
       # @!attribute external_id
-      #   Unique identifier for the customer in your database, used for cross-referencing
-      #   between Straddle and your systems.
+      #   Unique identifier for the customer in your system.
       #
       #   @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.
+      #   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
 
       # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
       #
       #   @return [String, nil]
       optional :correlation_id, String
 
       # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
       #
       #   @return [String, nil]
       optional :idempotency_key, String
 
       # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
       #
       #   @return [String, nil]
       optional :request_id, String
 
       # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
       #
       #   @return [String, nil]
       optional :straddle_account_id, String
@@ -96,198 +94,35 @@ module Straddle
       #   Some parameter documentations has been truncated, see
       #   {Straddle::Models::CustomerCreateParams} for more details.
       #
-      #   @param device [Straddle::Models::DeviceUnmaskedV1]
+      #   @param device [Straddle::Models::CustomerDevice]
       #
-      #   @param email [String] The customer's email address.
+      #   @param email [String] Customer email address.
       #
-      #   @param name [String] Full name of the individual or business name.
+      #   @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. Mobile number is preferred.
+      #   @param phone [String] Customer phone number in E.164 format. A mobile number is preferred.
       #
-      #   @param type [Symbol, Straddle::Models::CustomerCreateParams::Type]
+      #   @param type [Symbol, Straddle::Models::CustomerType]
       #
-      #   @param address [Straddle::Models::CustomerAddressV1, nil] An object containing the customer's address. **This is optional.** If used, all
+      #   @param address [Straddle::Models::CustomerAddress, nil] Customer postal address. When provided, the object must include all required fie
       #
-      #   @param compliance_profile [Straddle::Models::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile, nil] An object containing the customer's compliance profile. **This is optional.** If
+      #   @param compliance_profile [Straddle::Models::UnmaskedComplianceProfile::IndividualComplianceProfile, Straddle::Models::UnmaskedComplianceProfile::BusinessComplianceProfile, nil] Customer compliance profile. When provided, the object must include all fields r
       #
-      #   @param config [Straddle::Models::CustomerCreateParams::Config]
+      #   @param config [Straddle::Models::CustomerConfiguration]
       #
-      #   @param external_id [String, nil] Unique identifier for the customer in your database, used for cross-referencing
+      #   @param external_id [String, nil] Unique identifier for the customer in your system.
       #
-      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
+      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 user-defined key-value pairs associated with the customer.
       #
-      #   @param correlation_id [String]
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
       #
-      #   @param idempotency_key [String]
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
       #
-      #   @param request_id [String]
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
       #
-      #   @param straddle_account_id [String]
+      #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
       #
       #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
-
-      module Type
-        extend Straddle::Internal::Type::Enum
-
-        INDIVIDUAL = :individual
-        BUSINESS = :business
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # An object containing the customer's compliance profile. **This is optional.** If
-      # all required fields must be present for the appropriate customer type.
-      module ComplianceProfile
-        extend Straddle::Internal::Type::Union
-
-        # Individual PII data required to trigger Patriot Act compliant KYC verification.
-        variant -> { Straddle::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile }
-
-        # Business registration data required to trigger Patriot Act compliant KYB verification.
-        variant -> { Straddle::CustomerCreateParams::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::CustomerCreateParams::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::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile::Representative>, nil]
-          optional :representatives,
-                   -> {
-                     Straddle::Internal::Type::ArrayOf[Straddle::CustomerCreateParams::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::CustomerCreateParams::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::CustomerCreateParams::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::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile)]
-      end
-
-      class Config < Straddle::Internal::Type::BaseModel
-        # @!attribute processing_method
-        #
-        #   @return [Symbol, Straddle::Models::CustomerCreateParams::Config::ProcessingMethod, nil]
-        optional :processing_method, enum: -> { Straddle::CustomerCreateParams::Config::ProcessingMethod }
-
-        # @!attribute sandbox_outcome
-        #
-        #   @return [Symbol, Straddle::Models::CustomerCreateParams::Config::SandboxOutcome, nil]
-        optional :sandbox_outcome, enum: -> { Straddle::CustomerCreateParams::Config::SandboxOutcome }
-
-        # @!method initialize(processing_method: nil, sandbox_outcome: nil)
-        #   @param processing_method [Symbol, Straddle::Models::CustomerCreateParams::Config::ProcessingMethod]
-        #   @param sandbox_outcome [Symbol, Straddle::Models::CustomerCreateParams::Config::SandboxOutcome]
-
-        # @see Straddle::Models::CustomerCreateParams::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::CustomerCreateParams::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
   end
 end