apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/directory_search_request.rb

@@ -0,0 +1,65 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # DirectorySearchRequest Model.
+  class DirectorySearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The search criteria could be a name, token name, phone number or email.
+    # @return [String]
+    attr_accessor :searchcriteria
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['searchcriteria'] = 'searchcriteria'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        searchcriteria
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        searchcriteria
+      ]
+    end
+
+    def initialize(searchcriteria: SKIP)
+      @searchcriteria = searchcriteria unless searchcriteria == 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.
+      searchcriteria =
+        hash.key?('searchcriteria') ? hash['searchcriteria'] : SKIP
+
+      # Create object from extracted values.
+      DirectorySearchRequest.new(searchcriteria: searchcriteria)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} searchcriteria: #{@searchcriteria}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} searchcriteria: #{@searchcriteria.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/directory_search_response.rb

@@ -0,0 +1,98 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after performing a directory search.
+  # Contains an array of contacts with external resource and identifier details.
+  # Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class DirectorySearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The array of contacts returned by the directory search.
+    # Each contact includes external resource and identifier details.
+    # @return [Array[DirectorySearchResponseDto]]
+    attr_accessor :contacts
+
+    # 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['contacts'] = 'contacts'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contacts
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        contacts
+        response_details
+      ]
+    end
+
+    def initialize(contacts: SKIP, response_details: SKIP)
+      @contacts = contacts unless contacts == 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
+      contacts = nil
+      unless hash['contacts'].nil?
+        contacts = []
+        hash['contacts'].each do |structure|
+          contacts << (DirectorySearchResponseDto.from_hash(structure) if structure)
+        end
+      end
+
+      contacts = SKIP unless hash.key?('contacts')
+      # 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.
+      DirectorySearchResponse.new(contacts: contacts,
+                                  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} contacts: #{@contacts}, 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} contacts: #{@contacts.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/directory_search_response_dto.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 contact returned in a directory search response. Contains
+  # external resource and identifier details.
+  class DirectorySearchResponseDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An external resource identifier or context related to the contact.
+    # @return [String]
+    attr_accessor :externalresource
+
+    # Represents identifier details for a contact in a directory search
+    # response.
+    # Contains token name, user names, contact info, account and payment
+    # instrument identifiers, and additional metadata.
+    # @return [IdentifierDirectorySearchResponse]
+    attr_accessor :identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['externalresource'] = 'externalresource'
+      @_hash['identifier'] = 'identifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        externalresource
+        identifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        externalresource
+      ]
+    end
+
+    def initialize(externalresource: SKIP, identifier: SKIP)
+      @externalresource = externalresource unless externalresource == SKIP
+      @identifier = identifier unless 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.
+      externalresource =
+        hash.key?('externalresource') ? hash['externalresource'] : SKIP
+      identifier = IdentifierDirectorySearchResponse.from_hash(hash['identifier']) if
+        hash['identifier']
+
+      # Create object from extracted values.
+      DirectorySearchResponseDto.new(externalresource: externalresource,
+                                     identifier: identifier)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} externalresource: #{@externalresource}, identifier: #{@identifier}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} externalresource: #{@externalresource.inspect}, identifier:"\
+      " #{@identifier.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/disbursement_link.rb

