apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/get_check_book_image_response.rb

@@ -0,0 +1,126 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving checkbook images for a
+  # specific request. Contains the requested image faces, fetch statuses, and a
+  # list of checkbook images. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetCheckBookImageResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of image faces requested (e.g., front, rear, both).
+    # Uses Gd.Bos.DataTransfer.Enums.ImageFaceType to specify which faces of the
+    # check were requested.
+    # @return [RequestedImageFaces]
+    attr_accessor :requested_image_faces
+
+    # The status of the image fetch operation (e.g., none, front, rear, both).
+    # Uses Gd.Bos.DataTransfer.Enums.ImageFetchStatus to indicate which images
+    # were successfully fetched.
+    # @return [ImageFetchStatuses]
+    attr_accessor :image_fetch_statuses
+
+    # The list of checkbook images returned by the operation.
+    # Each Gd.Bos.DataTransfer.CheckBookImage includes the fulfillment key, face
+    # type, and image data.
+    # @return [Array[CheckBookImage]]
+    attr_accessor :images
+
+    # Required: A list of response details providing status codes, descriptions,
+    # and additional information about the result of the operation.
+    # @return [Array[ResponseDetail]]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['requested_image_faces'] = 'requestedImageFaces'
+      @_hash['image_fetch_statuses'] = 'imageFetchStatuses'
+      @_hash['images'] = 'images'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        requested_image_faces
+        image_fetch_statuses
+        images
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        images
+        response_details
+      ]
+    end
+
+    def initialize(requested_image_faces: SKIP, image_fetch_statuses: SKIP,
+                   images: SKIP, response_details: SKIP)
+      @requested_image_faces = requested_image_faces unless requested_image_faces == SKIP
+      @image_fetch_statuses = image_fetch_statuses unless image_fetch_statuses == SKIP
+      @images = images unless images == SKIP
+      @response_details = response_details unless response_details == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      requested_image_faces =
+        hash.key?('requestedImageFaces') ? hash['requestedImageFaces'] : SKIP
+      image_fetch_statuses =
+        hash.key?('imageFetchStatuses') ? hash['imageFetchStatuses'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      images = nil
+      unless hash['images'].nil?
+        images = []
+        hash['images'].each do |structure|
+          images << (CheckBookImage.from_hash(structure) if structure)
+        end
+      end
+
+      images = SKIP unless hash.key?('images')
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      GetCheckBookImageResponse.new(requested_image_faces: requested_image_faces,
+                                    image_fetch_statuses: image_fetch_statuses,
+                                    images: images,
+                                    response_details: response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} requested_image_faces: #{@requested_image_faces}, image_fetch_statuses:"\
+      " #{@image_fetch_statuses}, images: #{@images}, 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} requested_image_faces: #{@requested_image_faces.inspect},"\
+      " image_fetch_statuses: #{@image_fetch_statuses.inspect}, images: #{@images.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/get_check_book_orders_response.rb

@@ -0,0 +1,99 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving checkbook orders for an
+  # account. Contains a list of checkbook order details. Inherits standard
+  # response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetCheckBookOrdersResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of checkbook orders returned by the operation.
+    # Each Gd.Bos.DataTransfer.CheckBookOrder includes confirmation token, order
+    # date, status, and check number range.
+    # @return [Array[CheckBookOrder]]
+    attr_accessor :check_book_orders
+
+    # Required: A list of response details providing status codes, descriptions,
+    # and additional information about the result of the operation.
+    # @return [Array[ResponseDetail]]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['check_book_orders'] = 'checkBookOrders'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        check_book_orders
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        check_book_orders
+        response_details
+      ]
+    end
+
+    def initialize(check_book_orders: SKIP, response_details: SKIP)
+      @check_book_orders = check_book_orders unless check_book_orders == SKIP
+      @response_details = response_details unless response_details == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      check_book_orders = nil
+      unless hash['checkBookOrders'].nil?
+        check_book_orders = []
+        hash['checkBookOrders'].each do |structure|
+          check_book_orders << (CheckBookOrder.from_hash(structure) if structure)
+        end
+      end
+
+      check_book_orders = SKIP unless hash.key?('checkBookOrders')
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      GetCheckBookOrdersResponse.new(check_book_orders: check_book_orders,
+                                     response_details: response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} check_book_orders: #{@check_book_orders}, 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} check_book_orders: #{@check_book_orders.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/get_check_images_response.rb

