apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/exceptions/get_atm_locations_response_error_exception.rb

@@ -0,0 +1,92 @@
+# 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 list of ATM locations.
+  # Contains a list of ATM locations, total record count, and paging
+  # information. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetAtmLocationsResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of ATM locations matching the search or filter criteria.
+    # @return [Array[AtmLocation]]
+    attr_accessor :locations
+
+    # The total number of ATM location records available for the query.
+    # @return [Integer]
+    attr_accessor :total_record_count
+
+    # The offset (starting index) for the current page of results.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # The maximum number of ATM locations returned in this response (page size).
+    # @return [Integer]
+    attr_accessor :limit
+
+    # 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
+      @locations = nil
+      unless hash['locations'].nil?
+        @locations = []
+        hash['locations'].each do |structure|
+          @locations << (AtmLocation.from_hash(structure) if structure)
+        end
+      end
+
+      @locations = SKIP unless hash.key?('locations')
+      @total_record_count =
+        hash.key?('totalRecordCount') ? hash['totalRecordCount'] : SKIP
+      @offset = hash.key?('offset') ? hash['offset'] : SKIP
+      @limit = hash.key?('limit') ? hash['limit'] : 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} locations: #{@locations}, total_record_count: #{@total_record_count},"\
+      " offset: #{@offset}, limit: #{@limit}, 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} locations: #{@locations.inspect}, total_record_count:"\
+      " #{@total_record_count.inspect}, offset: #{@offset.inspect}, limit: #{@limit.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_auth_customer_sso_token_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 containing a Single Sign-On (SSO) token for an
+  # authenticated customer.
+  class GetAuthCustomerSsoTokenResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Single Sign-On (SSO) token issued for the authenticated customer.
+    # @return [String]
+    attr_accessor :token
+
+    # The unique identifier of the authenticated 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
+
+      @token = hash.key?('token') ? hash['token'] : 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} token: #{@token}, 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} token: #{@token.inspect}, customer_id: #{@customer_id.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_bank_eligibility_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 when checking the eligibility and supported
+  # features of a bank based on its routing number. Contains information about
+  # the bank's supported features, such as RTP (Real-Time Payments) and ACH
+  # (Automated Clearing House) capabilities. Inherits standard response metadata
+  # from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetBankEligibilityResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the set of payment features supported by a bank.
+    # Indicates whether the bank supports Real-Time Payments (RTP) and Automated
+    # Clearing House (ACH) transactions.
+    # Used to determine the types of payment operations that can be performed
+    # with the bank in eligibility and transfer scenarios.
+    # @return [BankFeatures]
+    attr_accessor :bank_features
+
+    # 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
+
+      @bank_features = BankFeatures.from_hash(hash['bankFeatures']) if hash['bankFeatures']
+      # 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} bank_features: #{@bank_features}, 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} bank_features: #{@bank_features.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_bank_name_response_error_exception.rb

@@ -0,0 +1,67 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned when retrieving the name of a bank based on
+  # a given identifier or routing number. Contains the resolved bank name and
+  # inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase. Used to provide bank
+  # identification details in response to lookup or validation requests.
+  class GetBankNameResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the bank associated with the provided identifier or routing
+    # number.
+    # @return [String]
+    attr_accessor :bank_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
+
+      @bank_name = hash.key?('bankName') ? hash['bankName'] : 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} bank_name: #{@bank_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} bank_name: #{@bank_name.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_barcodes_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
+  # Get Barcodes Response – Contains the list of active barcodes for a specific
+  # account.
+  class GetBarcodesResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of active barcodes associated with the account.
+    # @return [Array[BarcodeDetails]]
+    attr_accessor :e_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
+
+      # Parameter is an array, so we need to iterate through it
+      @e_cash = nil
+      unless hash['eCash'].nil?
+        @e_cash = []
+        hash['eCash'].each do |structure|
+          @e_cash << (BarcodeDetails.from_hash(structure) if structure)
+        end
+      end
+
+      @e_cash = SKIP unless hash.key?('eCash')
+      # 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} e_cash: #{@e_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} e_cash: #{@e_cash.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_business_lookup_response_error_exception.rb

