apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/create_guest_verification_encrypted_request.rb

@@ -0,0 +1,95 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a guest verification (payee) creation request with encrypted user
+  # data.
+  class CreateGuestVerificationEncryptedRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Container for encrypted user information, including the encrypted user
+    # data payload
+    # and a list of terms and conditions acceptances.
+    # Used for secure transmission and processing of sensitive user data.
+    # @return [EncryptedUser]
+    attr_accessor :user
+
+    # Gets or sets the unique identifier for the transfer associated with the
+    # guest verification.
+    # @return [String]
+    attr_accessor :transfer_identifier
+
+    # Represents device-specific information used when initiating a transfer or
+    # other sensitive operation.
+    # Contains details about the device and network, such as device ID, make,
+    # model, operating system, and IP addresses.
+    # Used for device identification, risk assessment, auditing, and fraud
+    # prevention.
+    # @return [DeviceInfo]
+    attr_accessor :device
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user'] = 'user'
+      @_hash['transfer_identifier'] = 'transferIdentifier'
+      @_hash['device'] = 'device'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user
+        transfer_identifier
+        device
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_identifier
+      ]
+    end
+
+    def initialize(user: SKIP, transfer_identifier: SKIP, device: SKIP)
+      @user = user unless user == SKIP
+      @transfer_identifier = transfer_identifier unless transfer_identifier == SKIP
+      @device = device unless device == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      user = EncryptedUser.from_hash(hash['user']) if hash['user']
+      transfer_identifier =
+        hash.key?('transferIdentifier') ? hash['transferIdentifier'] : SKIP
+      device = DeviceInfo.from_hash(hash['device']) if hash['device']
+
+      # Create object from extracted values.
+      CreateGuestVerificationEncryptedRequest.new(user: user,
+                                                  transfer_identifier: transfer_identifier,
+                                                  device: device)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user: #{@user}, transfer_identifier: #{@transfer_identifier}, device:"\
+      " #{@device}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user: #{@user.inspect}, transfer_identifier:"\
+      " #{@transfer_identifier.inspect}, device: #{@device.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_guest_verification_response.rb

