apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/e_gift_wallet_response.rb

@@ -0,0 +1,99 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response containing a collection of eGift wallet gift cards.
+  # Inherits from Gd.Bos.DataTransfer.Response.ResponseBase to provide standard
+  # response metadata and details. Used to return a list of eGift cards
+  # associated with a user's wallet.
+  class EGiftWalletResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets the collection of eGift wallet gift cards.
+    # Each Gd.Bos.DataTransfer.WalletGiftCard contains details about an
+    # individual eGift card in the user's wallet.
+    # @return [Array[WalletGiftCard]]
+    attr_accessor :e_gifts
+
+    # 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['e_gifts'] = 'eGifts'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        e_gifts
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        e_gifts
+        response_details
+      ]
+    end
+
+    def initialize(e_gifts: SKIP, response_details: SKIP)
+      @e_gifts = e_gifts unless e_gifts == 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
+      e_gifts = nil
+      unless hash['eGifts'].nil?
+        e_gifts = []
+        hash['eGifts'].each do |structure|
+          e_gifts << (WalletGiftCard.from_hash(structure) if structure)
+        end
+      end
+
+      e_gifts = SKIP unless hash.key?('eGifts')
+      # 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.
+      EGiftWalletResponse.new(e_gifts: e_gifts,
+                              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} e_gifts: #{@e_gifts}, 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} e_gifts: #{@e_gifts.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/email.rb

