straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/customer_create_params.rbi

@@ -11,87 +11,85 @@ module Straddle
           T.any(Straddle::CustomerCreateParams, Straddle::Internal::AnyHash)
         end
 
-      sig { returns(Straddle::DeviceUnmaskedV1) }
+      sig { returns(Straddle::CustomerDevice) }
       attr_reader :device
 
-      sig { params(device: Straddle::DeviceUnmaskedV1::OrHash).void }
+      sig { params(device: Straddle::CustomerDevice::OrHash).void }
       attr_writer :device
 
-      # The customer's email address.
+      # Customer email address.
       sig { returns(String) }
       attr_accessor :email
 
-      # Full name of the individual or business name.
+      # Full name for an individual customer or business name for a business customer.
       sig { returns(String) }
       attr_accessor :name
 
-      # 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.
       sig { returns(String) }
       attr_accessor :phone
 
-      sig { returns(Straddle::CustomerCreateParams::Type::OrSymbol) }
+      sig { returns(Straddle::CustomerType::OrSymbol) }
       attr_accessor :type
 
-      # An object containing the customer's address. **This is optional.** If used, all
-      # required fields must be present.
-      sig { returns(T.nilable(Straddle::CustomerAddressV1)) }
+      # Customer postal address. When provided, the object must include all required
+      # fields.
+      sig { returns(T.nilable(Straddle::CustomerAddress)) }
       attr_reader :address
 
-      sig do
-        params(address: T.nilable(Straddle::CustomerAddressV1::OrHash)).void
-      end
+      sig { params(address: T.nilable(Straddle::CustomerAddress::OrHash)).void }
       attr_writer :address
 
-      # 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.
       sig do
         returns(
           T.nilable(
             T.any(
-              Straddle::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile,
-              Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile
+              Straddle::UnmaskedComplianceProfile::IndividualComplianceProfile,
+              Straddle::UnmaskedComplianceProfile::BusinessComplianceProfile
             )
           )
         )
       end
       attr_accessor :compliance_profile
 
-      sig { returns(T.nilable(Straddle::CustomerCreateParams::Config)) }
+      sig { returns(T.nilable(Straddle::CustomerConfiguration)) }
       attr_reader :config
 
-      sig do
-        params(config: Straddle::CustomerCreateParams::Config::OrHash).void
-      end
+      sig { params(config: Straddle::CustomerConfiguration::OrHash).void }
       attr_writer :config
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_accessor :external_id
 
-      # 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.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_accessor :metadata
 
+      # Optional client-generated identifier for tracing a series of related requests.
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
+      # Optional client-generated key for an idempotent request.
       sig { returns(T.nilable(String)) }
       attr_reader :idempotency_key
 
       sig { params(idempotency_key: String).void }
       attr_writer :idempotency_key
 
+      # Optional client-generated identifier for tracing one request.
       sig { returns(T.nilable(String)) }
       attr_reader :request_id
 
       sig { params(request_id: String).void }
       attr_writer :request_id
 
+      # For platform requests, the embedded account UUID that sets the request scope.
       sig { returns(T.nilable(String)) }
       attr_reader :straddle_account_id
 
