apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/create_push_provision_data_request.rb

@@ -0,0 +1,79 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to initiate push provisioning of a payment instrument
+  # to a digital wallet. Contains all necessary data for the provisioning
+  # process, including wallet provider, account and instrument identifiers, and
+  # device-specific data.
+  class CreatePushProvisionDataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets the provider of the wallet to which the payment instrument
+    # will be provisioned.
+    # @return [WalletProvider]
+    attr_accessor :wallet_provider
+
+    # Container for device data related to push provisioning request
+    # @return [DeviceData]
+    attr_accessor :device_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['wallet_provider'] = 'walletProvider'
+      @_hash['device_data'] = 'deviceData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        wallet_provider
+        device_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        wallet_provider
+      ]
+    end
+
+    def initialize(wallet_provider: SKIP, device_data: SKIP)
+      @wallet_provider = wallet_provider unless wallet_provider == SKIP
+      @device_data = device_data unless device_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.
+      wallet_provider =
+        hash.key?('walletProvider') ? hash['walletProvider'] : SKIP
+      device_data = DeviceData.from_hash(hash['deviceData']) if hash['deviceData']
+
+      # Create object from extracted values.
+      CreatePushProvisionDataRequest.new(wallet_provider: wallet_provider,
+                                         device_data: device_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} wallet_provider: #{@wallet_provider}, device_data: #{@device_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} wallet_provider: #{@wallet_provider.inspect}, device_data:"\
+      " #{@device_data.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_push_provision_data_response.rb

@@ -0,0 +1,177 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Container for response data from creating push provision data
+  class CreatePushProvisionDataResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Base 64 encoded provisioning activation data when provisioning request is
+    # for Apple
+    # @return [String]
+    attr_accessor :activation_data
+
+    # 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_payment_data
+
+    # Opc when provisioning request is for Google
+    # @return [String]
+    attr_accessor :opc
+
+    # Description of associated product
+    # @return [String]
+    attr_accessor :display_name
+
+    # Identifier for payment network operator (Visa/MasterCard/Discover/QUICPay)
+    # @return [String]
+    attr_accessor :payment_network_operator
+
+    # Container for address information, including street, city, state, postal
+    # code, and metadata.
+    # Used for storing and transferring user or account address details.
+    # @return [Address]
+    attr_accessor :billing_address
+
+    # Represents a phone number and related metadata for a user.
+    # Contains the phone number value, type, verification status, default flag,
+    # and last updated timestamp.
+    # Used to store and manage user contact information for notifications,
+    # authentication, and communication purposes.
+    # @return [PhoneNumber]
+    attr_accessor :phone_number
+
+    # Last four digits of the payment card
+    # @return [String]
+    attr_accessor :last4_pan
+
+    # 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['activation_data'] = 'activationData'
+      @_hash['encrypted_payment_data'] = 'encryptedPaymentData'
+      @_hash['opc'] = 'opc'
+      @_hash['display_name'] = 'displayName'
+      @_hash['payment_network_operator'] = 'paymentNetworkOperator'
+      @_hash['billing_address'] = 'billingAddress'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash['last4_pan'] = 'last4Pan'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        activation_data
+        encrypted_payment_data
+        opc
+        display_name
+        payment_network_operator
+        billing_address
+        phone_number
+        last4_pan
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        activation_data
+        opc
+        display_name
+        payment_network_operator
+        last4_pan
+        response_details
+      ]
+    end
+
+    def initialize(activation_data: SKIP, encrypted_payment_data: SKIP,
+                   opc: SKIP, display_name: SKIP,
+                   payment_network_operator: SKIP, billing_address: SKIP,
+                   phone_number: SKIP, last4_pan: SKIP, response_details: SKIP)
+      @activation_data = activation_data unless activation_data == SKIP
+      @encrypted_payment_data = encrypted_payment_data unless encrypted_payment_data == SKIP
+      @opc = opc unless opc == SKIP
+      @display_name = display_name unless display_name == SKIP
+      @payment_network_operator = payment_network_operator unless payment_network_operator == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @last4_pan = last4_pan unless last4_pan == 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.
+      activation_data =
+        hash.key?('activationData') ? hash['activationData'] : SKIP
+      encrypted_payment_data = EncryptedData.from_hash(hash['encryptedPaymentData']) if
+        hash['encryptedPaymentData']
+      opc = hash.key?('opc') ? hash['opc'] : SKIP
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      payment_network_operator =
+        hash.key?('paymentNetworkOperator') ? hash['paymentNetworkOperator'] : SKIP
+      billing_address = Address.from_hash(hash['billingAddress']) if hash['billingAddress']
+      phone_number = PhoneNumber.from_hash(hash['phoneNumber']) if hash['phoneNumber']
+      last4_pan = hash.key?('last4Pan') ? hash['last4Pan'] : SKIP
+      # 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.
+      CreatePushProvisionDataResponse.new(activation_data: activation_data,
+                                          encrypted_payment_data: encrypted_payment_data,
+                                          opc: opc,
+                                          display_name: display_name,
+                                          payment_network_operator: payment_network_operator,
+                                          billing_address: billing_address,
+                                          phone_number: phone_number,
+                                          last4_pan: last4_pan,
+                                          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} activation_data: #{@activation_data}, encrypted_payment_data:"\
+      " #{@encrypted_payment_data}, opc: #{@opc}, display_name: #{@display_name},"\
+      " payment_network_operator: #{@payment_network_operator}, billing_address:"\
+      " #{@billing_address}, phone_number: #{@phone_number}, last4_pan: #{@last4_pan},"\
+      " 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} activation_data: #{@activation_data.inspect}, encrypted_payment_data:"\
+      " #{@encrypted_payment_data.inspect}, opc: #{@opc.inspect}, display_name:"\
+      " #{@display_name.inspect}, payment_network_operator: #{@payment_network_operator.inspect},"\
+      " billing_address: #{@billing_address.inspect}, phone_number: #{@phone_number.inspect},"\
+      " last4_pan: #{@last4_pan.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_scan_capture_request.rb

