apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/update_user_request_encrypted.rb

@@ -0,0 +1,172 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents an update user request with encrypted user data. Inherits all
+  # properties from Gd.Bos.DataTransfer.Request.UpdateUserRequest and adds an
+  # encrypted user data payload.
+  class UpdateUserRequestEncrypted < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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_user_data
+
+    # The user's preference for accepting peer-to-peer transfers (e.g.,
+    # "AutoAccept", "ManualAccept").
+    # @return [String]
+    attr_accessor :peer_transfer_accept_preference
+
+    # A list of terms and conditions acceptances, indicating which terms the
+    # user has agreed to and the acceptance date/time.
+    # @return [Array[TermsAcceptance]]
+    attr_accessor :terms_acceptances
+
+    # A list of contact verification identifiers (GUIDs) used to verify user
+    # contact methods (e.g., email, phone).
+    # @return [Array[UUID | String]]
+    attr_accessor :contact_verification_identifiers
+
+    # The date and time when the user identifier was created, typically in ISO
+    # 8601 format.
+    # @return [String]
+    attr_accessor :user_id_create_date
+
+    # The date and time when the user's password was last changed, typically in
+    # ISO 8601 format.
+    # @return [String]
+    attr_accessor :password_change_date
+
+    # Indicates whether multi-factor authentication (MFA) should be ignored for
+    # this request. Used for specific scenarios.
+    # @return [String]
+    attr_accessor :ignoremfa
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['encrypted_user_data'] = 'encryptedUserData'
+      @_hash['peer_transfer_accept_preference'] =
+        'peerTransferAcceptPreference'
+      @_hash['terms_acceptances'] = 'termsAcceptances'
+      @_hash['contact_verification_identifiers'] =
+        'contactVerificationIdentifiers'
+      @_hash['user_id_create_date'] = 'userIdCreateDate'
+      @_hash['password_change_date'] = 'passwordChangeDate'
+      @_hash['ignoremfa'] = 'ignoremfa'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        encrypted_user_data
+        peer_transfer_accept_preference
+        terms_acceptances
+        contact_verification_identifiers
+        user_id_create_date
+        password_change_date
+        ignoremfa
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        peer_transfer_accept_preference
+        terms_acceptances
+        contact_verification_identifiers
+        user_id_create_date
+        password_change_date
+        ignoremfa
+      ]
+    end
+
+    def initialize(encrypted_user_data: SKIP,
+                   peer_transfer_accept_preference: SKIP,
+                   terms_acceptances: SKIP,
+                   contact_verification_identifiers: SKIP,
+                   user_id_create_date: SKIP, password_change_date: SKIP,
+                   ignoremfa: SKIP)
+      @encrypted_user_data = encrypted_user_data unless encrypted_user_data == SKIP
+      unless peer_transfer_accept_preference == SKIP
+        @peer_transfer_accept_preference =
+          peer_transfer_accept_preference
+      end
+      @terms_acceptances = terms_acceptances unless terms_acceptances == SKIP
+      unless contact_verification_identifiers == SKIP
+        @contact_verification_identifiers =
+          contact_verification_identifiers
+      end
+      @user_id_create_date = user_id_create_date unless user_id_create_date == SKIP
+      @password_change_date = password_change_date unless password_change_date == SKIP
+      @ignoremfa = ignoremfa unless ignoremfa == 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.
+      encrypted_user_data = EncryptedData.from_hash(hash['encryptedUserData']) if
+        hash['encryptedUserData']
+      peer_transfer_accept_preference =
+        hash.key?('peerTransferAcceptPreference') ? hash['peerTransferAcceptPreference'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      terms_acceptances = nil
+      unless hash['termsAcceptances'].nil?
+        terms_acceptances = []
+        hash['termsAcceptances'].each do |structure|
+          terms_acceptances << (TermsAcceptance.from_hash(structure) if structure)
+        end
+      end
+
+      terms_acceptances = SKIP unless hash.key?('termsAcceptances')
+      contact_verification_identifiers =
+        hash.key?('contactVerificationIdentifiers') ? hash['contactVerificationIdentifiers'] : SKIP
+      user_id_create_date =
+        hash.key?('userIdCreateDate') ? hash['userIdCreateDate'] : SKIP
+      password_change_date =
+        hash.key?('passwordChangeDate') ? hash['passwordChangeDate'] : SKIP
+      ignoremfa = hash.key?('ignoremfa') ? hash['ignoremfa'] : SKIP
+
+      # Create object from extracted values.
+      UpdateUserRequestEncrypted.new(encrypted_user_data: encrypted_user_data,
+                                     peer_transfer_accept_preference: peer_transfer_accept_preference,
+                                     terms_acceptances: terms_acceptances,
+                                     contact_verification_identifiers: contact_verification_identifiers,
+                                     user_id_create_date: user_id_create_date,
+                                     password_change_date: password_change_date,
+                                     ignoremfa: ignoremfa)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} encrypted_user_data: #{@encrypted_user_data},"\
+      " peer_transfer_accept_preference: #{@peer_transfer_accept_preference}, terms_acceptances:"\
+      " #{@terms_acceptances}, contact_verification_identifiers:"\
+      " #{@contact_verification_identifiers}, user_id_create_date: #{@user_id_create_date},"\
+      " password_change_date: #{@password_change_date}, ignoremfa: #{@ignoremfa}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} encrypted_user_data: #{@encrypted_user_data.inspect},"\
+      " peer_transfer_accept_preference: #{@peer_transfer_accept_preference.inspect},"\
+      " terms_acceptances: #{@terms_acceptances.inspect}, contact_verification_identifiers:"\
+      " #{@contact_verification_identifiers.inspect}, user_id_create_date:"\
+      " #{@user_id_create_date.inspect}, password_change_date: #{@password_change_date.inspect},"\
+      " ignoremfa: #{@ignoremfa.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/update_user_response.rb

