apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/transfer_request.rb

@@ -0,0 +1,232 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to initiate a funds transfer between accounts, cards,
+  # or external endpoints. This request supports a variety of transfer types,
+  # including account-to-account (A2A), business-to-consumer (B2C)
+  # disbursements, debit card transfers, and partner-initiated transfers. The
+  # request includes all necessary information for authorization, routing, and
+  # optional metadata for fraud detection and reporting.
+  class TransferRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required. A unique identifier for the transfer, generated by the client
+    # for idempotency and tracking.
+    # @return [String]
+    attr_accessor :transfer_identifier
+
+    # Required. The type of transfer to perform.
+    # <list type="bullet"><item><description>Use `A2AOut` for Debit Card
+    # transfers.</description></item><item><description>Use
+    # `DisbursementExternal` for B2C
+    # Disbursements.</description></item><item><description>Use `PartnerA2A` for
+    # partner account-to-account
+    # transfers.</description></item><item><description>Use `A2A` for
+    # account-to-account transfers.</description></item></list>
+    # @return [String]
+    attr_accessor :transfer_type
+
+    # Required. The authorization type for the transfer. This must be set to
+    # `execute`.
+    # @return [String]
+    attr_accessor :transfer_authorization_type
+
+    # Required. The identifier of the funding source account (initiator) for the
+    # transfer.
+    # @return [String]
+    attr_accessor :initiator
+
+    # Optional. The identifier for the bank account verification process. Used
+    # only for ACH Pull transfers.
+    # @return [String]
+    attr_accessor :verification_identifier
+
+    # Optional. The unique identifier of the user initiating the transfer. Used
+    # only for ACH Out transfers.
+    # @return [String]
+    attr_accessor :user_identifier
+
+    # Optional. A memo or note to associate with the transfer.
+    # @return [String]
+    attr_accessor :memo
+
+    # Optional. A description for the transfer, such as the purpose or reference
+    # for the transaction.
+    # @return [String]
+    attr_accessor :transfer_description
+
+    # Optional. Partner-provided reference data for cross-referencing the
+    # transfer in settlement reports.
+    # Including this field enables the partner to match the report information
+    # with internal records.
+    # @return [String]
+    attr_accessor :partner_reference_data
+
+    # 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
+
+    # Optional. A dictionary of key/value pairs containing additional fraud
+    # detection data for the transfer.
+    # Expected keys for transfer types IFTSend and ECashSend include `deviceId`
+    # and `customerIP`.
+    # @return [Hash[String, Object]]
+    attr_accessor :fraud_data
+
+    # Represents device-specific information used when initiating a funds
+    # transfer or other sensitive operation.
+    # This data is used for device identification, risk assessment, and fraud
+    # prevention.
+    # @return [DeviceDetails]
+    attr_accessor :device_details
+
+    # 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['transfer_authorization_type'] = 'transferAuthorizationType'
+      @_hash['initiator'] = 'initiator'
+      @_hash['verification_identifier'] = 'verificationIdentifier'
+      @_hash['user_identifier'] = 'userIdentifier'
+      @_hash['memo'] = 'memo'
+      @_hash['transfer_description'] = 'transferDescription'
+      @_hash['partner_reference_data'] = 'partnerReferenceData'
+      @_hash['transfer_route'] = 'transferRoute'
+      @_hash['fraud_data'] = 'fraudData'
+      @_hash['device_details'] = 'deviceDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_identifier
+        transfer_type
+        transfer_authorization_type
+        initiator
+        verification_identifier
+        user_identifier
+        memo
+        transfer_description
+        partner_reference_data
+        transfer_route
+        fraud_data
+        device_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_identifier
+        transfer_type
+        transfer_authorization_type
+        initiator
+        verification_identifier
+        user_identifier
+        memo
+        transfer_description
+        partner_reference_data
+        fraud_data
+      ]
+    end
+
+    def initialize(transfer_identifier: SKIP, transfer_type: SKIP,
+                   transfer_authorization_type: SKIP, initiator: SKIP,
+                   verification_identifier: SKIP, user_identifier: SKIP,
+                   memo: SKIP, transfer_description: SKIP,
+                   partner_reference_data: SKIP, transfer_route: SKIP,
+                   fraud_data: SKIP, device_details: SKIP)
+      @transfer_identifier = transfer_identifier unless transfer_identifier == SKIP
+      @transfer_type = transfer_type unless transfer_type == SKIP
+      unless transfer_authorization_type == SKIP
+        @transfer_authorization_type =
+          transfer_authorization_type
+      end
+      @initiator = initiator unless initiator == SKIP
+      @verification_identifier = verification_identifier unless verification_identifier == SKIP
+      @user_identifier = user_identifier unless user_identifier == SKIP
+      @memo = memo unless memo == SKIP
+      @transfer_description = transfer_description unless transfer_description == SKIP
+      @partner_reference_data = partner_reference_data unless partner_reference_data == SKIP
+      @transfer_route = transfer_route unless transfer_route == SKIP
+      @fraud_data = fraud_data unless fraud_data == SKIP
+      @device_details = device_details unless device_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.
+      transfer_identifier =
+        hash.key?('transferIdentifier') ? hash['transferIdentifier'] : SKIP
+      transfer_type = hash.key?('transferType') ? hash['transferType'] : SKIP
+      transfer_authorization_type =
+        hash.key?('transferAuthorizationType') ? hash['transferAuthorizationType'] : SKIP
+      initiator = hash.key?('initiator') ? hash['initiator'] : SKIP
+      verification_identifier =
+        hash.key?('verificationIdentifier') ? hash['verificationIdentifier'] : SKIP
+      user_identifier =
+        hash.key?('userIdentifier') ? hash['userIdentifier'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      transfer_description =
+        hash.key?('transferDescription') ? hash['transferDescription'] : SKIP
+      partner_reference_data =
+        hash.key?('partnerReferenceData') ? hash['partnerReferenceData'] : SKIP
+      transfer_route = TransferRoute2.from_hash(hash['transferRoute']) if hash['transferRoute']
+      fraud_data = hash.key?('fraudData') ? hash['fraudData'] : SKIP
+      device_details = DeviceDetails.from_hash(hash['deviceDetails']) if hash['deviceDetails']
+
+      # Create object from extracted values.
+      TransferRequest.new(transfer_identifier: transfer_identifier,
+                          transfer_type: transfer_type,
+                          transfer_authorization_type: transfer_authorization_type,
+                          initiator: initiator,
+                          verification_identifier: verification_identifier,
+                          user_identifier: user_identifier,
+                          memo: memo,
+                          transfer_description: transfer_description,
+                          partner_reference_data: partner_reference_data,
+                          transfer_route: transfer_route,
+                          fraud_data: fraud_data,
+                          device_details: device_details)
+    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}, transfer_authorization_type: #{@transfer_authorization_type},"\
+      " initiator: #{@initiator}, verification_identifier: #{@verification_identifier},"\
+      " user_identifier: #{@user_identifier}, memo: #{@memo}, transfer_description:"\
+      " #{@transfer_description}, partner_reference_data: #{@partner_reference_data},"\
+      " transfer_route: #{@transfer_route}, fraud_data: #{@fraud_data}, device_details:"\
+      " #{@device_details}>"
+    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}, transfer_authorization_type:"\
+      " #{@transfer_authorization_type.inspect}, initiator: #{@initiator.inspect},"\
+      " verification_identifier: #{@verification_identifier.inspect}, user_identifier:"\
+      " #{@user_identifier.inspect}, memo: #{@memo.inspect}, transfer_description:"\
+      " #{@transfer_description.inspect}, partner_reference_data:"\
+      " #{@partner_reference_data.inspect}, transfer_route: #{@transfer_route.inspect},"\
+      " fraud_data: #{@fraud_data.inspect}, device_details: #{@device_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/transfer_response.rb