@@ -0,0 +1,105 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to submit Matricula Consular ID images for scan capture
+  # verification. Used to initiate document image processing for identity
+  # verification and onboarding, including product context and encrypted
+  # identity documentation.
+  class CreateScanCaptureRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The channel through which the scan capture request was initiated (e.g.,
+    # "Web", "Mobile").
+    # Used to identify the source platform or integration for the request.
+    # @return [String]
+    attr_accessor :channel
+
+    # The product code associated with the scan capture request (e.g., "CARD",
+    # "SAVINGS").
+    # Used to scope the scan capture and verification to a specific product or
+    # service.
+    # @return [String]
+    attr_accessor :product_code
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['channel'] = 'channel'
+      @_hash['product_code'] = 'productCode'
+      @_hash['encrypted_identity_documentation'] =
+        'encryptedIdentityDocumentation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        channel
+        product_code
+        encrypted_identity_documentation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        channel
+        product_code
+      ]
+    end
+
+    def initialize(channel: SKIP, product_code: SKIP,
+                   encrypted_identity_documentation: SKIP)
+      @channel = channel unless channel == SKIP
+      @product_code = product_code unless product_code == SKIP
+      unless encrypted_identity_documentation == SKIP
+        @encrypted_identity_documentation =
+          encrypted_identity_documentation
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      product_code = hash.key?('productCode') ? hash['productCode'] : SKIP
+      if hash['encryptedIdentityDocumentation']
+        encrypted_identity_documentation = EncryptedData.from_hash(hash['encryptedIdentityDocumentation'])
+      end
+
+      # Create object from extracted values.
+      CreateScanCaptureRequest.new(channel: channel,
+                                   product_code: product_code,
+                                   encrypted_identity_documentation: encrypted_identity_documentation)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} channel: #{@channel}, product_code: #{@product_code},"\
+      " encrypted_identity_documentation: #{@encrypted_identity_documentation}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} channel: #{@channel.inspect}, product_code: #{@product_code.inspect},"\
+      " encrypted_identity_documentation: #{@encrypted_identity_documentation.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_scan_capture_response.rb

