tranzak-node/compat/api/payment/transfer/simple/index.js

TRANZAK API client for Nodejs

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;
var _section = _interopRequireWildcard(require("../../../../lib/section.js"));
var _transaction = _interopRequireDefault(require("./transaction.js"));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
/**
 * Copyright 2023 HolyCorn Software
 * The tranzak-node library
 * This section of the library, deals withAPIfunctions that have to do with making a transfer once, to a single destination.
 */

class SimpleTransferSection extends _section.default {
  /**
   * This function transfers funds from the **payout** account, to another TRANZAK user.
   * ***
   * ### Make sure there are sufficient funds in the _payout_ account.
   * @param {tranzak_node.payment.transfer.simple.InternalTransferParams} data 
   */
  async toTranzakUser(data) {
    return new _transaction.default(await this[_section.transport].request({
      path: 'transfer/to-internal-user',
      body: data,
      method: 'POST'
    }), this[_section.transport]);
  }

  /**
   * This function transfers funds from the **payout** account, into a **CEMAC** bank account.
   * ***
   * ### Make sure there are sufficient funds in the _payout_ account.
   * @param {tranzak_node.payment.transfer.simple.CEMACBankTransferParams} data 
   */
  async toCEMACBank(data) {
    return new _transaction.default(await this[_section.transport].request({
      path: 'transfer/to-bank-account',
      body: data,
      method: 'POST'
    }), this[_section.transport]);
  }

  /**
   * This function transfers funds from the **payout** account, to **Mobile Money**.
   * ***
   * ### Make sure there are sufficient funds in the _payout_ account.
   * @param {tranzak_node.payment.transfer.simple.MobileMoneyTransferParams} data 
   */
  async toMobileMoney(data) {
    return new _transaction.default(await this[_section.transport].request({
      path: 'transfer/to-mobile-wallet',
      body: data,
      method: 'POST'
    }), this[_section.transport]);
  }

  /**
   * This function transfers money from any account (most likely, the collection primary account), to the **payout** account.
   * 
   * @param {tranzak_node.payment.transfer.simple.PayoutAccountTransferParams} data 
   */
  async toPayoutAccount(data) {
    return new _transaction.default(await this[_section.transport].request({
      path: 'transfer/payout-account-topup',
      body: data,
      method: 'POST'
    }), this[_section.transport]);
  }

  /**
   * This function returns the previous transactions, as an Async Iterable.
   * 
   * 
   * This means, you're **NOT** expecting a flat array, but an object that can be consumed in a **for loop**, or with the **spread operator**.
   * ***
   * For Example,
   * 
   * ```js
   * const myApiClient = new TRANZAK(...blablabla)
   * const transactions = await myApiClient.payment.transfer.split.history()
   * for await (const item of transactions){
   *      console.log(`A transaction `, item.data)
   *  }
   * 
   * ```
   * ***
   * 
   * To better familiarize yourself with the concept of the AsyncGenerator, you can lookup the [documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator).
   * 
   */
  async history() {
    return await this[_section.transport].paginatedRequest({
      path: `transfer/history`,
      /**
       * 
       * @param {tranzak_node.payment.transfer.simple.Transaction} data 
       */
      transform: data => new _transaction.default(data, this[_section.transport])
    });
  }

  /**
   * This method retrieves a single transaction
   * @param {tranzak_node.payment.transfer.simple.TransactionSearch} search
   */
  async find(search) {
    const transaction = new _transaction.default(search, this[_section.transport]);
    await transaction.refresh();
    return transaction;
  }
}
exports.default = SimpleTransferSection;