@@ -0,0 +1,127 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after processing a funds transfer request.
+  # Contains details about the created transfer, including its identifier and
+  # status, as well as any associated accounts and fraud data.
+  class TransferResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the details of a funds transfer created via the API.
+    # Contains the unique transfer identifier and the current status of the
+    # transfer.
+    # Used in transfer-related responses to provide tracking and status
+    # information for the initiated transaction.
+    # @return [CreateTransfers]
+    attr_accessor :transfer
+
+    # A list of accounts involved in the transfer, such as the source and target
+    # accounts.
+    # Each account object contains identifiers, product information, status, and
+    # other relevant data.
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # Optional. A dictionary of key/value pairs containing fraud detection data
+    # associated with the transfer.
+    # This data may be returned if fraud checks were performed during the
+    # transfer process.
+    # @return [Hash[String, Object]]
+    attr_accessor :fraud_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['transfer'] = 'transfer'
+      @_hash['accounts'] = 'accounts'
+      @_hash['fraud_data'] = 'fraudData'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer
+        accounts
+        fraud_data
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        accounts
+        fraud_data
+        response_details
+      ]
+    end
+
+    def initialize(transfer: SKIP, accounts: SKIP, fraud_data: SKIP,
+                   response_details: SKIP)
+      @transfer = transfer unless transfer == SKIP
+      @accounts = accounts unless accounts == SKIP
+      @fraud_data = fraud_data unless fraud_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.
+      transfer = CreateTransfers.from_hash(hash['transfer']) if hash['transfer']
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (Account.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+      fraud_data = hash.key?('fraudData') ? hash['fraudData'] : 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.
+      TransferResponse.new(transfer: transfer,
+                           accounts: accounts,
+                           fraud_data: fraud_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} transfer: #{@transfer}, accounts: #{@accounts}, fraud_data: #{@fraud_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} transfer: #{@transfer.inspect}, accounts: #{@accounts.inspect}, fraud_data:"\
+      " #{@fraud_data.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/transfer_route.rb

@@ -0,0 +1,195 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # 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.
+  class TransferRoute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount to be transferred in the transaction.
+    # @return [Float]
+    attr_accessor :transaction_amount
+
+    # The delivery type for the transfer (e.g., standard, expedited), as a
+    # string code.
+    # @return [String]
+    attr_accessor :delivery_type
+
+    # Represents the endpoint details for a transfer operation.
+    # Contains the type of transfer endpoint (such as account, purse, or program
+    # funding source) and, if applicable, the account identifier.
+    # Used to specify the source or destination in transfer workflows, except
+    # for ACH transfers with a bank account type.
+    # @return [EndPoint]
+    attr_accessor :source_transfer_endpoint
+
+    # Represents the ACH (Automated Clearing House) endpoint details required
+    # for ACH-based transfers.
+    # Contains encrypted or plain bank account information and a reference
+    # identifier for the bank account.
+    # Used to securely provide all necessary details for initiating or
+    # processing ACH transfers, supporting both encrypted and plain data flows.
+    # @return [AchEndPoint]
+    attr_accessor :target_transfer_endpoint
+
+    # The type of recurring transfer, if applicable (e.g., "Monthly", "Weekly").
+    # @return [String]
+    attr_accessor :recurring_type
+
+    # The method used to verify the bank account (e.g., "Instant",
+    # "MicroDeposit").
+    # @return [String]
+    attr_accessor :bank_account_verification_method
+
+    # The date when the bank account was verified, if applicable.
+    # @return [String]
+    attr_accessor :bank_account_verification_date
+
+    # The date when the bank account was authorized for transfers, if
+    # applicable.
+    # @return [String]
+    attr_accessor :bank_account_authorization_date
+
+    # Indicates whether the transfer is a business third-party ACH transaction.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :business_third_party_ach
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_amount'] = 'transactionAmount'
+      @_hash['delivery_type'] = 'deliveryType'
+      @_hash['source_transfer_endpoint'] = 'sourceTransferEndpoint'
+      @_hash['target_transfer_endpoint'] = 'targetTransferEndpoint'
+      @_hash['recurring_type'] = 'recurringType'
+      @_hash['bank_account_verification_method'] =
+        'bankAccountVerificationMethod'
+      @_hash['bank_account_verification_date'] = 'bankAccountVerificationDate'
+      @_hash['bank_account_authorization_date'] =
+        'bankAccountAuthorizationDate'
+      @_hash['business_third_party_ach'] = 'businessThirdPartyACH'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_amount
+        delivery_type
+        source_transfer_endpoint
+        target_transfer_endpoint
+        recurring_type
+        bank_account_verification_method
+        bank_account_verification_date
+        bank_account_authorization_date
+        business_third_party_ach
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transaction_amount
+        delivery_type
+        recurring_type
+        bank_account_verification_method
+        bank_account_verification_date
+        bank_account_authorization_date
+      ]
+    end
+
+    def initialize(transaction_amount: SKIP, delivery_type: SKIP,
+                   source_transfer_endpoint: SKIP,
+                   target_transfer_endpoint: SKIP, recurring_type: SKIP,
+                   bank_account_verification_method: SKIP,
+                   bank_account_verification_date: SKIP,
+                   bank_account_authorization_date: SKIP,
+                   business_third_party_ach: SKIP)
+      @transaction_amount = transaction_amount unless transaction_amount == SKIP
+      @delivery_type = delivery_type unless delivery_type == SKIP
+      @source_transfer_endpoint = source_transfer_endpoint unless source_transfer_endpoint == SKIP
+      @target_transfer_endpoint = target_transfer_endpoint unless target_transfer_endpoint == SKIP
+      @recurring_type = recurring_type unless recurring_type == SKIP
+      unless bank_account_verification_method == SKIP
+        @bank_account_verification_method =
+          bank_account_verification_method
+      end
+      unless bank_account_verification_date == SKIP
+        @bank_account_verification_date =
+          bank_account_verification_date
+      end
+      unless bank_account_authorization_date == SKIP
+        @bank_account_authorization_date =
+          bank_account_authorization_date
+      end
+      @business_third_party_ach = business_third_party_ach unless business_third_party_ach == 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.
+      transaction_amount =
+        hash.key?('transactionAmount') ? hash['transactionAmount'] : SKIP
+      delivery_type = hash.key?('deliveryType') ? hash['deliveryType'] : SKIP
+      source_transfer_endpoint = EndPoint.from_hash(hash['sourceTransferEndpoint']) if
+        hash['sourceTransferEndpoint']
+      target_transfer_endpoint = AchEndPoint.from_hash(hash['targetTransferEndpoint']) if
+        hash['targetTransferEndpoint']
+      recurring_type = hash.key?('recurringType') ? hash['recurringType'] : SKIP
+      bank_account_verification_method =
+        hash.key?('bankAccountVerificationMethod') ? hash['bankAccountVerificationMethod'] : SKIP
+      bank_account_verification_date =
+        hash.key?('bankAccountVerificationDate') ? hash['bankAccountVerificationDate'] : SKIP
+      bank_account_authorization_date =
+        hash.key?('bankAccountAuthorizationDate') ? hash['bankAccountAuthorizationDate'] : SKIP
+      business_third_party_ach =
+        hash.key?('businessThirdPartyACH') ? hash['businessThirdPartyACH'] : SKIP
+
+      # Create object from extracted values.
+      TransferRoute.new(transaction_amount: transaction_amount,
+                        delivery_type: delivery_type,
+                        source_transfer_endpoint: source_transfer_endpoint,
+                        target_transfer_endpoint: target_transfer_endpoint,
+                        recurring_type: recurring_type,
+                        bank_account_verification_method: bank_account_verification_method,
+                        bank_account_verification_date: bank_account_verification_date,
+                        bank_account_authorization_date: bank_account_authorization_date,
+                        business_third_party_ach: business_third_party_ach)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_amount: #{@transaction_amount}, delivery_type:"\
+      " #{@delivery_type}, source_transfer_endpoint: #{@source_transfer_endpoint},"\
+      " target_transfer_endpoint: #{@target_transfer_endpoint}, recurring_type:"\
+      " #{@recurring_type}, bank_account_verification_method:"\
+      " #{@bank_account_verification_method}, bank_account_verification_date:"\
+      " #{@bank_account_verification_date}, bank_account_authorization_date:"\
+      " #{@bank_account_authorization_date}, business_third_party_ach:"\
+      " #{@business_third_party_ach}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_amount: #{@transaction_amount.inspect}, delivery_type:"\
+      " #{@delivery_type.inspect}, source_transfer_endpoint: #{@source_transfer_endpoint.inspect},"\
+      " target_transfer_endpoint: #{@target_transfer_endpoint.inspect}, recurring_type:"\
+      " #{@recurring_type.inspect}, bank_account_verification_method:"\
+      " #{@bank_account_verification_method.inspect}, bank_account_verification_date:"\
+      " #{@bank_account_verification_date.inspect}, bank_account_authorization_date:"\
+      " #{@bank_account_authorization_date.inspect}, business_third_party_ach:"\
+      " #{@business_third_party_ach.inspect}>"
+    end
+  end
+end