apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/samples_enrollment_response.rb

@@ -0,0 +1,274 @@
+# 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 operation.
+  # Contains account identifiers, status, direct deposit information, purses,
+  # account holders, and KYC state data.
+  class SamplesEnrollmentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier (UID or GUID) for the enrolled account.
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # The reference number associated with the account, used for partner or
+    # customer reference.
+    # @return [String]
+    attr_accessor :account_reference_number
+
+    # The current status of the account (e.g., "Active", "Pending", "Closed").
+    # @return [String]
+    attr_accessor :status
+
+    # The date and time when the account status was last changed.
+    # @return [String]
+    attr_accessor :account_status_changed_date_time
+
+    # A list of reasons describing the current status of the 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 account.
+    # @return [Array[Purse]]
+    attr_accessor :purses
+
+    # The list of account holders associated with the account.
+    # @return [Array[AccountHolder]]
+    attr_accessor :account_holders
+
+    # The account cycle day, typically used for billing or statement cycles.
+    # @return [Integer]
+    attr_accessor :account_cycle_day
+
+    # The identifier for the primary payment instrument associated with the
+    # account.
+    # @return [String]
+    attr_accessor :payment_instrument_identifier
+
+    # The activation status of the account.
+    # @return [String]
+    attr_accessor :activation_status
+
+    # Represents the Know Your Customer (KYC) state data for a user.
+    # Contains information about OFAC (Office of Foreign Assets Control)
+    # screening status, overall KYC status, and any pending KYC gates.
+    # Used to track regulatory compliance and the current state of user
+    # verification during onboarding or account management.
+    # @return [KycStateData]
+    attr_accessor :kyc_state_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['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['account_cycle_day'] = 'accountCycleDay'
+      @_hash['payment_instrument_identifier'] = 'paymentInstrumentIdentifier'
+      @_hash['activation_status'] = 'activationStatus'
+      @_hash['kyc_state_data'] = 'kycStateData'
+      @_hash['response_details'] = 'responseDetails'
+      @_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
+        account_cycle_day
+        payment_instrument_identifier
+        activation_status
+        kyc_state_data
+        response_details
+      ]
+    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
+        account_cycle_day
+        payment_instrument_identifier
+        activation_status
+        response_details
+      ]
+    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, account_cycle_day: SKIP,
+                   payment_instrument_identifier: SKIP, activation_status: SKIP,
+                   kyc_state_data: SKIP, response_details: 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
+      @account_cycle_day = account_cycle_day unless account_cycle_day == SKIP
+      unless payment_instrument_identifier == SKIP
+        @payment_instrument_identifier =
+          payment_instrument_identifier
+      end
+      @activation_status = activation_status unless activation_status == SKIP
+      @kyc_state_data = kyc_state_data unless kyc_state_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.
+      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')
+      account_cycle_day =
+        hash.key?('accountCycleDay') ? hash['accountCycleDay'] : SKIP
+      payment_instrument_identifier =
+        hash.key?('paymentInstrumentIdentifier') ? hash['paymentInstrumentIdentifier'] : SKIP
+      activation_status =
+        hash.key?('activationStatus') ? hash['activationStatus'] : SKIP
+      kyc_state_data = KycStateData.from_hash(hash['kycStateData']) if hash['kycStateData']
+      # 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.
+      SamplesEnrollmentResponse.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,
+                                    account_cycle_day: account_cycle_day,
+                                    payment_instrument_identifier: payment_instrument_identifier,
+                                    activation_status: activation_status,
+                                    kyc_state_data: kyc_state_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} 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}, account_cycle_day:"\
+      " #{@account_cycle_day}, payment_instrument_identifier: #{@payment_instrument_identifier},"\
+      " activation_status: #{@activation_status}, kyc_state_data: #{@kyc_state_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} 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}, account_cycle_day: #{@account_cycle_day.inspect},"\
+      " payment_instrument_identifier: #{@payment_instrument_identifier.inspect},"\
+      " activation_status: #{@activation_status.inspect}, kyc_state_data:"\
+      " #{@kyc_state_data.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/save_business_application_response.rb

@@ -0,0 +1,93 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after saving a business application.
+  # Contains the unique identifier for the saved business application. Inherits
+  # standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class SaveBusinessApplicationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier assigned to the saved business application.
+    # @return [String]
+    attr_accessor :businessapplicationidentifier
+
+    # 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['businessapplicationidentifier'] =
+        'businessapplicationidentifier'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        businessapplicationidentifier
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        businessapplicationidentifier
+        response_details
+      ]
+    end
+
+    def initialize(businessapplicationidentifier: SKIP, response_details: SKIP)
+      unless businessapplicationidentifier == SKIP
+        @businessapplicationidentifier =
+          businessapplicationidentifier
+      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.
+      businessapplicationidentifier =
+        hash.key?('businessapplicationidentifier') ? hash['businessapplicationidentifier'] : 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.
+      SaveBusinessApplicationResponse.new(businessapplicationidentifier: businessapplicationidentifier,
+                                          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} businessapplicationidentifier: #{@businessapplicationidentifier},"\
+      " 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} businessapplicationidentifier: #{@businessapplicationidentifier.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/scc_balance.rb