@@ -0,0 +1,74 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response for a user update operation.
+  class UpdateUserResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(response_details: 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.
+      # 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.
+      UpdateUserResponse.new(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} 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} response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/update_verification_request.rb

@@ -0,0 +1,121 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to update a device verification record or status.
+  # Contains the verification request key, event type, and related identifiers.
+  # Inherits standard request metadata from
+  # Gd.Bos.DataTransfer.Request.RequestBase.
+  class UpdateVerificationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique key identifying the device verification request to update.
+    # @return [Integer]
+    attr_accessor :device_verification_request_key
+
+    # The event type for device verification (e.g., GuestCheckOut, Enrollment,
+    # Login, PreLoginCardActivation).
+    # Uses Gd.Bos.DataTransfer.Enums.DeviceVerificationEventType to specify the
+    # verification scenario.
+    # @return [EventType]
+    attr_accessor :event_type
+
+    # The unique identifier for the account associated with the device
+    # verification.
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # The unique identifier for the user associated with the device
+    # verification.
+    # @return [String]
+    attr_accessor :user_identifier
+
+    # The unique identifier for the transfer associated with the device
+    # verification, if applicable.
+    # @return [String]
+    attr_accessor :transfer_identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_verification_request_key'] =
+        'deviceVerificationRequestKey'
+      @_hash['event_type'] = 'eventType'
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['user_identifier'] = 'userIdentifier'
+      @_hash['transfer_identifier'] = 'transferIdentifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_identifier
+        user_identifier
+        transfer_identifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_identifier
+        user_identifier
+        transfer_identifier
+      ]
+    end
+
+    def initialize(device_verification_request_key:, event_type:,
+                   account_identifier: SKIP, user_identifier: SKIP,
+                   transfer_identifier: SKIP)
+      @device_verification_request_key = device_verification_request_key
+      @event_type = event_type
+      @account_identifier = account_identifier unless account_identifier == SKIP
+      @user_identifier = user_identifier unless user_identifier == SKIP
+      @transfer_identifier = transfer_identifier unless transfer_identifier == 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.
+      device_verification_request_key =
+        hash.key?('deviceVerificationRequestKey') ? hash['deviceVerificationRequestKey'] : nil
+      event_type = hash.key?('eventType') ? hash['eventType'] : nil
+      account_identifier =
+        hash.key?('accountIdentifier') ? hash['accountIdentifier'] : SKIP
+      user_identifier =
+        hash.key?('userIdentifier') ? hash['userIdentifier'] : SKIP
+      transfer_identifier =
+        hash.key?('transferIdentifier') ? hash['transferIdentifier'] : SKIP
+
+      # Create object from extracted values.
+      UpdateVerificationRequest.new(device_verification_request_key: device_verification_request_key,
+                                    event_type: event_type,
+                                    account_identifier: account_identifier,
+                                    user_identifier: user_identifier,
+                                    transfer_identifier: transfer_identifier)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} device_verification_request_key: #{@device_verification_request_key},"\
+      " event_type: #{@event_type}, account_identifier: #{@account_identifier}, user_identifier:"\
+      " #{@user_identifier}, transfer_identifier: #{@transfer_identifier}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} device_verification_request_key:"\
+      " #{@device_verification_request_key.inspect}, event_type: #{@event_type.inspect},"\
+      " account_identifier: #{@account_identifier.inspect}, user_identifier:"\
+      " #{@user_identifier.inspect}, transfer_identifier: #{@transfer_identifier.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/update_verification_response.rb

@@ -0,0 +1,77 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after updating a verification record or
+  # status. Used to indicate the outcome of a verification update operation.
+  # Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class UpdateVerificationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(response_details: 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.
+      # 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.
+      UpdateVerificationResponse.new(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} 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} response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/updated_tranfer.rb

