apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/exceptions/create_direct_deposit_switch_attempt_response_error_exception.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 attempting to initiate a direct
+  # deposit switch. Contains vendor and switch identifiers, as well as the
+  # vendor name. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class CreateDirectDepositSwitchAttemptResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The token provided by the vendor for tracking or authorizing the direct
+    # deposit switch attempt.
+    # @return [String]
+    attr_accessor :vendor_token
+
+    # The unique identifier for the direct deposit switch attempt.
+    # @return [String]
+    attr_accessor :switch_id
+
+    # The name of the vendor handling the direct deposit switch process.
+    # @return [String]
+    attr_accessor :vendor_name
+
+    # 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
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @vendor_token = hash.key?('vendorToken') ? hash['vendorToken'] : SKIP
+      @switch_id = hash.key?('switchId') ? hash['switchId'] : SKIP
+      @vendor_name = hash.key?('vendorName') ? hash['vendorName'] : 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')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vendor_token: #{@vendor_token}, switch_id: #{@switch_id}, vendor_name:"\
+      " #{@vendor_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} vendor_token: #{@vendor_token.inspect}, switch_id: #{@switch_id.inspect},"\
+      " vendor_name: #{@vendor_name.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/create_disbursement_ach_response_error_exception.rb

@@ -0,0 +1,66 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Create Disbursement ACH Response – Contains the result of an ACH link
+  # creation operation. Used to confirm the creation and provide details of the
+  # linked ACH disbursement.
+  class CreateDisbursementAchResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Disbursement Link – Represents a link or reference to a disbursement
+    # resource, such as a bank card, cash, or ACH disbursement.
+    # Used to provide details about the disbursement link, including its
+    # identifier, URI, status, funds availability, and card association type.
+    # @return [DisbursementLink]
+    attr_accessor :ach
+
+    # 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
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @ach = DisbursementLink.from_hash(hash['ach']) if hash['ach']
+      # 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')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ach: #{@ach}, 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} ach: #{@ach.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/create_disbursement_cash_response_error_exception.rb

@@ -0,0 +1,66 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Create Disbursement Cash Response – Contains the result of a cash link
+  # creation operation. Used to confirm the creation and provide details of the
+  # linked cash disbursement.
+  class CreateDisbursementCashResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Disbursement Link – Represents a link or reference to a disbursement
+    # resource, such as a bank card, cash, or ACH disbursement.
+    # Used to provide details about the disbursement link, including its
+    # identifier, URI, status, funds availability, and card association type.
+    # @return [DisbursementLink]
+    attr_accessor :cash
+
+    # 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
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @cash = DisbursementLink.from_hash(hash['cash']) if hash['cash']
+      # 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')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cash: #{@cash}, 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} cash: #{@cash.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/create_dispute_token_response_error_exception.rb

@@ -0,0 +1,82 @@
+# 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 dispute token. Contains
+  # access token details, token type, expiration, and scope information.
+  # Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class CreateDisputeTokenResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The access token generated for the dispute operation.
+    # @return [String]
+    attr_accessor :access_token
+
+    # The type of token issued.
+    # @return [String]
+    attr_accessor :token_type
+
+    # The number of seconds until the access token expires.
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # The scope of access granted by the token.
+    # @return [String]
+    attr_accessor :scope
+
+    # 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
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @access_token = hash.key?('accessToken') ? hash['accessToken'] : SKIP
+      @token_type = hash.key?('tokenType') ? hash['tokenType'] : SKIP
+      @expires_in = hash.key?('expiresIn') ? hash['expiresIn'] : SKIP
+      @scope = hash.key?('scope') ? hash['scope'] : 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')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_token: #{@access_token}, token_type: #{@token_type}, expires_in:"\
+      " #{@expires_in}, scope: #{@scope}, 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} access_token: #{@access_token.inspect}, token_type: #{@token_type.inspect},"\
+      " expires_in: #{@expires_in.inspect}, scope: #{@scope.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/create_guest_verification_response_error_exception.rb

@@ -0,0 +1,66 @@
+# 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 CreateGuestVerificationResponseErrorException < APIException
+    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
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless 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')
+    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/exceptions/create_idv_response_error_exception.rb

@@ -0,0 +1,68 @@
+# 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 CreateIdvResponseErrorException < APIException
+    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
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless 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')
+    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/exceptions/create_kyc1_response_error_exception.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 response returned after creating a KYC1 gate request.
+  # Contains the KYC1 gate details, including pending gate, status, and any
+  # required properties for further verification. Used to communicate the next
+  # required verification step and current KYC progress for the user.
+  class CreateKyc1ResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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.
+    # @return [CreateKyc1]
+    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
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @kyc_gate = CreateKyc1.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')
+    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/exceptions/create_kyc2_response_error_exception.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 returned after creating a KYC2 gate request.
+  # Contains the KYC2 gate details, including pending gate, status, attempts
+  # remaining, required properties, identity challenges, and encrypted challenge
+  # data. Used to communicate the next required verification step, current KYC
+  # progress, and any additional identity challenge questions for the user.
+  class CreateKyc2ResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the KYC2 gate details returned after a KYC2 request.
+    # Contains pending KYC gate, status, attempts remaining, required
+    # properties, identity challenges, and encrypted challenge data.
+    # Used to communicate the next required verification step, current KYC
+    # progress, and any additional identity challenge questions for the user.
+    # @return [CreateKyc2]
+    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
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @kyc_gate = CreateKyc2.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')
+    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/exceptions/create_mrdc_assessment_response_error_exception.rb

@@ -0,0 +1,85 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after assessing a Mobile Remote Deposit
+  # Capture (MRDC) transfer request. Contains information about account holders
+  # involved in the assessment and any unmet prerequisites required for MRDC
+  # eligibility.
+  class CreateMrdcAssessmentResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of account holders associated with the MRDC transfer assessment.
+    # Each account holder includes identifiers and KYC (Know Your Customer) gate
+    # status information.
+    # @return [Array[AccountHolderAssess]]
+    attr_accessor :account_holders
+
+    # A list of prerequisite conditions that must be met before the MRDC
+    # transfer can proceed.
+    # If any prerequisites are returned, the customer must fulfill them to be
+    # eligible for MRDC check deposit.
+    # @return [Array[String]]
+    attr_accessor :prerequisites
+
+    # 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
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      # Parameter is an array, so we need to iterate through it
+      @account_holders = nil
+      unless hash['accountHolders'].nil?
+        @account_holders = []
+        hash['accountHolders'].each do |structure|
+          @account_holders << (AccountHolderAssess.from_hash(structure) if structure)
+        end
+      end
+
+      @account_holders = SKIP unless hash.key?('accountHolders')
+      @prerequisites = hash.key?('prerequisites') ? hash['prerequisites'] : 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')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_holders: #{@account_holders}, prerequisites: #{@prerequisites},"\
+      " 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} account_holders: #{@account_holders.inspect}, prerequisites:"\
+      " #{@prerequisites.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end