@@ -0,0 +1,91 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after creating a guest verification
+  # (payee).
+  class CreateGuestVerificationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the status of a guest verification process.
+    # @return [GuestVerificationStatus]
+    attr_accessor :guest_verification_status
+
+    # Required: A list of response details providing status codes, descriptions,
+    # and additional information about the result of the operation.
+    # @return [Array[ResponseDetail]]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['guest_verification_status'] = 'guestVerificationStatus'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        guest_verification_status
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(guest_verification_status: SKIP, response_details: SKIP)
+      unless guest_verification_status == SKIP
+        @guest_verification_status =
+          guest_verification_status
+      end
+      @response_details = response_details unless response_details == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      if hash['guestVerificationStatus']
+        guest_verification_status = GuestVerificationStatus.from_hash(hash['guestVerificationStatus'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      CreateGuestVerificationResponse.new(guest_verification_status: guest_verification_status,
+                                          response_details: response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} guest_verification_status: #{@guest_verification_status}, response_details:"\
+      " #{@response_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} guest_verification_status: #{@guest_verification_status.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_idv.rb

@@ -0,0 +1,70 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response object for an IDV (Identity Verification) operation.
+  # Contains the KYC (Know Your Customer) state data, including OFAC screening
+  # status, overall KYC status, and any pending KYC gates. Used to communicate
+  # the current verification and compliance state for a user after an IDV
+  # request.
+  class CreateIdv < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the Know Your Customer (KYC) state data for a user.
+    # Contains information about OFAC (Office of Foreign Assets Control)
+    # screening status, overall KYC status, and any pending KYC gates.
+    # Used to track regulatory compliance and the current state of user
+    # verification during onboarding or account management.
+    # @return [KycStateData]
+    attr_accessor :kyc_state_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['kyc_state_data'] = 'kycStateData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        kyc_state_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(kyc_state_data: SKIP)
+      @kyc_state_data = kyc_state_data unless kyc_state_data == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      kyc_state_data = KycStateData.from_hash(hash['kycStateData']) if hash['kycStateData']
+
+      # Create object from extracted values.
+      CreateIdv.new(kyc_state_data: kyc_state_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} kyc_state_data: #{@kyc_state_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} kyc_state_data: #{@kyc_state_data.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_idv_request.rb

@@ -0,0 +1,100 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to submit identification verification information for a
+  # user. Used for IDV validation and account upgrade flows.
+  class CreateIdvRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of IDV request (e.g., "AccountUpgrade").
+    # @return [String]
+    attr_accessor :idv_request_type
+
+    # Represents a container for encrypted data used in secure data transfer
+    # operations.
+    # Contains the encrypted payload and associated cryptographic metadata,
+    # including encryption version, ephemeral public key, and public key hash.
+    # Used to securely transmit sensitive information such as user data,
+    # ensuring confidentiality and integrity during transport.
+    # @return [EncryptedData]
+    attr_accessor :encrypted_identity_documentation
+
+    # Optional fraud data for additional verification.
+    # @return [Hash[String, Object]]
+    attr_accessor :fraud_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['idv_request_type'] = 'idvRequestType'
+      @_hash['encrypted_identity_documentation'] =
+        'encryptedIdentityDocumentation'
+      @_hash['fraud_data'] = 'fraudData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        idv_request_type
+        encrypted_identity_documentation
+        fraud_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        idv_request_type
+        fraud_data
+      ]
+    end
+
+    def initialize(idv_request_type: SKIP,
+                   encrypted_identity_documentation: SKIP, fraud_data: SKIP)
+      @idv_request_type = idv_request_type unless idv_request_type == SKIP
+      unless encrypted_identity_documentation == SKIP
+        @encrypted_identity_documentation =
+          encrypted_identity_documentation
+      end
+      @fraud_data = fraud_data unless fraud_data == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      idv_request_type =
+        hash.key?('idvRequestType') ? hash['idvRequestType'] : SKIP
+      if hash['encryptedIdentityDocumentation']
+        encrypted_identity_documentation = EncryptedData.from_hash(hash['encryptedIdentityDocumentation'])
+      end
+      fraud_data = hash.key?('fraudData') ? hash['fraudData'] : SKIP
+
+      # Create object from extracted values.
+      CreateIdvRequest.new(idv_request_type: idv_request_type,
+                           encrypted_identity_documentation: encrypted_identity_documentation,
+                           fraud_data: fraud_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} idv_request_type: #{@idv_request_type}, encrypted_identity_documentation:"\
+      " #{@encrypted_identity_documentation}, fraud_data: #{@fraud_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} idv_request_type: #{@idv_request_type.inspect},"\
+      " encrypted_identity_documentation: #{@encrypted_identity_documentation.inspect},"\
+      " fraud_data: #{@fraud_data.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_idv_response.rb

@@ -0,0 +1,90 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after submitting identification
+  # verification information. Contains KYC state data.
+  class CreateIdvResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the response object for an IDV (Identity Verification)
+    # operation.
+    # Contains the KYC (Know Your Customer) state data, including OFAC screening
+    # status, overall KYC status, and any pending KYC gates.
+    # Used to communicate the current verification and compliance state for a
+    # user after an IDV request.
+    # @return [CreateIdv]
+    attr_accessor :kyc_gate
+
+    # Required: A list of response details providing status codes, descriptions,
+    # and additional information about the result of the operation.
+    # @return [Array[ResponseDetail]]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['kyc_gate'] = 'kycGate'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        kyc_gate
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(kyc_gate: SKIP, response_details: SKIP)
+      @kyc_gate = kyc_gate unless kyc_gate == SKIP
+      @response_details = response_details unless response_details == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      kyc_gate = CreateIdv.from_hash(hash['kycGate']) if hash['kycGate']
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      CreateIdvResponse.new(kyc_gate: kyc_gate,
+                            response_details: response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} kyc_gate: #{@kyc_gate}, response_details: #{@response_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} kyc_gate: #{@kyc_gate.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_kyc1.rb

@@ -0,0 +1,95 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the KYC1 gate details returned after a KYC1 request. Contains the
+  # pending KYC gate, its status, and any required properties for further
+  # verification. Used to communicate the next required verification step and
+  # current KYC progress for the user.
+  class CreateKyc1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pending KYC gate value indicating the next verification step required
+    # for the user.
+    # @return [String]
+    attr_accessor :pending_kyc_gate
+
+    # The status of the current KYC gate (e.g., "Pending", "Passed", "Failed").
+    # @return [String]
+    attr_accessor :kyc_gate_status
+
+    # The list of required properties for the KYC1 gate, such as additional
+    # fields or documents needed.
+    # @return [Array[String]]
+    attr_accessor :required_properties
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pending_kyc_gate'] = 'pendingKycGate'
+      @_hash['kyc_gate_status'] = 'kycGateStatus'
+      @_hash['required_properties'] = 'requiredProperties'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pending_kyc_gate
+        kyc_gate_status
+        required_properties
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        pending_kyc_gate
+        kyc_gate_status
+        required_properties
+      ]
+    end
+
+    def initialize(pending_kyc_gate: SKIP, kyc_gate_status: SKIP,
+                   required_properties: SKIP)
+      @pending_kyc_gate = pending_kyc_gate unless pending_kyc_gate == SKIP
+      @kyc_gate_status = kyc_gate_status unless kyc_gate_status == SKIP
+      @required_properties = required_properties unless required_properties == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      pending_kyc_gate =
+        hash.key?('pendingKycGate') ? hash['pendingKycGate'] : SKIP
+      kyc_gate_status =
+        hash.key?('kycGateStatus') ? hash['kycGateStatus'] : SKIP
+      required_properties =
+        hash.key?('requiredProperties') ? hash['requiredProperties'] : SKIP
+
+      # Create object from extracted values.
+      CreateKyc1.new(pending_kyc_gate: pending_kyc_gate,
+                     kyc_gate_status: kyc_gate_status,
+                     required_properties: required_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pending_kyc_gate: #{@pending_kyc_gate}, kyc_gate_status:"\
+      " #{@kyc_gate_status}, required_properties: #{@required_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pending_kyc_gate: #{@pending_kyc_gate.inspect}, kyc_gate_status:"\
+      " #{@kyc_gate_status.inspect}, required_properties: #{@required_properties.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_kyc1_request.rb

@@ -0,0 +1,82 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to create a KYC1 gate for a user. Used to submit SSN
+  # suffix for KYC1 verification.
+  class CreateKyc1Request < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The last four digits of the user's SSN.
+    # @return [String]
+    attr_accessor :ssn_suffix
+
+    # Represents a container for encrypted data used in secure data transfer
+    # operations.
+    # Contains the encrypted payload and associated cryptographic metadata,
+    # including encryption version, ephemeral public key, and public key hash.
+    # Used to securely transmit sensitive information such as user data,
+    # ensuring confidentiality and integrity during transport.
+    # @return [EncryptedData]
+    attr_accessor :encrypted_ssn_suffix
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ssn_suffix'] = 'ssnSuffix'
+      @_hash['encrypted_ssn_suffix'] = 'encryptedSsnSuffix'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ssn_suffix
+        encrypted_ssn_suffix
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        ssn_suffix
+      ]
+    end
+
+    def initialize(ssn_suffix: SKIP, encrypted_ssn_suffix: SKIP)
+      @ssn_suffix = ssn_suffix unless ssn_suffix == SKIP
+      @encrypted_ssn_suffix = encrypted_ssn_suffix unless encrypted_ssn_suffix == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      ssn_suffix = hash.key?('ssnSuffix') ? hash['ssnSuffix'] : SKIP
+      encrypted_ssn_suffix = EncryptedData.from_hash(hash['encryptedSsnSuffix']) if
+        hash['encryptedSsnSuffix']
+
+      # Create object from extracted values.
+      CreateKyc1Request.new(ssn_suffix: ssn_suffix,
+                            encrypted_ssn_suffix: encrypted_ssn_suffix)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ssn_suffix: #{@ssn_suffix}, encrypted_ssn_suffix:"\
+      " #{@encrypted_ssn_suffix}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ssn_suffix: #{@ssn_suffix.inspect}, encrypted_ssn_suffix:"\
+      " #{@encrypted_ssn_suffix.inspect}>"
+    end
+  end
+end