@@ -0,0 +1,108 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving business lookup data.
+  # Contains lists of available business industries, consumer profile types, and
+  # consumer profile roles. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetBusinessLookupResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of available business industries, each with a code and
+    # description.
+    # @return [Array[IndustryItem]]
+    attr_accessor :business_industry
+
+    # The list of available consumer profile types (business structures), each
+    # with a code, description, and allowed number of owners.
+    # @return [Array[StructureItem]]
+    attr_accessor :consumer_profile_type
+
+    # The list of available consumer profile roles, each with a code,
+    # description, and associated profile type codes.
+    # @return [Array[RoleItem]]
+    attr_accessor :consumer_profile_role
+
+    # 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
+      @business_industry = nil
+      unless hash['businessIndustry'].nil?
+        @business_industry = []
+        hash['businessIndustry'].each do |structure|
+          @business_industry << (IndustryItem.from_hash(structure) if structure)
+        end
+      end
+
+      @business_industry = SKIP unless hash.key?('businessIndustry')
+      # Parameter is an array, so we need to iterate through it
+      @consumer_profile_type = nil
+      unless hash['consumerProfileType'].nil?
+        @consumer_profile_type = []
+        hash['consumerProfileType'].each do |structure|
+          @consumer_profile_type << (StructureItem.from_hash(structure) if structure)
+        end
+      end
+
+      @consumer_profile_type = SKIP unless hash.key?('consumerProfileType')
+      # Parameter is an array, so we need to iterate through it
+      @consumer_profile_role = nil
+      unless hash['consumerProfileRole'].nil?
+        @consumer_profile_role = []
+        hash['consumerProfileRole'].each do |structure|
+          @consumer_profile_role << (RoleItem.from_hash(structure) if structure)
+        end
+      end
+
+      @consumer_profile_role = SKIP unless hash.key?('consumerProfileRole')
+      # 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} business_industry: #{@business_industry}, consumer_profile_type:"\
+      " #{@consumer_profile_type}, consumer_profile_role: #{@consumer_profile_role},"\
+      " 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} business_industry: #{@business_industry.inspect}, consumer_profile_type:"\
+      " #{@consumer_profile_type.inspect}, consumer_profile_role:"\
+      " #{@consumer_profile_role.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_business_metadata_response_error_exception.rb

@@ -0,0 +1,86 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving business metadata for an
+  # account. Contains business information, address, and a list of owners.
+  # Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetBusinessMetadataResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents business information details for a business account.
+    # @return [BusinessInfoDataModel]
+    attr_accessor :info
+
+    # Represents the business address details for a business account.
+    # @return [BusinessAddressDataModel]
+    attr_accessor :address
+
+    # The list of owners associated with the business, including identifiers,
+    # names, address, SSN, birth year, and verification status.
+    # @return [Array[GetOwnerDataTransferModel]]
+    attr_accessor :owners
+
+    # 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
+
+      @info = BusinessInfoDataModel.from_hash(hash['info']) if hash['info']
+      @address = BusinessAddressDataModel.from_hash(hash['address']) if hash['address']
+      # Parameter is an array, so we need to iterate through it
+      @owners = nil
+      unless hash['owners'].nil?
+        @owners = []
+        hash['owners'].each do |structure|
+          @owners << (GetOwnerDataTransferModel.from_hash(structure) if structure)
+        end
+      end
+
+      @owners = SKIP unless hash.key?('owners')
+      # 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} info: #{@info}, address: #{@address}, owners: #{@owners}, 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} info: #{@info.inspect}, address: #{@address.inspect}, owners:"\
+      " #{@owners.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_business_profile_response_error_exception.rb

@@ -0,0 +1,80 @@
+# 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 business profile for an
+  # account. Contains both the plain and encrypted business profile data.
+  # Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetBusinessProfileResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents a business profile entity used for updating business account
+    # information.
+    # Contains business identity, address, contact, and industry details.
+    # @return [BusinessProfile]
+    attr_accessor :business_profile
+
+    # 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_business_profile
+
+    # 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
+
+      @business_profile = BusinessProfile.from_hash(hash['businessProfile']) if
+        hash['businessProfile']
+      @encrypted_business_profile = EncryptedData.from_hash(hash['encryptedBusinessProfile']) if
+        hash['encryptedBusinessProfile']
+      # 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} business_profile: #{@business_profile}, encrypted_business_profile:"\
+      " #{@encrypted_business_profile}, 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} business_profile: #{@business_profile.inspect}, encrypted_business_profile:"\
+      " #{@encrypted_business_profile.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end