@@ -0,0 +1,116 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Disbursement Link – Represents a link or reference to a disbursement
+  # resource, such as a bank card, cash, or ACH disbursement. Used to provide
+  # details about the disbursement link, including its identifier, URI, status,
+  # funds availability, and card association type.
+  class DisbursementLink < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the disbursement link.
+    # @return [String]
+    attr_accessor :link_id
+
+    # The URI or resource locator for the disbursement link.
+    # @return [String]
+    attr_accessor :uri
+
+    # The current status of the disbursement link (e.g., "active", "inactive",
+    # "pending").
+    # @return [String]
+    attr_accessor :status
+
+    # The funds availability status or date for the disbursement (e.g.,
+    # "immediate", "2025-07-23").
+    # @return [String]
+    attr_accessor :funds_availability
+
+    # The card association type for the disbursement link, if applicable (e.g.,
+    # "Visa", "Mastercard").
+    # @return [String]
+    attr_accessor :card_association_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['link_id'] = 'linkId'
+      @_hash['uri'] = 'uri'
+      @_hash['status'] = 'status'
+      @_hash['funds_availability'] = 'fundsAvailability'
+      @_hash['card_association_type'] = 'cardAssociationType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        link_id
+        uri
+        status
+        funds_availability
+        card_association_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        link_id
+        uri
+        status
+        funds_availability
+        card_association_type
+      ]
+    end
+
+    def initialize(link_id: SKIP, uri: SKIP, status: SKIP,
+                   funds_availability: SKIP, card_association_type: SKIP)
+      @link_id = link_id unless link_id == SKIP
+      @uri = uri unless uri == SKIP
+      @status = status unless status == SKIP
+      @funds_availability = funds_availability unless funds_availability == SKIP
+      @card_association_type = card_association_type unless card_association_type == 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.
+      link_id = hash.key?('linkId') ? hash['linkId'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      funds_availability =
+        hash.key?('fundsAvailability') ? hash['fundsAvailability'] : SKIP
+      card_association_type =
+        hash.key?('cardAssociationType') ? hash['cardAssociationType'] : SKIP
+
+      # Create object from extracted values.
+      DisbursementLink.new(link_id: link_id,
+                           uri: uri,
+                           status: status,
+                           funds_availability: funds_availability,
+                           card_association_type: card_association_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} link_id: #{@link_id}, uri: #{@uri}, status: #{@status}, funds_availability:"\
+      " #{@funds_availability}, card_association_type: #{@card_association_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} link_id: #{@link_id.inspect}, uri: #{@uri.inspect}, status:"\
+      " #{@status.inspect}, funds_availability: #{@funds_availability.inspect},"\
+      " card_association_type: #{@card_association_type.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/disbursement_transaction_detail.rb

@@ -0,0 +1,281 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Disbursement Transaction Detail – Represents detailed information about a
+  # disbursement transaction. Used to provide transaction attributes such as
+  # identifiers, status, claim code, original transaction codes, source and
+  # destination entities, and additional options in transfer status and history
+  # responses. Inherits common transaction properties from
+  # Gd.Bos.DataTransfer.Response.ResponseObjects.DisbursementTransferInfo.
+  class DisbursementTransactionDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier of the transfer transaction.
+    # @return [String]
+    attr_accessor :transfer_identifier
+
+    # The current status of the transaction (e.g., "pending", "completed",
+    # "failed").
+    # @return [String]
+    attr_accessor :status
+
+    # The reason for the current status, if applicable (e.g., "insufficient
+    # funds", "expired").
+    # @return [String]
+    attr_accessor :status_reason
+
+    # The claim code associated with the transaction, if applicable (e.g., for
+    # cash pickup).
+    # @return [String]
+    attr_accessor :claim_code
+
+    # The expiration date of the claim code (format: yyyy-MM-dd), if applicable.
+    # @return [String]
+    attr_accessor :claim_code_expiration_date
+
+    # The original transaction code, if this transaction is related to a
+    # previous transaction.
+    # @return [Integer]
+    attr_accessor :original_transaction_code
+
+    # The description of the original transaction code, if applicable.
+    # @return [String]
+    attr_accessor :original_transaction_code_description
+
+    # The original transaction sub-code, if this transaction is related to a
+    # previous transaction.
+    # @return [Integer]
+    attr_accessor :original_transaction_sub_code
+
+    # Disbursement Transfer Entity – Represents an entity involved in a
+    # disbursement transaction, such as the source or destination of a transfer.
+    # Used to provide entity details including name, unique identifier, and
+    # additional metadata for transaction tracking and auditing.
+    # @return [DisbursementTransferEntity]
+    attr_accessor :source
+
+    # Disbursement Transfer Entity – Represents an entity involved in a
+    # disbursement transaction, such as the source or destination of a transfer.
+    # Used to provide entity details including name, unique identifier, and
+    # additional metadata for transaction tracking and auditing.
+    # @return [DisbursementTransferEntity]
+    attr_accessor :destination
+
+    # Additional options or metadata for the transaction, represented as
+    # key-value pairs.
+    # @return [Array[StringKeyValuePair]]
+    attr_accessor :options
+
+    # Transaction Amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Transaction Currency
+    # @return [String]
+    attr_accessor :currency
+
+    # Transaction Description
+    # @return [String]
+    attr_accessor :description
+
+    # TransactionDate
+    # @return [String]
+    attr_accessor :transaction_date
+
+    # ExternalReferenceId
+    # @return [String]
+    attr_accessor :external_reference_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transfer_identifier'] = 'transferIdentifier'
+      @_hash['status'] = 'status'
+      @_hash['status_reason'] = 'statusReason'
+      @_hash['claim_code'] = 'claimCode'
+      @_hash['claim_code_expiration_date'] = 'claimCodeExpirationDate'
+      @_hash['original_transaction_code'] = 'originalTransactionCode'
+      @_hash['original_transaction_code_description'] =
+        'originalTransactionCodeDescription'
+      @_hash['original_transaction_sub_code'] = 'originalTransactionSubCode'
+      @_hash['source'] = 'source'
+      @_hash['destination'] = 'destination'
+      @_hash['options'] = 'options'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['description'] = 'description'
+      @_hash['transaction_date'] = 'transactionDate'
+      @_hash['external_reference_id'] = 'externalReferenceId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_identifier
+        status
+        status_reason
+        claim_code
+        claim_code_expiration_date
+        original_transaction_code
+        original_transaction_code_description
+        original_transaction_sub_code
+        source
+        destination
+        options
+        amount
+        currency
+        description
+        transaction_date
+        external_reference_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_identifier
+        status
+        status_reason
+        claim_code
+        claim_code_expiration_date
+        original_transaction_code
+        original_transaction_code_description
+        original_transaction_sub_code
+        options
+        currency
+        description
+        transaction_date
+        external_reference_id
+      ]
+    end
+
+    def initialize(transfer_identifier: SKIP, status: SKIP, status_reason: SKIP,
+                   claim_code: SKIP, claim_code_expiration_date: SKIP,
+                   original_transaction_code: SKIP,
+                   original_transaction_code_description: SKIP,
+                   original_transaction_sub_code: SKIP, source: SKIP,
+                   destination: SKIP, options: SKIP, amount: SKIP,
+                   currency: SKIP, description: SKIP, transaction_date: SKIP,
+                   external_reference_id: SKIP)
+      @transfer_identifier = transfer_identifier unless transfer_identifier == SKIP
+      @status = status unless status == SKIP
+      @status_reason = status_reason unless status_reason == SKIP
+      @claim_code = claim_code unless claim_code == SKIP
+      unless claim_code_expiration_date == SKIP
+        @claim_code_expiration_date =
+          claim_code_expiration_date
+      end
+      unless original_transaction_code == SKIP
+        @original_transaction_code =
+          original_transaction_code
+      end
+      unless original_transaction_code_description == SKIP
+        @original_transaction_code_description =
+          original_transaction_code_description
+      end
+      unless original_transaction_sub_code == SKIP
+        @original_transaction_sub_code =
+          original_transaction_sub_code
+      end
+      @source = source unless source == SKIP
+      @destination = destination unless destination == SKIP
+      @options = options unless options == SKIP
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @description = description unless description == SKIP
+      @transaction_date = transaction_date unless transaction_date == SKIP
+      @external_reference_id = external_reference_id unless external_reference_id == 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
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_reason = hash.key?('statusReason') ? hash['statusReason'] : SKIP
+      claim_code = hash.key?('claimCode') ? hash['claimCode'] : SKIP
+      claim_code_expiration_date =
+        hash.key?('claimCodeExpirationDate') ? hash['claimCodeExpirationDate'] : SKIP
+      original_transaction_code =
+        hash.key?('originalTransactionCode') ? hash['originalTransactionCode'] : SKIP
+      original_transaction_code_description =
+        hash.key?('originalTransactionCodeDescription') ? hash['originalTransactionCodeDescription'] : SKIP
+      original_transaction_sub_code =
+        hash.key?('originalTransactionSubCode') ? hash['originalTransactionSubCode'] : SKIP
+      source = DisbursementTransferEntity.from_hash(hash['source']) if hash['source']
+      destination = DisbursementTransferEntity.from_hash(hash['destination']) if
+        hash['destination']
+      # Parameter is an array, so we need to iterate through it
+      options = nil
+      unless hash['options'].nil?
+        options = []
+        hash['options'].each do |structure|
+          options << (StringKeyValuePair.from_hash(structure) if structure)
+        end
+      end
+
+      options = SKIP unless hash.key?('options')
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      transaction_date =
+        hash.key?('transactionDate') ? hash['transactionDate'] : SKIP
+      external_reference_id =
+        hash.key?('externalReferenceId') ? hash['externalReferenceId'] : SKIP
+
+      # Create object from extracted values.
+      DisbursementTransactionDetail.new(transfer_identifier: transfer_identifier,
+                                        status: status,
+                                        status_reason: status_reason,
+                                        claim_code: claim_code,
+                                        claim_code_expiration_date: claim_code_expiration_date,
+                                        original_transaction_code: original_transaction_code,
+                                        original_transaction_code_description: original_transaction_code_description,
+                                        original_transaction_sub_code: original_transaction_sub_code,
+                                        source: source,
+                                        destination: destination,
+                                        options: options,
+                                        amount: amount,
+                                        currency: currency,
+                                        description: description,
+                                        transaction_date: transaction_date,
+                                        external_reference_id: external_reference_id)
+    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}, status: #{@status},"\
+      " status_reason: #{@status_reason}, claim_code: #{@claim_code}, claim_code_expiration_date:"\
+      " #{@claim_code_expiration_date}, original_transaction_code: #{@original_transaction_code},"\
+      " original_transaction_code_description: #{@original_transaction_code_description},"\
+      " original_transaction_sub_code: #{@original_transaction_sub_code}, source: #{@source},"\
+      " destination: #{@destination}, options: #{@options}, amount: #{@amount}, currency:"\
+      " #{@currency}, description: #{@description}, transaction_date: #{@transaction_date},"\
+      " external_reference_id: #{@external_reference_id}>"
+    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}, status:"\
+      " #{@status.inspect}, status_reason: #{@status_reason.inspect}, claim_code:"\
+      " #{@claim_code.inspect}, claim_code_expiration_date:"\
+      " #{@claim_code_expiration_date.inspect}, original_transaction_code:"\
+      " #{@original_transaction_code.inspect}, original_transaction_code_description:"\
+      " #{@original_transaction_code_description.inspect}, original_transaction_sub_code:"\
+      " #{@original_transaction_sub_code.inspect}, source: #{@source.inspect}, destination:"\
+      " #{@destination.inspect}, options: #{@options.inspect}, amount: #{@amount.inspect},"\
+      " currency: #{@currency.inspect}, description: #{@description.inspect}, transaction_date:"\
+      " #{@transaction_date.inspect}, external_reference_id: #{@external_reference_id.inspect}>"
+    end
+  end
+end