@@ -0,0 +1,69 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the updated status of a transfer operation. Contains the transfer
+  # status value, which reflects the current state of the transfer (e.g.,
+  # "Pending", "Completed", "Failed"). Used to communicate or persist transfer
+  # status updates in API responses, workflows, or business logic.
+  class UpdatedTranfer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The current status of the transfer (e.g., "Pending", "Completed",
+    # "Failed").
+    # @return [String]
+    attr_accessor :transfer_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transfer_status'] = 'transferStatus'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_status
+      ]
+    end
+
+    def initialize(transfer_status: SKIP)
+      @transfer_status = transfer_status unless transfer_status == 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.
+      transfer_status =
+        hash.key?('transferStatus') ? hash['transferStatus'] : SKIP
+
+      # Create object from extracted values.
+      UpdatedTranfer.new(transfer_status: transfer_status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_status: #{@transfer_status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_status: #{@transfer_status.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/upload_consumer_profile_attachment_request.rb

@@ -0,0 +1,146 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module GdBosV1
+  # Represents a request to upload an attachment to a user's consumer profile.
+  # Contains the attachment type, file data, file extension, effective and
+  # expiration dates, and related identifiers. Used in the Add Consumer Profile
+  # Attachment API to associate supporting documents (such as MLA or SCRA
+  # documents) with a consumer profile for compliance or verification purposes.
+  # Inherits standard request metadata from
+  # Gd.Bos.DataTransfer.Request.RequestBase.
+  class UploadConsumerProfileAttachmentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of attachment being uploaded (e.g., MLA document, SCRA document).
+    # @return [AttachmentType]
+    attr_accessor :attachment_type
+
+    # The binary file data of the attachment (e.g., PDF, image) to be uploaded.
+    # @return [String]
+    attr_accessor :attachment
+
+    # The file extension of the attachment (e.g., "pdf", "jpg", "png").
+    # @return [String]
+    attr_accessor :attachment_extension
+
+    # The date when the attachment becomes effective, if applicable.
+    # @return [DateTime]
+    attr_accessor :effective_date
+
+    # The date when the attachment expires, if applicable.
+    # @return [DateTime]
+    attr_accessor :expiration_date
+
+    # The unique identifier of the account associated with the consumer profile.
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attachment_type'] = 'attachmentType'
+      @_hash['attachment'] = 'attachment'
+      @_hash['attachment_extension'] = 'attachmentExtension'
+      @_hash['effective_date'] = 'effectiveDate'
+      @_hash['expiration_date'] = 'expirationDate'
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        attachment_type
+        attachment
+        attachment_extension
+        effective_date
+        expiration_date
+        account_identifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        attachment
+        attachment_extension
+        effective_date
+        expiration_date
+        account_identifier
+      ]
+    end
+
+    def initialize(attachment_type: SKIP, attachment: SKIP,
+                   attachment_extension: SKIP, effective_date: SKIP,
+                   expiration_date: SKIP, account_identifier: SKIP)
+      @attachment_type = attachment_type unless attachment_type == SKIP
+      @attachment = attachment unless attachment == SKIP
+      @attachment_extension = attachment_extension unless attachment_extension == SKIP
+      @effective_date = effective_date unless effective_date == SKIP
+      @expiration_date = expiration_date unless expiration_date == SKIP
+      @account_identifier = account_identifier unless account_identifier == 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.
+      attachment_type =
+        hash.key?('attachmentType') ? hash['attachmentType'] : SKIP
+      attachment = hash.key?('attachment') ? hash['attachment'] : SKIP
+      attachment_extension =
+        hash.key?('attachmentExtension') ? hash['attachmentExtension'] : SKIP
+      effective_date = if hash.key?('effectiveDate')
+                         (DateTimeHelper.from_rfc3339(hash['effectiveDate']) if hash['effectiveDate'])
+                       else
+                         SKIP
+                       end
+      expiration_date = if hash.key?('expirationDate')
+                          (DateTimeHelper.from_rfc3339(hash['expirationDate']) if hash['expirationDate'])
+                        else
+                          SKIP
+                        end
+      account_identifier =
+        hash.key?('accountIdentifier') ? hash['accountIdentifier'] : SKIP
+
+      # Create object from extracted values.
+      UploadConsumerProfileAttachmentRequest.new(attachment_type: attachment_type,
+                                                 attachment: attachment,
+                                                 attachment_extension: attachment_extension,
+                                                 effective_date: effective_date,
+                                                 expiration_date: expiration_date,
+                                                 account_identifier: account_identifier)
+    end
+
+    def to_custom_effective_date
+      DateTimeHelper.to_rfc3339(effective_date)
+    end
+
+    def to_custom_expiration_date
+      DateTimeHelper.to_rfc3339(expiration_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} attachment_type: #{@attachment_type}, attachment: #{@attachment},"\
+      " attachment_extension: #{@attachment_extension}, effective_date: #{@effective_date},"\
+      " expiration_date: #{@expiration_date}, account_identifier: #{@account_identifier}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} attachment_type: #{@attachment_type.inspect}, attachment:"\
+      " #{@attachment.inspect}, attachment_extension: #{@attachment_extension.inspect},"\
+      " effective_date: #{@effective_date.inspect}, expiration_date: #{@expiration_date.inspect},"\
+      " account_identifier: #{@account_identifier.inspect}>"
+    end
+  end
+end