apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/exceptions/get_credit_line_range_response_error_exception.rb

@@ -0,0 +1,102 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving the eligible credit line
+  # range for an account. Inherits standard response metadata and details from
+  # Gd.Bos.DataTransfer.Response.ResponseBase. Contains the minimum and maximum
+  # credit line amounts, as well as the income and expense data used in the
+  # calculation. Used to communicate the calculated credit line range and the
+  # financial context for the account.
+  class GetCreditLineRangeResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The minimum eligible credit line amount for the account.
+    # @return [Integer]
+    attr_accessor :min_credit_line
+
+    # The maximum eligible credit line amount for the account.
+    # @return [Integer]
+    attr_accessor :max_credit_line
+
+    # The user's monthly income amount used in the credit line calculation.
+    # @return [Float]
+    attr_accessor :income
+
+    # The frequency of the income (e.g., "monthly", "weekly") used in the
+    # calculation.
+    # @return [String]
+    attr_accessor :income_frequency
+
+    # The user's monthly expense amount used in the credit line calculation.
+    # @return [Float]
+    attr_accessor :expense
+
+    # The frequency of the expense (e.g., "monthly", "weekly") used in the
+    # calculation.
+    # @return [String]
+    attr_accessor :expense_frequency
+
+    # 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
+
+      @min_credit_line =
+        hash.key?('minCreditLine') ? hash['minCreditLine'] : SKIP
+      @max_credit_line =
+        hash.key?('maxCreditLine') ? hash['maxCreditLine'] : SKIP
+      @income = hash.key?('income') ? hash['income'] : SKIP
+      @income_frequency =
+        hash.key?('incomeFrequency') ? hash['incomeFrequency'] : SKIP
+      @expense = hash.key?('expense') ? hash['expense'] : SKIP
+      @expense_frequency =
+        hash.key?('expenseFrequency') ? hash['expenseFrequency'] : 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} min_credit_line: #{@min_credit_line}, max_credit_line: #{@max_credit_line},"\
+      " income: #{@income}, income_frequency: #{@income_frequency}, expense: #{@expense},"\
+      " expense_frequency: #{@expense_frequency}, 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} min_credit_line: #{@min_credit_line.inspect}, max_credit_line:"\
+      " #{@max_credit_line.inspect}, income: #{@income.inspect}, income_frequency:"\
+      " #{@income_frequency.inspect}, expense: #{@expense.inspect}, expense_frequency:"\
+      " #{@expense_frequency.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_credit_scores_response_error_exception.rb

@@ -0,0 +1,88 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving a user's credit scores for
+  # a specified period. Inherits standard response metadata and details from
+  # Gd.Bos.DataTransfer.Response.ResponseBase. Contains an array of credit
+  # scores and detailed credit score range information. Used to communicate the
+  # user's credit score history and related details for compliance, risk
+  # assessment, or user reporting.
+  class GetCreditScoresResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of credit score records, each containing the score, update date,
+    # and reason codes.
+    # @return [Array[CreditScore]]
+    attr_accessor :credit_scores
+
+    # Represents detailed information about the credit score range.
+    # Contains the minimum and maximum possible credit scores for the scoring
+    # model or reporting period.
+    # Used to provide context for interpreting a user's credit score within the
+    # possible range.
+    # @return [CreditScoreDetail]
+    attr_accessor :credit_score_detail
+
+    # 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
+      @credit_scores = nil
+      unless hash['creditScores'].nil?
+        @credit_scores = []
+        hash['creditScores'].each do |structure|
+          @credit_scores << (CreditScore.from_hash(structure) if structure)
+        end
+      end
+
+      @credit_scores = SKIP unless hash.key?('creditScores')
+      @credit_score_detail = CreditScoreDetail.from_hash(hash['creditScoreDetail']) if
+        hash['creditScoreDetail']
+      # 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} credit_scores: #{@credit_scores}, credit_score_detail:"\
+      " #{@credit_score_detail}, 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} credit_scores: #{@credit_scores.inspect}, credit_score_detail:"\
+      " #{@credit_score_detail.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_custom_card_response_error_exception.rb