@@ -0,0 +1,106 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response containing check image data for a check deposit or
+  # retrieval operation.
+  class GetCheckImagesResponse < BaseModel
+    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_check_image_data
+
+    # Represents the front and back images of a check.
+    # @return [CheckImage]
+    attr_accessor :check_image_data
+
+    # Required: A list of response details providing status codes, descriptions,
+    # and additional information about the result of the operation.
+    # @return [Array[ResponseDetail]]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['encrypted_check_image_data'] = 'encryptedCheckImageData'
+      @_hash['check_image_data'] = 'checkImageData'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        encrypted_check_image_data
+        check_image_data
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(encrypted_check_image_data: SKIP, check_image_data: SKIP,
+                   response_details: SKIP)
+      unless encrypted_check_image_data == SKIP
+        @encrypted_check_image_data =
+          encrypted_check_image_data
+      end
+      @check_image_data = check_image_data unless check_image_data == SKIP
+      @response_details = response_details unless response_details == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      encrypted_check_image_data = EncryptedData.from_hash(hash['encryptedCheckImageData']) if
+        hash['encryptedCheckImageData']
+      check_image_data = CheckImage.from_hash(hash['checkImageData']) if hash['checkImageData']
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      GetCheckImagesResponse.new(encrypted_check_image_data: encrypted_check_image_data,
+                                 check_image_data: check_image_data,
+                                 response_details: response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} encrypted_check_image_data: #{@encrypted_check_image_data},"\
+      " check_image_data: #{@check_image_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_check_image_data: #{@encrypted_check_image_data.inspect},"\
+      " check_image_data: #{@check_image_data.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/get_collection_account_status_history_response.rb

