apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/exceptions/get_e_cash_partners_by_location_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 ECash Partners By Location Response – Contains the list of eCash
+  # partners (retailers) found by location.
+  class GetECashPartnersByLocationResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of eCash partners (retailers) found by location.
+    # @return [Array[PartnerByLocationData]]
+    attr_accessor :partners
+
+    # 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
+      @partners = nil
+      unless hash['partners'].nil?
+        @partners = []
+        hash['partners'].each do |structure|
+          @partners << (PartnerByLocationData.from_hash(structure) if structure)
+        end
+      end
+
+      @partners = SKIP unless hash.key?('partners')
+      # 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} partners: #{@partners}, 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} partners: #{@partners.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_e_cash_partners_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 ECash Partners Response – Contains the list of eCash partners
+  # (retailers) for a specific account.
+  class GetECashPartnersResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of eCash partners (retailers).
+    # @return [Array[Partner]]
+    attr_accessor :partners
+
+    # 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
+      @partners = nil
+      unless hash['partners'].nil?
+        @partners = []
+        hash['partners'].each do |structure|
+          @partners << (Partner.from_hash(structure) if structure)
+        end
+      end
+
+      @partners = SKIP unless hash.key?('partners')
+      # 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} partners: #{@partners}, 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} partners: #{@partners.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_e_statement_response_error_exception.rb

@@ -0,0 +1,62 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response containing eStatement data for an account.
+  class GetEStatementResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The electronic statement data for the account.
+    # @return [String]
+    attr_accessor :statements
+
+    # 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
+
+      @statements = hash.key?('statements') ? hash['statements'] : 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} statements: #{@statements}, 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} statements: #{@statements.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_enrollment_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 a successful enrollment retrieval
+  # operation. Contains the full account details, including identifiers, product
+  # information, status, holders, purses, eligibility, and related metadata.
+  # Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetEnrollmentResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents a Green Dot account, including identifiers, product and status
+    # information, account holders, purses, eligibility, and related metadata.
+    # This class is used to provide a comprehensive view of an account's state,
+    # configuration, and associated entities for account management, transfer,
+    # and reporting operations.
+    # @return [Account]
+    attr_accessor :account
+
+    # 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
+
+      @account = Account.from_hash(hash['account']) if hash['account']
+      # 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: #{@account}, 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: #{@account.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_enrollment_type_by_mapping_identifier_response_error_exception.rb

@@ -0,0 +1,74 @@
+# 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 enrollment type
+  # associated with a specific mapping identifier. Contains the mapping
+  # identifier and the corresponding enrollment type. Inherits standard response
+  # metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetEnrollmentTypeByMappingIdentifierResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique mapping identifier used to look up the enrollment type.
+    # @return [String]
+    attr_accessor :mapping_identifier
+
+    # The enrollment type associated with the specified mapping identifier
+    # (e.g., "Retail", "SCC", "Samples").
+    # @return [String]
+    attr_accessor :enrollment_type
+
+    # 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
+
+      @mapping_identifier =
+        hash.key?('mappingIdentifier') ? hash['mappingIdentifier'] : SKIP
+      @enrollment_type =
+        hash.key?('enrollmentType') ? hash['enrollmentType'] : 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} mapping_identifier: #{@mapping_identifier}, enrollment_type:"\
+      " #{@enrollment_type}, 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} mapping_identifier: #{@mapping_identifier.inspect}, enrollment_type:"\
+      " #{@enrollment_type.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_experian_opt_in_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 for retrieving Experian Opt-In and Boost status.
+  # Inherits from Gd.Bos.DataTransfer.Response.ResponseBase to provide standard
+  # response metadata and details.
+  class GetExperianOptInResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether the user has opted in to Experian services.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :opt_in
+
+    # Indicates whether the Experian Boost feature is enabled for the user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :boost
+
+    # 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
+
+      @opt_in = hash.key?('optIn') ? hash['optIn'] : SKIP
+      @boost = hash.key?('boost') ? hash['boost'] : 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} opt_in: #{@opt_in}, boost: #{@boost}, 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} opt_in: #{@opt_in.inspect}, boost: #{@boost.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_experian_redirect_url_response_error_exception.rb

@@ -0,0 +1,65 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response containing the redirect URL for Experian
+  # authentication or data retrieval. Inherits standard response metadata and
+  # details from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetExperianRedirectUrlResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets the redirect URL provided by Experian for authentication or
+    # data access.
+    # @return [String]
+    attr_accessor :redirect_url
+
+    # 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
+
+      @redirect_url = hash.key?('redirectUrl') ? hash['redirectUrl'] : 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} redirect_url: #{@redirect_url}, 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} redirect_url: #{@redirect_url.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_external_card_profile_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 external card profile
+  # information for a customer. Contains a list of card profile details for all
+  # linked external cards. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetExternalCardProfileResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of external card profile information associated with the
+    # customer.
+    # @return [Array[CardProfileInformation]]
+    attr_accessor :card_profile_information
+
+    # 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
+      @card_profile_information = nil
+      unless hash['cardProfileInformation'].nil?
+        @card_profile_information = []
+        hash['cardProfileInformation'].each do |structure|
+          @card_profile_information << (CardProfileInformation.from_hash(structure) if structure)
+        end
+      end
+
+      @card_profile_information = SKIP unless hash.key?('cardProfileInformation')
+      # 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} card_profile_information: #{@card_profile_information}, 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} card_profile_information: #{@card_profile_information.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/exceptions/get_feature_eligibility_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
+  # GetFeatureEligibilityResponse_Error class.
+  class GetFeatureEligibilityResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AccountSubscription]]
+    attr_accessor :account_subscriptions
+
+    # 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_subscriptions = nil
+      unless hash['accountSubscriptions'].nil?
+        @account_subscriptions = []
+        hash['accountSubscriptions'].each do |structure|
+          @account_subscriptions << (AccountSubscription.from_hash(structure) if structure)
+        end
+      end
+
+      @account_subscriptions = SKIP unless hash.key?('accountSubscriptions')
+      # 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_subscriptions: #{@account_subscriptions}, 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_subscriptions: #{@account_subscriptions.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end