@@ -0,0 +1,93 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after processing a scan capture request for
+  # identity verification. Contains the extracted document data, such as
+  # onboarding ID, document type, template type, and encrypted identity data.
+  # Used to communicate the results of Matricula Consular ID image processing,
+  # enabling partners to complete onboarding and verification flows.
+  class CreateScanCaptureResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the extracted document data returned after a scan capture or
+    # identity verification operation.
+    # Contains encrypted identity data, onboarding ID, document type, and
+    # template type.
+    # Used to securely transmit identity information and document metadata for
+    # onboarding and compliance processes.
+    # @return [DocumentData]
+    attr_accessor :document_data
+
+    # 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['document_data'] = 'documentData'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        document_data
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(document_data: SKIP, response_details: SKIP)
+      @document_data = document_data unless document_data == 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.
+      document_data = DocumentData.from_hash(hash['documentData']) if hash['documentData']
+      # 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.
+      CreateScanCaptureResponse.new(document_data: document_data,
+                                    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} document_data: #{@document_data}, 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} document_data: #{@document_data.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_token_identifier_response.rb

@@ -0,0 +1,114 @@
+# 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 token identifier. Contains
+  # resource identifiers and detailed token/user information. Inherits standard
+  # response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class CreateTokenIdentifierResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique resource identifier associated with the created token.
+    # @return [String]
+    attr_accessor :resourceid
+
+    # An external resource identifier or context related to the token.
+    # @return [String]
+    attr_accessor :externalresource
+
+    # Represents token and user identification details for a response.
+    # Contains token name, user names, contact info, account and payment
+    # instrument identifiers, and additional metadata.
+    # Used in token-related responses to provide comprehensive identification
+    # and context.
+    # @return [IdentifierData]
+    attr_accessor :identifier
+
+    # 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['resourceid'] = 'resourceid'
+      @_hash['externalresource'] = 'externalresource'
+      @_hash['identifier'] = 'identifier'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        resourceid
+        externalresource
+        identifier
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        resourceid
+        externalresource
+        response_details
+      ]
+    end
+
+    def initialize(resourceid: SKIP, externalresource: SKIP, identifier: SKIP,
+                   response_details: SKIP)
+      @resourceid = resourceid unless resourceid == SKIP
+      @externalresource = externalresource unless externalresource == SKIP
+      @identifier = identifier unless identifier == 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.
+      resourceid = hash.key?('resourceid') ? hash['resourceid'] : SKIP
+      externalresource =
+        hash.key?('externalresource') ? hash['externalresource'] : SKIP
+      identifier = IdentifierData.from_hash(hash['identifier']) if hash['identifier']
+      # 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.
+      CreateTokenIdentifierResponse.new(resourceid: resourceid,
+                                        externalresource: externalresource,
+                                        identifier: identifier,
+                                        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} resourceid: #{@resourceid}, externalresource: #{@externalresource},"\
+      " identifier: #{@identifier}, 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} resourceid: #{@resourceid.inspect}, externalresource:"\
+      " #{@externalresource.inspect}, identifier: #{@identifier.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/create_token_request.rb

@@ -0,0 +1,81 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to create a token for a user or account. Contains
+  # external resource context and detailed identifier data. Inherits standard
+  # request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
+  class CreateTokenRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An external resource identifier or context related to the token creation.
+    # @return [String]
+    attr_accessor :externalresource
+
+    # Represents token and user identification details for a request.
+    # Contains token name, user names, contact info, account and payment
+    # instrument identifiers, and additional metadata.
+    # Used in token-related requests to provide comprehensive identification and
+    # context.
+    # @return [IdentifierRequestData]
+    attr_accessor :identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['externalresource'] = 'externalresource'
+      @_hash['identifier'] = 'identifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        externalresource
+        identifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        externalresource
+      ]
+    end
+
+    def initialize(externalresource: SKIP, identifier: SKIP)
+      @externalresource = externalresource unless externalresource == SKIP
+      @identifier = identifier unless 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.
+      externalresource =
+        hash.key?('externalresource') ? hash['externalresource'] : SKIP
+      identifier = IdentifierRequestData.from_hash(hash['identifier']) if hash['identifier']
+
+      # Create object from extracted values.
+      CreateTokenRequest.new(externalresource: externalresource,
+                             identifier: identifier)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} externalresource: #{@externalresource}, identifier: #{@identifier}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} externalresource: #{@externalresource.inspect}, identifier:"\
+      " #{@identifier.inspect}>"
+    end
+  end
+end