apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/scc_enroll_request.rb

@@ -0,0 +1,80 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to enroll a Secure Credit Card (SCC) account. Contains
+  # account details, SCC creation data, and response encryption preference.
+  # Inherits standard request metadata from
+  # Gd.Bos.DataTransfer.Request.RequestBase.
+  class SccEnrollRequest < BaseModel
+    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
+
+    # Represents the data required to create a Secure Credit Card (SCC) account,
+    # including income, expense, and associated DDA account information.
+    # Used during SCC enrollment to determine eligibility and credit line.
+    # @return [SccCreationData]
+    attr_accessor :scc
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'account'
+      @_hash['scc'] = 'scc'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+        scc
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account: SKIP, scc: SKIP)
+      @account = account unless account == SKIP
+      @scc = scc unless scc == 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 = Account.from_hash(hash['account']) if hash['account']
+      scc = SccCreationData.from_hash(hash['scc']) if hash['scc']
+
+      # Create object from extracted values.
+      SccEnrollRequest.new(account: account,
+                           scc: scc)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account: #{@account}, scc: #{@scc}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account: #{@account.inspect}, scc: #{@scc.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/scc_enroll_response.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 a successful Secure Credit Card (SCC)
+  # enrollment operation. Contains the enrolled account details, including
+  # identifiers, status, direct deposit information, purses, account holders,
+  # and credit line range. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class SccEnrollResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the details of a Secure Credit Card (SCC) enrollment, including
+    # account identifiers, status, direct deposit information, purses, account
+    # holders, and credit line range.
+    # Used as part of the SCC enrollment response to provide a comprehensive
+    # view of the enrolled account.
+    # @return [SccEnrollment]
+    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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'account'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(account: SKIP, response_details: SKIP)
+      @account = account unless account == 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.
+      account = SccEnrollment.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')
+
+      # Create object from extracted values.
+      SccEnrollResponse.new(account: account,
+                            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: #{@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/models/scc_enrollment.rb

@@ -0,0 +1,213 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the details of a Secure Credit Card (SCC) enrollment, including
+  # account identifiers, status, direct deposit information, purses, account
+  # holders, and credit line range. Used as part of the SCC enrollment response
+  # to provide a comprehensive view of the enrolled account.
+  class SccEnrollment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier (UID or GUID) for the enrolled SCC account.
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # The reference number associated with the SCC account, used for partner or
+    # customer reference.
+    # @return [String]
+    attr_accessor :account_reference_number
+
+    # The current status of the SCC account (e.g., "Active", "Pending",
+    # "Closed").
+    # @return [String]
+    attr_accessor :status
+
+    # The date and time when the account status was last changed, in ISO 8601
+    # format.
+    # @return [String]
+    attr_accessor :account_status_changed_date_time
+
+    # A list of reasons describing the current status of the SCC account.
+    # @return [Array[String]]
+    attr_accessor :status_reasons
+
+    # The cure or remediation action associated with the current account status,
+    # if applicable.
+    # @return [String]
+    attr_accessor :status_cure
+
+    # Represents the direct deposit information for an account.
+    # Contains the account number and routing number required to receive ACH
+    # direct deposits.
+    # Used to provide customers and partners with the necessary banking details
+    # for setting up direct deposit transactions.
+    # @return [DirectDepositInformation]
+    attr_accessor :direct_deposit_information
+
+    # The list of purses (sub-accounts or balance containers) associated with
+    # the SCC account.
+    # @return [Array[Purse]]
+    attr_accessor :purses
+
+    # The list of account holders associated with the SCC account.
+    # @return [Array[AccountHolder]]
+    attr_accessor :account_holders
+
+    # Represents the minimum and maximum credit line values for a Secure Credit
+    # Card (SCC) account.
+    # Used to indicate the eligible credit line range determined during
+    # enrollment or account management.
+    # @return [CreditLineRange]
+    attr_accessor :credit_line_range
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['account_reference_number'] = 'accountReferenceNumber'
+      @_hash['status'] = 'status'
+      @_hash['account_status_changed_date_time'] =
+        'accountStatusChangedDateTime'
+      @_hash['status_reasons'] = 'statusReasons'
+      @_hash['status_cure'] = 'statusCure'
+      @_hash['direct_deposit_information'] = 'directDepositInformation'
+      @_hash['purses'] = 'purses'
+      @_hash['account_holders'] = 'accountHolders'
+      @_hash['credit_line_range'] = 'creditLineRange'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_identifier
+        account_reference_number
+        status
+        account_status_changed_date_time
+        status_reasons
+        status_cure
+        direct_deposit_information
+        purses
+        account_holders
+        credit_line_range
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_identifier
+        account_reference_number
+        status
+        account_status_changed_date_time
+        status_reasons
+        status_cure
+        purses
+        account_holders
+      ]
+    end
+
+    def initialize(account_identifier: SKIP, account_reference_number: SKIP,
+                   status: SKIP, account_status_changed_date_time: SKIP,
+                   status_reasons: SKIP, status_cure: SKIP,
+                   direct_deposit_information: SKIP, purses: SKIP,
+                   account_holders: SKIP, credit_line_range: SKIP)
+      @account_identifier = account_identifier unless account_identifier == SKIP
+      @account_reference_number = account_reference_number unless account_reference_number == SKIP
+      @status = status unless status == SKIP
+      unless account_status_changed_date_time == SKIP
+        @account_status_changed_date_time =
+          account_status_changed_date_time
+      end
+      @status_reasons = status_reasons unless status_reasons == SKIP
+      @status_cure = status_cure unless status_cure == SKIP
+      unless direct_deposit_information == SKIP
+        @direct_deposit_information =
+          direct_deposit_information
+      end
+      @purses = purses unless purses == SKIP
+      @account_holders = account_holders unless account_holders == SKIP
+      @credit_line_range = credit_line_range unless credit_line_range == 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
+      account_reference_number =
+        hash.key?('accountReferenceNumber') ? hash['accountReferenceNumber'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      account_status_changed_date_time =
+        hash.key?('accountStatusChangedDateTime') ? hash['accountStatusChangedDateTime'] : SKIP
+      status_reasons = hash.key?('statusReasons') ? hash['statusReasons'] : SKIP
+      status_cure = hash.key?('statusCure') ? hash['statusCure'] : SKIP
+      if hash['directDepositInformation']
+        direct_deposit_information = DirectDepositInformation.from_hash(hash['directDepositInformation'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      purses = nil
+      unless hash['purses'].nil?
+        purses = []
+        hash['purses'].each do |structure|
+          purses << (Purse.from_hash(structure) if structure)
+        end
+      end
+
+      purses = SKIP unless hash.key?('purses')
+      # Parameter is an array, so we need to iterate through it
+      account_holders = nil
+      unless hash['accountHolders'].nil?
+        account_holders = []
+        hash['accountHolders'].each do |structure|
+          account_holders << (AccountHolder.from_hash(structure) if structure)
+        end
+      end
+
+      account_holders = SKIP unless hash.key?('accountHolders')
+      credit_line_range = CreditLineRange.from_hash(hash['creditLineRange']) if
+        hash['creditLineRange']
+
+      # Create object from extracted values.
+      SccEnrollment.new(account_identifier: account_identifier,
+                        account_reference_number: account_reference_number,
+                        status: status,
+                        account_status_changed_date_time: account_status_changed_date_time,
+                        status_reasons: status_reasons,
+                        status_cure: status_cure,
+                        direct_deposit_information: direct_deposit_information,
+                        purses: purses,
+                        account_holders: account_holders,
+                        credit_line_range: credit_line_range)
+    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}, account_reference_number:"\
+      " #{@account_reference_number}, status: #{@status}, account_status_changed_date_time:"\
+      " #{@account_status_changed_date_time}, status_reasons: #{@status_reasons}, status_cure:"\
+      " #{@status_cure}, direct_deposit_information: #{@direct_deposit_information}, purses:"\
+      " #{@purses}, account_holders: #{@account_holders}, credit_line_range:"\
+      " #{@credit_line_range}>"
+    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},"\
+      " account_reference_number: #{@account_reference_number.inspect}, status:"\
+      " #{@status.inspect}, account_status_changed_date_time:"\
+      " #{@account_status_changed_date_time.inspect}, status_reasons: #{@status_reasons.inspect},"\
+      " status_cure: #{@status_cure.inspect}, direct_deposit_information:"\
+      " #{@direct_deposit_information.inspect}, purses: #{@purses.inspect}, account_holders:"\
+      " #{@account_holders.inspect}, credit_line_range: #{@credit_line_range.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/search_account_response.rb

@@ -0,0 +1,94 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response containing search results for accounts.
+  class SearchAccountResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of accounts matching the search criteria.
+    # @return [Array[AccountSearchResult]]
+    attr_accessor :accounts
+
+    # 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['accounts'] = 'accounts'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accounts
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        accounts
+        response_details
+      ]
+    end
+
+    def initialize(accounts: SKIP, response_details: SKIP)
+      @accounts = accounts unless accounts == 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
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (AccountSearchResult.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+      # 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.
+      SearchAccountResponse.new(accounts: accounts,
+                                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} accounts: #{@accounts}, 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} accounts: #{@accounts.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/search_payee_request.rb

@@ -0,0 +1,80 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Search Payee Request – Represents the data required to search for a payee in
+  # the payee directory by name. Used to request a list of payees matching the
+  # provided name for a specific account.
+  class SearchPayeeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier of the account for which to search payees.
+    # Must be a valid GUID.
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # The name or partial name of the payee to search for.
+    # Must be between 3 and 32 characters.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_identifier
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_identifier
+        name
+      ]
+    end
+
+    def initialize(account_identifier: SKIP, name: SKIP)
+      @account_identifier = account_identifier unless account_identifier == SKIP
+      @name = name unless name == 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
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      SearchPayeeRequest.new(account_identifier: account_identifier,
+                             name: name)
+    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}, name: #{@name}>"
+    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}, name:"\
+      " #{@name.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/search_payee_response.rb

@@ -0,0 +1,98 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Search Payee Response – Contains the results of a payee directory search.
+  # Used to provide a list of payees matching the search criteria, including
+  # merchant and person payees with relevant details.
+  class SearchPayeeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of payees matching the search criteria.
+    # Each item contains payee details such as name, merchant ID, address, phone
+    # number, and merchant ZIP requirements.
+    # @return [Array[Payee]]
+    attr_accessor :payees
+
+    # 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['payees'] = 'payees'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payees
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payees
+        response_details
+      ]
+    end
+
+    def initialize(payees: SKIP, response_details: SKIP)
+      @payees = payees unless payees == 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
+      payees = nil
+      unless hash['payees'].nil?
+        payees = []
+        hash['payees'].each do |structure|
+          payees << (Payee.from_hash(structure) if structure)
+        end
+      end
+
+      payees = SKIP unless hash.key?('payees')
+      # 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.
+      SearchPayeeResponse.new(payees: payees,
+                              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} payees: #{@payees}, 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} payees: #{@payees.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end