@@ -0,0 +1,156 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response containing the status history of a collection
+  # account, including account identifiers, flags for account actions, and a
+  # list of status history entries. Inherits standard response metadata and
+  # details from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetCollectionAccountStatusHistoryResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets the unique identifier for the collection account.
+    # @return [UUID | String]
+    attr_accessor :account_identifier
+
+    # Gets or sets a value indicating whether the account has been sent to
+    # TrueAccord.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_sent_to_true_accord
+
+    # Gets or sets a value indicating whether a cease and desist has been
+    # applied to the account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cease_and_desist
+
+    # Gets or sets a value indicating whether the account was recalled with no
+    # payment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :recalled_with_no_payment
+
+    # Gets or sets the list of status history entries for the collection
+    # account.
+    # @return [Array[CollectionAccountStatusHistory]]
+    attr_accessor :collection_account_status_histories
+
+    # Required: A list of response details providing status codes, descriptions,
+    # and additional information about the result of the operation.
+    # @return [Array[ResponseDetail]]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['has_sent_to_true_accord'] = 'hasSentToTrueAccord'
+      @_hash['cease_and_desist'] = 'ceaseAndDesist'
+      @_hash['recalled_with_no_payment'] = 'recalledWithNoPayment'
+      @_hash['collection_account_status_histories'] =
+        'collectionAccountStatusHistories'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_identifier
+        has_sent_to_true_accord
+        cease_and_desist
+        recalled_with_no_payment
+        collection_account_status_histories
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        collection_account_status_histories
+        response_details
+      ]
+    end
+
+    def initialize(account_identifier: SKIP, has_sent_to_true_accord: SKIP,
+                   cease_and_desist: SKIP, recalled_with_no_payment: SKIP,
+                   collection_account_status_histories: SKIP,
+                   response_details: SKIP)
+      @account_identifier = account_identifier unless account_identifier == SKIP
+      @has_sent_to_true_accord = has_sent_to_true_accord unless has_sent_to_true_accord == SKIP
+      @cease_and_desist = cease_and_desist unless cease_and_desist == SKIP
+      @recalled_with_no_payment = recalled_with_no_payment unless recalled_with_no_payment == SKIP
+      unless collection_account_status_histories == SKIP
+        @collection_account_status_histories =
+          collection_account_status_histories
+      end
+      @response_details = response_details unless response_details == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_identifier =
+        hash.key?('accountIdentifier') ? hash['accountIdentifier'] : SKIP
+      has_sent_to_true_accord =
+        hash.key?('hasSentToTrueAccord') ? hash['hasSentToTrueAccord'] : SKIP
+      cease_and_desist =
+        hash.key?('ceaseAndDesist') ? hash['ceaseAndDesist'] : SKIP
+      recalled_with_no_payment =
+        hash.key?('recalledWithNoPayment') ? hash['recalledWithNoPayment'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      collection_account_status_histories = nil
+      unless hash['collectionAccountStatusHistories'].nil?
+        collection_account_status_histories = []
+        hash['collectionAccountStatusHistories'].each do |structure|
+          collection_account_status_histories << (CollectionAccountStatusHistory.from_hash(structure) if structure)
+        end
+      end
+
+      collection_account_status_histories = SKIP unless hash.key?('collectionAccountStatusHistories')
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      GetCollectionAccountStatusHistoryResponse.new(account_identifier: account_identifier,
+                                                    has_sent_to_true_accord: has_sent_to_true_accord,
+                                                    cease_and_desist: cease_and_desist,
+                                                    recalled_with_no_payment: recalled_with_no_payment,
+                                                    collection_account_status_histories: collection_account_status_histories,
+                                                    response_details: response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_identifier: #{@account_identifier}, has_sent_to_true_accord:"\
+      " #{@has_sent_to_true_accord}, cease_and_desist: #{@cease_and_desist},"\
+      " recalled_with_no_payment: #{@recalled_with_no_payment},"\
+      " collection_account_status_histories: #{@collection_account_status_histories},"\
+      " 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_identifier: #{@account_identifier.inspect},"\
+      " has_sent_to_true_accord: #{@has_sent_to_true_accord.inspect}, cease_and_desist:"\
+      " #{@cease_and_desist.inspect}, recalled_with_no_payment:"\
+      " #{@recalled_with_no_payment.inspect}, collection_account_status_histories:"\
+      " #{@collection_account_status_histories.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/get_configuration_request.rb

@@ -0,0 +1,102 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to retrieve configuration data for a specific activity.
+  # Contains activity details, contextual data, and URLs for success and error
+  # handling. Inherits standard request metadata from
+  # Gd.Bos.DataTransfer.Request.RequestBase.
+  class GetConfigurationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name or type of the activity for which configuration is being
+    # requested (e.g., "enrollment", "payment").
+    # @return [String]
+    attr_accessor :activity
+
+    # A dictionary of key-value pairs providing additional data or context for
+    # the activity.
+    # @return [Hash[String, String]]
+    attr_accessor :activity_data
+
+    # The URL to redirect to or call upon successful completion of the activity.
+    # @return [String]
+    attr_accessor :success_url
+
+    # The URL to redirect to or call if an error occurs during the activity.
+    # @return [String]
+    attr_accessor :error_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['activity'] = 'activity'
+      @_hash['activity_data'] = 'activityData'
+      @_hash['success_url'] = 'successUrl'
+      @_hash['error_url'] = 'errorUrl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        activity
+        activity_data
+        success_url
+        error_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        activity
+        activity_data
+        success_url
+        error_url
+      ]
+    end
+
+    def initialize(activity: SKIP, activity_data: SKIP, success_url: SKIP,
+                   error_url: SKIP)
+      @activity = activity unless activity == SKIP
+      @activity_data = activity_data unless activity_data == SKIP
+      @success_url = success_url unless success_url == SKIP
+      @error_url = error_url unless error_url == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      activity = hash.key?('activity') ? hash['activity'] : SKIP
+      activity_data = hash.key?('activityData') ? hash['activityData'] : SKIP
+      success_url = hash.key?('successUrl') ? hash['successUrl'] : SKIP
+      error_url = hash.key?('errorUrl') ? hash['errorUrl'] : SKIP
+
+      # Create object from extracted values.
+      GetConfigurationRequest.new(activity: activity,
+                                  activity_data: activity_data,
+                                  success_url: success_url,
+                                  error_url: error_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} activity: #{@activity}, activity_data: #{@activity_data}, success_url:"\
+      " #{@success_url}, error_url: #{@error_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} activity: #{@activity.inspect}, activity_data: #{@activity_data.inspect},"\
+      " success_url: #{@success_url.inspect}, error_url: #{@error_url.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/get_configuration_response.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 configuration data.
+  # Contains a URL for configuration or redirection purposes. Inherits standard
+  # response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetConfigurationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The configuration or redirection URL returned by the operation.
+    # @return [String]
+    attr_accessor :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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        url
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        url
+        response_details
+      ]
+    end
+
+    def initialize(url: SKIP, response_details: SKIP)
+      @url = url unless url == SKIP
+      @response_details = response_details unless response_details == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      url = hash.key?('url') ? hash['url'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      GetConfigurationResponse.new(url: url,
+                                   response_details: response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} url: #{@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} url: #{@url.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end