@@ -0,0 +1,102 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the SCC (Secondary Credit Card) balance details for an account.
+  # Contains available credit, total credit, posted balance, and funding status.
+  # Used to provide credit and funding information for SCC-enabled accounts
+  # within a partner program.
+  class SccBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The available credit amount for the SCC account.
+    # Represents the portion of credit that can be used for transactions.
+    # @return [Float]
+    attr_accessor :available_credit
+
+    # The total credit limit for the SCC account.
+    # Represents the maximum credit available to the account.
+    # @return [Float]
+    attr_accessor :total_credit
+
+    # The posted balance for the SCC account.
+    # Represents the current balance after all posted transactions.
+    # @return [Float]
+    attr_accessor :posted_balance
+
+    # The funding status of the SCC account.
+    # Indicates whether the account is funded or not, as defined by
+    # Gd.Bos.DataTransfer.Enums.SccFundingStatus.
+    # @return [FundingStatus]
+    attr_accessor :funding_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['available_credit'] = 'availableCredit'
+      @_hash['total_credit'] = 'totalCredit'
+      @_hash['posted_balance'] = 'postedBalance'
+      @_hash['funding_status'] = 'fundingStatus'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        available_credit
+        total_credit
+        posted_balance
+        funding_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(available_credit: SKIP, total_credit: SKIP,
+                   posted_balance: SKIP, funding_status: SKIP)
+      @available_credit = available_credit unless available_credit == SKIP
+      @total_credit = total_credit unless total_credit == SKIP
+      @posted_balance = posted_balance unless posted_balance == SKIP
+      @funding_status = funding_status unless funding_status == 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.
+      available_credit =
+        hash.key?('availableCredit') ? hash['availableCredit'] : SKIP
+      total_credit = hash.key?('totalCredit') ? hash['totalCredit'] : SKIP
+      posted_balance = hash.key?('postedBalance') ? hash['postedBalance'] : SKIP
+      funding_status = hash.key?('fundingStatus') ? hash['fundingStatus'] : SKIP
+
+      # Create object from extracted values.
+      SccBalance.new(available_credit: available_credit,
+                     total_credit: total_credit,
+                     posted_balance: posted_balance,
+                     funding_status: funding_status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} available_credit: #{@available_credit}, total_credit: #{@total_credit},"\
+      " posted_balance: #{@posted_balance}, funding_status: #{@funding_status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} available_credit: #{@available_credit.inspect}, total_credit:"\
+      " #{@total_credit.inspect}, posted_balance: #{@posted_balance.inspect}, funding_status:"\
+      " #{@funding_status.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/scc_creation_data.rb

@@ -0,0 +1,112 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # 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.
+  class SccCreationData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The applicant's total income amount.
+    # @return [Float]
+    attr_accessor :income
+
+    # The frequency of the applicant's income (e.g., "Monthly", "Weekly").
+    # @return [String]
+    attr_accessor :income_frequency
+
+    # The applicant's total expense amount.
+    # @return [Float]
+    attr_accessor :expense
+
+    # The frequency of the applicant's expenses (e.g., "Monthly", "Weekly").
+    # @return [String]
+    attr_accessor :expense_frequency
+
+    # The unique identifier (GUID) of the associated DDA (Demand Deposit
+    # Account) for the SCC.
+    # @return [UUID | String]
+    attr_accessor :dda_account_identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['income'] = 'income'
+      @_hash['income_frequency'] = 'incomeFrequency'
+      @_hash['expense'] = 'expense'
+      @_hash['expense_frequency'] = 'expenseFrequency'
+      @_hash['dda_account_identifier'] = 'ddaAccountIdentifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        income
+        income_frequency
+        expense
+        expense_frequency
+        dda_account_identifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        income_frequency
+        expense_frequency
+      ]
+    end
+
+    def initialize(income: SKIP, income_frequency: SKIP, expense: SKIP,
+                   expense_frequency: SKIP, dda_account_identifier: SKIP)
+      @income = income unless income == SKIP
+      @income_frequency = income_frequency unless income_frequency == SKIP
+      @expense = expense unless expense == SKIP
+      @expense_frequency = expense_frequency unless expense_frequency == SKIP
+      @dda_account_identifier = dda_account_identifier unless dda_account_identifier == 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.
+      income = hash.key?('income') ? hash['income'] : SKIP
+      income_frequency =
+        hash.key?('incomeFrequency') ? hash['incomeFrequency'] : SKIP
+      expense = hash.key?('expense') ? hash['expense'] : SKIP
+      expense_frequency =
+        hash.key?('expenseFrequency') ? hash['expenseFrequency'] : SKIP
+      dda_account_identifier =
+        hash.key?('ddaAccountIdentifier') ? hash['ddaAccountIdentifier'] : SKIP
+
+      # Create object from extracted values.
+      SccCreationData.new(income: income,
+                          income_frequency: income_frequency,
+                          expense: expense,
+                          expense_frequency: expense_frequency,
+                          dda_account_identifier: dda_account_identifier)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} income: #{@income}, income_frequency: #{@income_frequency}, expense:"\
+      " #{@expense}, expense_frequency: #{@expense_frequency}, dda_account_identifier:"\
+      " #{@dda_account_identifier}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} income: #{@income.inspect}, income_frequency: #{@income_frequency.inspect},"\
+      " expense: #{@expense.inspect}, expense_frequency: #{@expense_frequency.inspect},"\
+      " dda_account_identifier: #{@dda_account_identifier.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/scc_eligibilities_response.rb

@@ -0,0 +1,77 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response for SCC (Special Category Customer) eligibility
+  # checks. Inherits standard response metadata and details from
+  # Gd.Bos.DataTransfer.Response.ResponseBase. Used to convey the outcome of SCC
+  # eligibility operations, including status codes and detailed messages.
+  class SccEligibilitiesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(response_details: 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
+      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.
+      SccEligibilitiesResponse.new(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} 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} response_details: #{@response_details.inspect}>"
+    end
+  end
+end