@@ -0,0 +1,101 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents an email address and related metadata for a user. Contains the
+  # email address, verification status, default flag, and last updated
+  # timestamp. Used to store and manage user contact information for
+  # notifications, authentication, and communication purposes.
+  class Email < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The user's email address.
+    # @return [String]
+    attr_accessor :email_address
+
+    # Indicates whether the email address has been verified.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_verified
+
+    # Indicates whether this email address is the user's default contact email.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_default
+
+    # The date and time when the email address was last updated, typically in
+    # ISO 8601 format.
+    # @return [String]
+    attr_accessor :last_updated_date_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'emailAddress'
+      @_hash['is_verified'] = 'isVerified'
+      @_hash['is_default'] = 'isDefault'
+      @_hash['last_updated_date_time'] = 'lastUpdatedDateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address
+        is_verified
+        is_default
+        last_updated_date_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        email_address
+        last_updated_date_time
+      ]
+    end
+
+    def initialize(email_address: SKIP, is_verified: SKIP, is_default: SKIP,
+                   last_updated_date_time: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @is_verified = is_verified unless is_verified == SKIP
+      @is_default = is_default unless is_default == SKIP
+      @last_updated_date_time = last_updated_date_time unless last_updated_date_time == 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.
+      email_address = hash.key?('emailAddress') ? hash['emailAddress'] : SKIP
+      is_verified = hash.key?('isVerified') ? hash['isVerified'] : SKIP
+      is_default = hash.key?('isDefault') ? hash['isDefault'] : SKIP
+      last_updated_date_time =
+        hash.key?('lastUpdatedDateTime') ? hash['lastUpdatedDateTime'] : SKIP
+
+      # Create object from extracted values.
+      Email.new(email_address: email_address,
+                is_verified: is_verified,
+                is_default: is_default,
+                last_updated_date_time: last_updated_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address}, is_verified: #{@is_verified}, is_default:"\
+      " #{@is_default}, last_updated_date_time: #{@last_updated_date_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address.inspect}, is_verified:"\
+      " #{@is_verified.inspect}, is_default: #{@is_default.inspect}, last_updated_date_time:"\
+      " #{@last_updated_date_time.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/encrypted_add_account_holder_request.rb

@@ -0,0 +1,128 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to add an account holder to an existing account using
+  # encrypted user profile data. Inherits standard request metadata from
+  # Gd.Bos.DataTransfer.Request.RequestBase.
+  class EncryptedAddAccountHolderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The product material type for the account holder (e.g., "plastic",
+    # "virtual").
+    # @return [String]
+    attr_accessor :product_material_type
+
+    # Indicates whether a physical card should be requested for the new account
+    # holder.
+    # Defaults to true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :request_physical_card
+
+    # The currency code (e.g., "USD") for the account holder's account.
+    # @return [String]
+    attr_accessor :currency
+
+    # The list of terms and conditions acceptances for the account holder.
+    # Each item represents a specific terms acceptance record.
+    # @return [Array[TermsAcceptance]]
+    attr_accessor :terms_acceptances
+
+    # 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 :user_profile
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_material_type'] = 'productMaterialType'
+      @_hash['request_physical_card'] = 'requestPhysicalCard'
+      @_hash['currency'] = 'currency'
+      @_hash['terms_acceptances'] = 'termsAcceptances'
+      @_hash['user_profile'] = 'userProfile'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_material_type
+        request_physical_card
+        currency
+        terms_acceptances
+        user_profile
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        product_material_type
+        currency
+        terms_acceptances
+      ]
+    end
+
+    def initialize(product_material_type: SKIP, request_physical_card: true,
+                   currency: SKIP, terms_acceptances: SKIP, user_profile: SKIP)
+      @product_material_type = product_material_type unless product_material_type == SKIP
+      @request_physical_card = request_physical_card unless request_physical_card == SKIP
+      @currency = currency unless currency == SKIP
+      @terms_acceptances = terms_acceptances unless terms_acceptances == SKIP
+      @user_profile = user_profile unless user_profile == 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.
+      product_material_type =
+        hash.key?('productMaterialType') ? hash['productMaterialType'] : SKIP
+      request_physical_card = hash['requestPhysicalCard'] ||= true
+      currency = hash.key?('currency') ? hash['currency'] : 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')
+      user_profile = EncryptedData.from_hash(hash['userProfile']) if hash['userProfile']
+
+      # Create object from extracted values.
+      EncryptedAddAccountHolderRequest.new(product_material_type: product_material_type,
+                                           request_physical_card: request_physical_card,
+                                           currency: currency,
+                                           terms_acceptances: terms_acceptances,
+                                           user_profile: user_profile)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_material_type: #{@product_material_type}, request_physical_card:"\
+      " #{@request_physical_card}, currency: #{@currency}, terms_acceptances:"\
+      " #{@terms_acceptances}, user_profile: #{@user_profile}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_material_type: #{@product_material_type.inspect},"\
+      " request_physical_card: #{@request_physical_card.inspect}, currency: #{@currency.inspect},"\
+      " terms_acceptances: #{@terms_acceptances.inspect}, user_profile: #{@user_profile.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/encrypted_data.rb

@@ -0,0 +1,108 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # 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.
+  class EncryptedData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The version of the encryption algorithm used to encrypt the data (e.g.,
+    # "v1", "v2").
+    # @return [String]
+    attr_accessor :version
+
+    # The ephemeral public key used in the encryption process, typically for key
+    # exchange or session establishment.
+    # @return [String]
+    attr_accessor :ephemeral_public_key
+
+    # The hash of the public key used to verify the integrity and authenticity
+    # of the encryption key.
+    # @return [String]
+    attr_accessor :public_key_hash
+
+    # The encrypted data payload, typically base64-encoded, containing the
+    # sensitive information.
+    # @return [String]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['version'] = 'version'
+      @_hash['ephemeral_public_key'] = 'ephemeralPublicKey'
+      @_hash['public_key_hash'] = 'publicKeyHash'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        version
+        ephemeral_public_key
+        public_key_hash
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        version
+        ephemeral_public_key
+        public_key_hash
+        data
+      ]
+    end
+
+    def initialize(version: SKIP, ephemeral_public_key: SKIP,
+                   public_key_hash: SKIP, data: SKIP)
+      @version = version unless version == SKIP
+      @ephemeral_public_key = ephemeral_public_key unless ephemeral_public_key == SKIP
+      @public_key_hash = public_key_hash unless public_key_hash == SKIP
+      @data = data unless 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.
+      version = hash.key?('version') ? hash['version'] : SKIP
+      ephemeral_public_key =
+        hash.key?('ephemeralPublicKey') ? hash['ephemeralPublicKey'] : SKIP
+      public_key_hash =
+        hash.key?('publicKeyHash') ? hash['publicKeyHash'] : SKIP
+      data = hash.key?('data') ? hash['data'] : SKIP
+
+      # Create object from extracted values.
+      EncryptedData.new(version: version,
+                        ephemeral_public_key: ephemeral_public_key,
+                        public_key_hash: public_key_hash,
+                        data: data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} version: #{@version}, ephemeral_public_key: #{@ephemeral_public_key},"\
+      " public_key_hash: #{@public_key_hash}, data: #{@data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} version: #{@version.inspect}, ephemeral_public_key:"\
+      " #{@ephemeral_public_key.inspect}, public_key_hash: #{@public_key_hash.inspect}, data:"\
+      " #{@data.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/encrypted_linked_account_request.rb

@@ -0,0 +1,157 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to create or link a new account using encrypted user
+  # profile data. Inherits all properties from
+  # Gd.Bos.DataTransfer.Request.LinkedAccountRequest.
+  class EncryptedLinkedAccountRequest < 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 :user_profile
+
+    # The unique identifier (UID or GUID) of the account to which a new account
+    # will be linked.
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # The product code for the linked account (e.g., card program, account
+    # type).
+    # @return [String]
+    attr_accessor :linked_product_code
+
+    # The material type for the linked product (e.g., "plastic", "virtual").
+    # @return [String]
+    attr_accessor :product_material_type
+
+    # Indicates whether a physical card should be requested for the linked
+    # account.
+    # Defaults to true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :request_physical_card
+
+    # The currency code (e.g., "USD") for the linked account.
+    # @return [String]
+    attr_accessor :currency
+
+    # The list of terms and conditions acceptances for the linked account.
+    # Each item represents a record of a user's acceptance of specific terms and
+    # conditions.
+    # @return [Array[TermsAcceptance]]
+    attr_accessor :terms_acceptances
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_profile'] = 'userProfile'
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['linked_product_code'] = 'linkedProductCode'
+      @_hash['product_material_type'] = 'productMaterialType'
+      @_hash['request_physical_card'] = 'requestPhysicalCard'
+      @_hash['currency'] = 'currency'
+      @_hash['terms_acceptances'] = 'termsAcceptances'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user_profile
+        account_identifier
+        linked_product_code
+        product_material_type
+        request_physical_card
+        currency
+        terms_acceptances
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_identifier
+        linked_product_code
+        product_material_type
+        currency
+        terms_acceptances
+      ]
+    end
+
+    def initialize(user_profile: SKIP, account_identifier: SKIP,
+                   linked_product_code: SKIP, product_material_type: SKIP,
+                   request_physical_card: true, currency: SKIP,
+                   terms_acceptances: SKIP)
+      @user_profile = user_profile unless user_profile == SKIP
+      @account_identifier = account_identifier unless account_identifier == SKIP
+      @linked_product_code = linked_product_code unless linked_product_code == SKIP
+      @product_material_type = product_material_type unless product_material_type == SKIP
+      @request_physical_card = request_physical_card unless request_physical_card == SKIP
+      @currency = currency unless currency == SKIP
+      @terms_acceptances = terms_acceptances unless terms_acceptances == 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_profile = EncryptedData.from_hash(hash['userProfile']) if hash['userProfile']
+      account_identifier =
+        hash.key?('accountIdentifier') ? hash['accountIdentifier'] : SKIP
+      linked_product_code =
+        hash.key?('linkedProductCode') ? hash['linkedProductCode'] : SKIP
+      product_material_type =
+        hash.key?('productMaterialType') ? hash['productMaterialType'] : SKIP
+      request_physical_card = hash['requestPhysicalCard'] ||= true
+      currency = hash.key?('currency') ? hash['currency'] : 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')
+
+      # Create object from extracted values.
+      EncryptedLinkedAccountRequest.new(user_profile: user_profile,
+                                        account_identifier: account_identifier,
+                                        linked_product_code: linked_product_code,
+                                        product_material_type: product_material_type,
+                                        request_physical_card: request_physical_card,
+                                        currency: currency,
+                                        terms_acceptances: terms_acceptances)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user_profile: #{@user_profile}, account_identifier: #{@account_identifier},"\
+      " linked_product_code: #{@linked_product_code}, product_material_type:"\
+      " #{@product_material_type}, request_physical_card: #{@request_physical_card}, currency:"\
+      " #{@currency}, terms_acceptances: #{@terms_acceptances}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user_profile: #{@user_profile.inspect}, account_identifier:"\
+      " #{@account_identifier.inspect}, linked_product_code: #{@linked_product_code.inspect},"\
+      " product_material_type: #{@product_material_type.inspect}, request_physical_card:"\
+      " #{@request_physical_card.inspect}, currency: #{@currency.inspect}, terms_acceptances:"\
+      " #{@terms_acceptances.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/encrypted_user.rb

@@ -0,0 +1,70 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # 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.
+  class EncryptedUser < 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['encrypted_user_data'] = 'encryptedUserData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        encrypted_user_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(encrypted_user_data: SKIP)
+      @encrypted_user_data = encrypted_user_data unless encrypted_user_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.
+      encrypted_user_data = EncryptedData.from_hash(hash['encryptedUserData']) if
+        hash['encryptedUserData']
+
+      # Create object from extracted values.
+      EncryptedUser.new(encrypted_user_data: encrypted_user_data)
+    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}>"
+    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}>"
+    end
+  end
+end