@@ -0,0 +1,76 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving custom card information.
+  # Contains a list of custom cards with status, activity, order, and image
+  # details. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetCustomCardResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of custom cards returned by the operation.
+    # Each Gd.Bos.DataTransfer.Response.ResponseObjects.CustomCard includes card
+    # status, activity, order date, and associated images.
+    # @return [Array[CustomCard]]
+    attr_accessor :custom_card
+
+    # 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
+      @custom_card = nil
+      unless hash['customCard'].nil?
+        @custom_card = []
+        hash['customCard'].each do |structure|
+          @custom_card << (CustomCard.from_hash(structure) if structure)
+        end
+      end
+
+      @custom_card = SKIP unless hash.key?('customCard')
+      # 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} custom_card: #{@custom_card}, 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} custom_card: #{@custom_card.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_customer_enrollment_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 containing customer enrollment status information.
+  class GetCustomerEnrollmentResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The numeric enrollment status code for the customer.
+    # @return [Integer]
+    attr_accessor :enrollment_status_code
+
+    # The enrollment status as an enumerated value.
+    # @return [EnrollmentStatus]
+    attr_accessor :enrollment_status
+
+    # The unique identifier of the customer.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # 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
+
+      @enrollment_status_code =
+        hash.key?('enrollmentStatusCode') ? hash['enrollmentStatusCode'] : SKIP
+      @enrollment_status =
+        hash.key?('enrollmentStatus') ? hash['enrollmentStatus'] : SKIP
+      @customer_id = hash.key?('customerId') ? hash['customerId'] : 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} enrollment_status_code: #{@enrollment_status_code}, enrollment_status:"\
+      " #{@enrollment_status}, customer_id: #{@customer_id}, 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} enrollment_status_code: #{@enrollment_status_code.inspect},"\
+      " enrollment_status: #{@enrollment_status.inspect}, customer_id: #{@customer_id.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_customer_profile_global_fund_transfer_response_encrypted_error_exception.rb

@@ -0,0 +1,71 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving an encrypted customer
+  # profile for global fund transfer operations. Contains the encrypted customer
+  # profile data. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetCustomerProfileGlobalFundTransferResponseEncryptedErrorException < APIException
+    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_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
+
+    # 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
+
+      @encrypted_data = EncryptedData.from_hash(hash['encryptedData']) if hash['encryptedData']
+      # 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} encrypted_data: #{@encrypted_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} encrypted_data: #{@encrypted_data.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_direct_depositor_response_error_exception.rb

@@ -0,0 +1,71 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # GetDirectDepositorResponse_Error class.
+  class GetDirectDepositorResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :direct_deposit_review_key
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :direct_depositor_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
+
+      @direct_deposit_review_key =
+        hash.key?('directDepositReviewKey') ? hash['directDepositReviewKey'] : SKIP
+      @direct_depositor_name =
+        hash.key?('directDepositorName') ? hash['directDepositorName'] : 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} direct_deposit_review_key: #{@direct_deposit_review_key},"\
+      " direct_depositor_name: #{@direct_depositor_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} direct_deposit_review_key: #{@direct_deposit_review_key.inspect},"\
+      " direct_depositor_name: #{@direct_depositor_name.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_direct_deposits_response_error_exception.rb

@@ -0,0 +1,72 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response for a direct deposit transactions query.
+  class GetDirectDepositsResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of direct deposit transactions returned by the query.
+    # @return [Array[DirectDeposit]]
+    attr_accessor :direct_deposits
+
+    # 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
+      @direct_deposits = nil
+      unless hash['directDeposits'].nil?
+        @direct_deposits = []
+        hash['directDeposits'].each do |structure|
+          @direct_deposits << (DirectDeposit.from_hash(structure) if structure)
+        end
+      end
+
+      @direct_deposits = SKIP unless hash.key?('directDeposits')
+      # 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} direct_deposits: #{@direct_deposits}, 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} direct_deposits: #{@direct_deposits.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_document_response_error_exception.rb

@@ -0,0 +1,64 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response containing a document file for a document retrieval
+  # operation.
+  class GetDocumentResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The content of the document file, typically base64-encoded or serialized
+    # as a string.
+    # @return [String]
+    attr_accessor :document_file
+
+    # 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
+
+      @document_file = hash.key?('documentFile') ? hash['documentFile'] : 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} document_file: #{@document_file}, 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_file: #{@document_file.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end