apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/assess_ach_request.rb

@@ -0,0 +1,167 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to assess the eligibility, risk, and prerequisites for
+  # an ACH (Automated Clearing House) transfer. Inherits all properties from
+  # Gd.Bos.DataTransfer.Request.CreateACHRequest and is used to validate and
+  # pre-check an ACH transfer before execution, including transfer type,
+  # endpoints, amount, device, user, and fraud data. This assessment helps
+  # ensure compliance, risk mitigation, and business rule validation prior to
+  # initiating the actual ACH transaction.
+  class AssessAchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required: A unique identifier for the transfer. This value is generated by
+    # the client and used for idempotency and tracking.
+    # @return [String]
+    attr_accessor :transfer_identifier
+
+    # Required: The type of ACH transfer to perform. 
+    # Valid values: "achOut" (move funds to an external bank account), "achPull"
+    # (pull funds from an external bank account).
+    # @return [String]
+    attr_accessor :transfer_type
+
+    # Required: The ISO 4217 currency code for the transfer (e.g., "USD") in
+    # string.
+    # @return [String]
+    attr_accessor :currency
+
+    # Required: The device type from which the transfer is initiated.
+    # Valid values: Unknown, Web, IOS, Android.
+    # @return [DeviceType]
+    attr_accessor :device_type
+
+    # Optional: The identifier for the bank account verification process. 
+    # Required for ACH Pull transfers when bank account verification is needed.
+    # @return [String]
+    attr_accessor :verification_identifier
+
+    # Optional: The unique identifier of the user initiating the transfer. 
+    # Required for both ACH Out and ACH Pull transfers.
+    # @return [String]
+    attr_accessor :user_identifier
+
+    # Represents the routing details and required data for initiating a transfer
+    # operation.
+    # Contains transaction amount, delivery type, source and target endpoints,
+    # recurring and verification details, and ACH-specific flags.
+    # Used to define and process the flow of funds between accounts or external
+    # endpoints, supporting ACH, purse-to-purse, and partner-to-account
+    # transfers.
+    # @return [TransferRoute]
+    attr_accessor :transfer_route
+
+    # An optional description for the transfer, such as the purpose or reference
+    # for the transaction.
+    # @return [String]
+    attr_accessor :transfer_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transfer_identifier'] = 'transferIdentifier'
+      @_hash['transfer_type'] = 'transferType'
+      @_hash['currency'] = 'currency'
+      @_hash['device_type'] = 'deviceType'
+      @_hash['verification_identifier'] = 'verificationIdentifier'
+      @_hash['user_identifier'] = 'userIdentifier'
+      @_hash['transfer_route'] = 'transferRoute'
+      @_hash['transfer_description'] = 'transferDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_identifier
+        transfer_type
+        currency
+        device_type
+        verification_identifier
+        user_identifier
+        transfer_route
+        transfer_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_identifier
+        transfer_type
+        currency
+        verification_identifier
+        user_identifier
+        transfer_description
+      ]
+    end
+
+    def initialize(transfer_identifier: SKIP, transfer_type: SKIP,
+                   currency: SKIP, device_type: SKIP,
+                   verification_identifier: SKIP, user_identifier: SKIP,
+                   transfer_route: SKIP, transfer_description: SKIP)
+      @transfer_identifier = transfer_identifier unless transfer_identifier == SKIP
+      @transfer_type = transfer_type unless transfer_type == SKIP
+      @currency = currency unless currency == SKIP
+      @device_type = device_type unless device_type == SKIP
+      @verification_identifier = verification_identifier unless verification_identifier == SKIP
+      @user_identifier = user_identifier unless user_identifier == SKIP
+      @transfer_route = transfer_route unless transfer_route == SKIP
+      @transfer_description = transfer_description unless transfer_description == 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.
+      transfer_identifier =
+        hash.key?('transferIdentifier') ? hash['transferIdentifier'] : SKIP
+      transfer_type = hash.key?('transferType') ? hash['transferType'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      device_type = hash.key?('deviceType') ? hash['deviceType'] : SKIP
+      verification_identifier =
+        hash.key?('verificationIdentifier') ? hash['verificationIdentifier'] : SKIP
+      user_identifier =
+        hash.key?('userIdentifier') ? hash['userIdentifier'] : SKIP
+      transfer_route = TransferRoute.from_hash(hash['transferRoute']) if hash['transferRoute']
+      transfer_description =
+        hash.key?('transferDescription') ? hash['transferDescription'] : SKIP
+
+      # Create object from extracted values.
+      AssessAchRequest.new(transfer_identifier: transfer_identifier,
+                           transfer_type: transfer_type,
+                           currency: currency,
+                           device_type: device_type,
+                           verification_identifier: verification_identifier,
+                           user_identifier: user_identifier,
+                           transfer_route: transfer_route,
+                           transfer_description: transfer_description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_identifier: #{@transfer_identifier}, transfer_type:"\
+      " #{@transfer_type}, currency: #{@currency}, device_type: #{@device_type},"\
+      " verification_identifier: #{@verification_identifier}, user_identifier:"\
+      " #{@user_identifier}, transfer_route: #{@transfer_route}, transfer_description:"\
+      " #{@transfer_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_identifier: #{@transfer_identifier.inspect}, transfer_type:"\
+      " #{@transfer_type.inspect}, currency: #{@currency.inspect}, device_type:"\
+      " #{@device_type.inspect}, verification_identifier: #{@verification_identifier.inspect},"\
+      " user_identifier: #{@user_identifier.inspect}, transfer_route: #{@transfer_route.inspect},"\
+      " transfer_description: #{@transfer_description.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/assess_mrdc_transfer_request.rb

@@ -0,0 +1,97 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to assess the eligibility and prerequisites for a
+  # Mobile Remote Deposit Capture (MRDC) transfer. This request is used to
+  # verify if the account and user meet all requirements for submitting a check
+  # deposit via MRDC, including check image data, deposit amount, account
+  # details, and any fraud or risk assessment data. Inherits all properties from
+  # Gd.Bos.DataTransfer.Request.CreateMrdcTransferRequest.
+  class AssessMrdcTransferRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the MRDC transfer. This value is generated by
+    # the client and used for idempotency and tracking.
+    # @return [String]
+    attr_accessor :transfer_identifier
+
+    # The ISO 4217 currency code for the deposit (e.g., "USD").
+    # @return [String]
+    attr_accessor :currency
+
+    # Represents the routing details for a Mobile Remote Deposit Capture (MRDC)
+    # transfer.
+    # Contains information about the check deposit amount, the source (including
+    # check image and device/location data),
+    # and the target account where the funds will be deposited.
+    # @return [MrdcTransferRoute]
+    attr_accessor :transfer_route
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transfer_identifier'] = 'transferIdentifier'
+      @_hash['currency'] = 'currency'
+      @_hash['transfer_route'] = 'transferRoute'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_identifier
+        currency
+        transfer_route
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_identifier
+        currency
+      ]
+    end
+
+    def initialize(transfer_identifier: SKIP, currency: SKIP,
+                   transfer_route: SKIP)
+      @transfer_identifier = transfer_identifier unless transfer_identifier == SKIP
+      @currency = currency unless currency == SKIP
+      @transfer_route = transfer_route unless transfer_route == 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.
+      transfer_identifier =
+        hash.key?('transferIdentifier') ? hash['transferIdentifier'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      transfer_route = MrdcTransferRoute.from_hash(hash['transferRoute']) if hash['transferRoute']
+
+      # Create object from extracted values.
+      AssessMrdcTransferRequest.new(transfer_identifier: transfer_identifier,
+                                    currency: currency,
+                                    transfer_route: transfer_route)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_identifier: #{@transfer_identifier}, currency: #{@currency},"\
+      " transfer_route: #{@transfer_route}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_identifier: #{@transfer_identifier.inspect}, currency:"\
+      " #{@currency.inspect}, transfer_route: #{@transfer_route.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/assess_transfer_fee.rb

@@ -0,0 +1,90 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a transfer fee assessment, including the fee type, frequency, and
+  # amount. Used to communicate or calculate the fees associated with a transfer
+  # operation, such as transaction, service, or recurring fees. Supports
+  # business logic for fee calculation, display, and compliance in
+  # transfer-related workflows.
+  class AssessTransferFee < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of fee being assessed (e.g., "Transaction", "Service",
+    # "Recurring").
+    # @return [String]
+    attr_accessor :type
+
+    # The frequency at which the fee is applied (e.g., "OneTime", "Monthly",
+    # "PerTransfer").
+    # @return [String]
+    attr_accessor :frequency
+
+    # The amount of the fee to be assessed, in the relevant currency.
+    # @return [Float]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['frequency'] = 'frequency'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        frequency
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+        frequency
+      ]
+    end
+
+    def initialize(type: SKIP, frequency: SKIP, amount: SKIP)
+      @type = type unless type == SKIP
+      @frequency = frequency unless frequency == SKIP
+      @amount = amount unless amount == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+
+      # Create object from extracted values.
+      AssessTransferFee.new(type: type,
+                            frequency: frequency,
+                            amount: amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, frequency: #{@frequency}, amount: #{@amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, frequency: #{@frequency.inspect}, amount:"\
+      " #{@amount.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/assess_transfer_request.rb

@@ -0,0 +1,130 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to assess the eligibility, risk, and prerequisites for
+  # a funds transfer operation. This request is used to validate and pre-check a
+  # transfer before execution, including authorization type, transfer type,
+  # routing, and initiator details. It supports a variety of transfer types
+  # (ACH, internal, disbursement, MRDC, etc.) and is typically used for
+  # fraud/risk assessment, compliance, and business rule validation.
+  class AssessTransferRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of authorization being requested for the transfer (e.g., Execute,
+    # Hold, Accept, Cancel, Reject, System, Reverse).
+    # Determines the intended action for the transfer assessment.
+    # @return [TransferAuthorizationType]
+    attr_accessor :transfer_authorization_type
+
+    # The unique identifier for the transfer. Used for idempotency, tracking,
+    # and reference in assessment and subsequent operations.
+    # @return [String]
+    attr_accessor :transfer_identifier
+
+    # The type of transfer being assessed (e.g., ACH Out, Internal Transfer,
+    # Disbursement, MRDC Transfer).
+    # Determines the business rules and validations applied during assessment.
+    # @return [TransferType]
+    attr_accessor :transfer_type
+
+    # The identifier of the account or entity initiating the transfer.
+    # Typically references the source account or user responsible for the
+    # transfer.
+    # @return [String]
+    attr_accessor :initiator
+
+    # Represents the routing and endpoint details for a funds transfer
+    # operation.
+    # Contains information about the transaction amount, description, fee
+    # handling, and the source and target endpoints.
+    # Used for transfers between accounts, cards, or external endpoints,
+    # supporting a variety of transfer types such as A2A, B2C, and
+    # partner-initiated transfers.
+    # @return [TransferRoute2]
+    attr_accessor :transfer_route
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transfer_authorization_type'] = 'transferAuthorizationType'
+      @_hash['transfer_identifier'] = 'transferIdentifier'
+      @_hash['transfer_type'] = 'transferType'
+      @_hash['initiator'] = 'initiator'
+      @_hash['transfer_route'] = 'transferRoute'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_authorization_type
+        transfer_identifier
+        transfer_type
+        initiator
+        transfer_route
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_identifier
+        initiator
+      ]
+    end
+
+    def initialize(transfer_authorization_type: SKIP, transfer_identifier: SKIP,
+                   transfer_type: SKIP, initiator: SKIP, transfer_route: SKIP)
+      unless transfer_authorization_type == SKIP
+        @transfer_authorization_type =
+          transfer_authorization_type
+      end
+      @transfer_identifier = transfer_identifier unless transfer_identifier == SKIP
+      @transfer_type = transfer_type unless transfer_type == SKIP
+      @initiator = initiator unless initiator == SKIP
+      @transfer_route = transfer_route unless transfer_route == 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.
+      transfer_authorization_type =
+        hash.key?('transferAuthorizationType') ? hash['transferAuthorizationType'] : SKIP
+      transfer_identifier =
+        hash.key?('transferIdentifier') ? hash['transferIdentifier'] : SKIP
+      transfer_type = hash.key?('transferType') ? hash['transferType'] : SKIP
+      initiator = hash.key?('initiator') ? hash['initiator'] : SKIP
+      transfer_route = TransferRoute2.from_hash(hash['transferRoute']) if hash['transferRoute']
+
+      # Create object from extracted values.
+      AssessTransferRequest.new(transfer_authorization_type: transfer_authorization_type,
+                                transfer_identifier: transfer_identifier,
+                                transfer_type: transfer_type,
+                                initiator: initiator,
+                                transfer_route: transfer_route)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_authorization_type: #{@transfer_authorization_type},"\
+      " transfer_identifier: #{@transfer_identifier}, transfer_type: #{@transfer_type}, initiator:"\
+      " #{@initiator}, transfer_route: #{@transfer_route}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_authorization_type: #{@transfer_authorization_type.inspect},"\
+      " transfer_identifier: #{@transfer_identifier.inspect}, transfer_type:"\
+      " #{@transfer_type.inspect}, initiator: #{@initiator.inspect}, transfer_route:"\
+      " #{@transfer_route.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/assess_transfer_response.rb

@@ -0,0 +1,183 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after assessing a funds transfer request.
+  # Provides information about account holders, available balance, applicable
+  # limits, fees, prerequisites, and the net amount for the transfer. Used to
+  # determine eligibility, compliance, and cost before executing a transfer.
+  class AssessTransferResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of account holders involved in the transfer assessment.
+    # Each entry includes identifiers and KYC (Know Your Customer) gate status
+    # for eligibility checks.
+    # @return [Array[AccountHolderAssess]]
+    attr_accessor :account_holders
+
+    # The available balance in the source account at the time of assessment.
+    # Used to determine if sufficient funds are present to complete the
+    # transfer.
+    # @return [Float]
+    attr_accessor :available_balance
+
+    # A list of limits applicable to the transfer, such as daily, monthly, or
+    # per-transaction limits.
+    # Each limit includes type, frequency, minimum/maximum amounts, and
+    # remaining allowance.
+    # @return [Array[Limit]]
+    attr_accessor :limits
+
+    # A list of fees that will be applied to the transfer, including type,
+    # frequency, and amount.
+    # @return [Array[AssessTransferFee]]
+    attr_accessor :fees
+
+    # A list of prerequisite conditions that must be met before the transfer can
+    # proceed.
+    # If any prerequisites are returned, the customer must fulfill them to be
+    # eligible for the transfer.
+    # @return [Array[String]]
+    attr_accessor :prerequisites
+
+    # The net amount that will be transferred after deducting all applicable
+    # fees.
+    # @return [Float]
+    attr_accessor :net_amount
+
+    # 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_holders'] = 'accountHolders'
+      @_hash['available_balance'] = 'availableBalance'
+      @_hash['limits'] = 'limits'
+      @_hash['fees'] = 'fees'
+      @_hash['prerequisites'] = 'prerequisites'
+      @_hash['net_amount'] = 'netAmount'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_holders
+        available_balance
+        limits
+        fees
+        prerequisites
+        net_amount
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_holders
+        available_balance
+        limits
+        fees
+        prerequisites
+        response_details
+      ]
+    end
+
+    def initialize(account_holders: SKIP, available_balance: SKIP, limits: SKIP,
+                   fees: SKIP, prerequisites: SKIP, net_amount: SKIP,
+                   response_details: SKIP)
+      @account_holders = account_holders unless account_holders == SKIP
+      @available_balance = available_balance unless available_balance == SKIP
+      @limits = limits unless limits == SKIP
+      @fees = fees unless fees == SKIP
+      @prerequisites = prerequisites unless prerequisites == SKIP
+      @net_amount = net_amount unless net_amount == 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
+      account_holders = nil
+      unless hash['accountHolders'].nil?
+        account_holders = []
+        hash['accountHolders'].each do |structure|
+          account_holders << (AccountHolderAssess.from_hash(structure) if structure)
+        end
+      end
+
+      account_holders = SKIP unless hash.key?('accountHolders')
+      available_balance =
+        hash.key?('availableBalance') ? hash['availableBalance'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      limits = nil
+      unless hash['limits'].nil?
+        limits = []
+        hash['limits'].each do |structure|
+          limits << (Limit.from_hash(structure) if structure)
+        end
+      end
+
+      limits = SKIP unless hash.key?('limits')
+      # Parameter is an array, so we need to iterate through it
+      fees = nil
+      unless hash['fees'].nil?
+        fees = []
+        hash['fees'].each do |structure|
+          fees << (AssessTransferFee.from_hash(structure) if structure)
+        end
+      end
+
+      fees = SKIP unless hash.key?('fees')
+      prerequisites = hash.key?('prerequisites') ? hash['prerequisites'] : SKIP
+      net_amount = hash.key?('netAmount') ? hash['netAmount'] : 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.
+      AssessTransferResponse.new(account_holders: account_holders,
+                                 available_balance: available_balance,
+                                 limits: limits,
+                                 fees: fees,
+                                 prerequisites: prerequisites,
+                                 net_amount: net_amount,
+                                 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_holders: #{@account_holders}, available_balance:"\
+      " #{@available_balance}, limits: #{@limits}, fees: #{@fees}, prerequisites:"\
+      " #{@prerequisites}, net_amount: #{@net_amount}, 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_holders: #{@account_holders.inspect}, available_balance:"\
+      " #{@available_balance.inspect}, limits: #{@limits.inspect}, fees: #{@fees.inspect},"\
+      " prerequisites: #{@prerequisites.inspect}, net_amount: #{@net_amount.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end