@@ -100,20 +98,20 @@ module Straddle
 
       sig do
         params(
-          device: Straddle::DeviceUnmaskedV1::OrHash,
+          device: Straddle::CustomerDevice::OrHash,
           email: String,
           name: String,
           phone: String,
-          type: Straddle::CustomerCreateParams::Type::OrSymbol,
-          address: T.nilable(Straddle::CustomerAddressV1::OrHash),
+          type: Straddle::CustomerType::OrSymbol,
+          address: T.nilable(Straddle::CustomerAddress::OrHash),
           compliance_profile:
             T.nilable(
               T.any(
-                Straddle::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile::OrHash,
-                Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile::OrHash
+                Straddle::UnmaskedComplianceProfile::IndividualComplianceProfile::OrHash,
+                Straddle::UnmaskedComplianceProfile::BusinessComplianceProfile::OrHash
               )
             ),
-          config: Straddle::CustomerCreateParams::Config::OrHash,
+          config: Straddle::CustomerConfiguration::OrHash,
           external_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
@@ -125,29 +123,31 @@ module Straddle
       end
       def self.new(
         device:,
-        # The customer's email address.
+        # Customer email address.
         email:,
-        # Full name of the individual or business name.
+        # Full name for an individual customer or business name for a business customer.
         name:,
-        # 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.
         phone:,
         type:,
-        # 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.
         address: nil,
-        # 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.
         compliance_profile: nil,
         config: nil,
-        # 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.
         external_id: nil,
-        # 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.
         metadata: nil,
+        # Optional client-generated identifier for tracing a series of related requests.
         correlation_id: nil,
+        # Optional client-generated key for an idempotent request.
         idempotency_key: nil,
+        # Optional client-generated identifier for tracing one request.
         request_id: nil,
+        # For platform requests, the embedded account UUID that sets the request scope.
         straddle_account_id: nil,
         request_options: {}
       )
@@ -156,20 +156,20 @@ module Straddle
       sig do
         override.returns(
           {
-            device: Straddle::DeviceUnmaskedV1,
+            device: Straddle::CustomerDevice,
             email: String,
             name: String,
             phone: String,
-            type: Straddle::CustomerCreateParams::Type::OrSymbol,
-            address: T.nilable(Straddle::CustomerAddressV1),
+            type: Straddle::CustomerType::OrSymbol,
+            address: T.nilable(Straddle::CustomerAddress),
             compliance_profile:
               T.nilable(
                 T.any(
-                  Straddle::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile,
-                  Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile
+                  Straddle::UnmaskedComplianceProfile::IndividualComplianceProfile,
+                  Straddle::UnmaskedComplianceProfile::BusinessComplianceProfile
                 )
               ),
-            config: Straddle::CustomerCreateParams::Config,
+            config: Straddle::CustomerConfiguration,
             external_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, String]),
             correlation_id: String,
@@ -182,368 +182,6 @@ module Straddle
       end
       def to_hash
       end
-
-      module Type
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Straddle::CustomerCreateParams::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        INDIVIDUAL =
-          T.let(:individual, Straddle::CustomerCreateParams::Type::TaggedSymbol)
-        BUSINESS =
-          T.let(:business, Straddle::CustomerCreateParams::Type::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[Straddle::CustomerCreateParams::Type::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      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
-
-        Variants =
-          T.type_alias do
-            T.any(
-              Straddle::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile,
-              Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile
-            )
-          end
-
-        class IndividualComplianceProfile < Straddle::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Straddle::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile,
-                Straddle::Internal::AnyHash
-              )
-            end
-
-          # Date of birth (YYYY-MM-DD). Required for Patriot Act-compliant KYC verification.
-          sig { returns(T.nilable(Date)) }
-          attr_accessor :dob
-
-          # Social Security Number (format XXX-XX-XXXX). Required for Patriot Act-compliant
-          # KYC verification.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :ssn
-
-          # Individual PII data required to trigger Patriot Act compliant KYC verification.
-          sig do
-            params(dob: T.nilable(Date), ssn: T.nilable(String)).returns(
-              T.attached_class
-            )
-          end
-          def self.new(
-            # Date of birth (YYYY-MM-DD). Required for Patriot Act-compliant KYC verification.
-            dob:,
-            # Social Security Number (format XXX-XX-XXXX). Required for Patriot Act-compliant
-            # KYC verification.
-            ssn:
-          )
-          end
-
-          sig do
-            override.returns({ dob: T.nilable(Date), ssn: T.nilable(String) })
-          end
-          def to_hash
-          end
-        end
-
-        class BusinessComplianceProfile < Straddle::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile,
-                Straddle::Internal::AnyHash
-              )
-            end
-
-          # Employer Identification Number (format XX-XXXXXXX). Required for Patriot
-          # Act-compliant KYB verification.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :ein
-
-          # Official registered business name as listed with the IRS. This value will be
-          # matched against the 'legal_business name'.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :legal_business_name
-
-          # A list of people related to the company. Only valid where customer type is
-          # 'business'.
-          sig do
-            returns(
-              T.nilable(
-                T::Array[
-                  Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile::Representative
-                ]
-              )
-            )
-          end
-          attr_accessor :representatives
-
-          # Official business website URL. Optional but recommended for enhanced KYB.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :website
-
-          # Business registration data required to trigger Patriot Act compliant KYB
-          # verification.
-          sig do
-            params(
-              ein: T.nilable(String),
-              legal_business_name: T.nilable(String),
-              representatives:
-                T.nilable(
-                  T::Array[
-                    Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile::Representative::OrHash
-                  ]
-                ),
-              website: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Employer Identification Number (format XX-XXXXXXX). Required for Patriot
-            # Act-compliant KYB verification.
-            ein:,
-            # Official registered business name as listed with the IRS. This value will be
-            # matched against the 'legal_business name'.
-            legal_business_name:,
-            # A list of people related to the company. Only valid where customer type is
-            # 'business'.
-            representatives: nil,
-            # Official business website URL. Optional but recommended for enhanced KYB.
-            website: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                ein: T.nilable(String),
-                legal_business_name: T.nilable(String),
-                representatives:
-                  T.nilable(
-                    T::Array[
-                      Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile::Representative
-                    ]
-                  ),
-                website: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-
-          class Representative < Straddle::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile::Representative,
-                  Straddle::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :name
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :email
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :phone
-
-            sig do
-              params(
-                name: String,
-                email: T.nilable(String),
-                phone: T.nilable(String)
-              ).returns(T.attached_class)
-            end
-            def self.new(name:, email: nil, phone: nil)
-            end
-
-            sig do
-              override.returns(
-                {
-                  name: String,
-                  email: T.nilable(String),
-                  phone: T.nilable(String)
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-        end
-
-        sig do
-          override.returns(
-            T::Array[
-              Straddle::CustomerCreateParams::ComplianceProfile::Variants
-            ]
-          )
-        end
-        def self.variants
-        end
-      end
-
-      class Config < Straddle::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Straddle::CustomerCreateParams::Config,
-              Straddle::Internal::AnyHash
-            )
-          end
-
-        sig do
-          returns(
-            T.nilable(
-              Straddle::CustomerCreateParams::Config::ProcessingMethod::OrSymbol
-            )
-          )
-        end
-        attr_reader :processing_method
-
-        sig do
-          params(
-            processing_method:
-              Straddle::CustomerCreateParams::Config::ProcessingMethod::OrSymbol
-          ).void
-        end
-        attr_writer :processing_method
-
-        sig do
-          returns(
-            T.nilable(
-              Straddle::CustomerCreateParams::Config::SandboxOutcome::OrSymbol
-            )
-          )
-        end
-        attr_reader :sandbox_outcome
-
-        sig do
-          params(
-            sandbox_outcome:
-              Straddle::CustomerCreateParams::Config::SandboxOutcome::OrSymbol
-          ).void
-        end
-        attr_writer :sandbox_outcome
-
-        sig do
-          params(
-            processing_method:
-              Straddle::CustomerCreateParams::Config::ProcessingMethod::OrSymbol,
-            sandbox_outcome:
-              Straddle::CustomerCreateParams::Config::SandboxOutcome::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(processing_method: nil, sandbox_outcome: nil)
-        end
-
-        sig do
-          override.returns(
-            {
-              processing_method:
-                Straddle::CustomerCreateParams::Config::ProcessingMethod::OrSymbol,
-              sandbox_outcome:
-                Straddle::CustomerCreateParams::Config::SandboxOutcome::OrSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module ProcessingMethod
-          extend Straddle::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Straddle::CustomerCreateParams::Config::ProcessingMethod
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          INLINE =
-            T.let(
-              :inline,
-              Straddle::CustomerCreateParams::Config::ProcessingMethod::TaggedSymbol
-            )
-          BACKGROUND =
-            T.let(
-              :background,
-              Straddle::CustomerCreateParams::Config::ProcessingMethod::TaggedSymbol
-            )
-          SKIP =
-            T.let(
-              :skip,
-              Straddle::CustomerCreateParams::Config::ProcessingMethod::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Straddle::CustomerCreateParams::Config::ProcessingMethod::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        module SandboxOutcome
-          extend Straddle::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Straddle::CustomerCreateParams::Config::SandboxOutcome
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          STANDARD =
-            T.let(
-              :standard,
-              Straddle::CustomerCreateParams::Config::SandboxOutcome::TaggedSymbol
-            )
-          VERIFIED =
-            T.let(
-              :verified,
-              Straddle::CustomerCreateParams::Config::SandboxOutcome::TaggedSymbol
-            )
-          REJECTED =
-            T.let(
-              :rejected,
-              Straddle::CustomerCreateParams::Config::SandboxOutcome::TaggedSymbol
-            )
-          REVIEW =
-            T.let(
-              :review,
-              Straddle::CustomerCreateParams::Config::SandboxOutcome::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Straddle::CustomerCreateParams::Config::SandboxOutcome::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
     end
   end
 end