starkbank
Version:
SDK to facilitate Node integrations with Stark Bank
159 lines (151 loc) • 7.39 kB
JavaScript
const rest = require('../utils/rest.js');
const check = require('starkcore').check;
const Resource = require('starkcore').Resource;
class Transaction extends Resource {
/**
*
* Transaction object
*
* @description A Transaction is a transfer of funds between workspaces inside Stark Bank.
* Transactions created by the user are only for internal transactions.
* Other operations (such as transfer or charge-payment) will automatically
* create a transaction for the user which can be retrieved for the statement.
* When you initialize a Transaction, the entity will not be automatically
* created in the Stark Bank API. The 'create' function sends the objects
* to the Stark Bank API and returns the list of created objects.
*
* Parameters (required):
* @param amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
* @param description [string]: text to be displayed in the receiver and the sender statements (Min. 10 characters). ex: 'funds redistribution'
* @param externalId [string]: unique id, generated by user, to avoid duplicated transactions. ex: 'transaction ABC 2020-03-30'
* @param receivedId [string]: unique id of the receiving workspace. ex: '5656565656565656'
*
* Parameters (optional):
* @param tags [list of strings, default null]: list of strings for reference when searching transactions (may be empty). ex: ['abc', 'test']
*
* Attributes (return-only):
* @param senderId [string]: unique id of the sending workspace. ex: '5656565656565656'
* @param source [string]: unique locator of the related entity in the API reference
* @param id [string]: unique id returned when Transaction is created. ex: '7656565656565656'
* @param fee [integer]: fee charged when the transaction is created. ex: 200 (= R$ 2.00)
* @param balance [integer]: account balance after transaction was processed. ex: 100000000 (= R$ 1,000,000.00)
* @param created [string]: creation datetime for the transaction. ex: '2020-03-10 10:30:00.000'
*
*/
constructor({ amount, description, externalId, receiverId, senderId, tags, fee, created, source, id, balance }) {
super(id);
this.amount = amount;
this.description = description;
this.externalId = externalId;
this.receiverId = receiverId;
this.senderId = senderId;
this.tags = tags;
this.fee = fee;
this.source = source;
this.balance = balance;
this.created = check.datetime(created);
}
}
exports.Transaction = Transaction;
let resource = {'class': exports.Transaction, 'name': 'Transaction'};
exports.create = async function (transactions, {user} = {}) {
/**
* @deprecated Function deprecated since v2.36.0
* Create Transactions
*
* @description Send a list of Transaction objects for creation in the Stark Bank API
*
* Parameters (required):
* @param transactions [list of Transaction objects]: list of Transaction objects to be created in the API
*
* Parameters (optional):
* @param user [Organization/Project object]: Organization or Project object. Not necessary if starkbank.user was set before function call
*
* Return:
* @returns list of Transaction objects with updated attributes
*
*/
throw new Error('Function deprecated since v2.36.0');
};
exports.get = async function (id, {user} = {}) {
/**
*
* Retrieve a specific Transaction
*
* @description Receive a single Transaction object previously created in the Stark Bank API by passing its id
*
* Parameters (required):
* @param id [string]: object unique id. ex: '5656565656565656'
*
* Parameters (optional):
* @param user [Organization/Project object]: Organization or Project object. Not necessary if starkbank.user was set before function call
*
* Return:
* @returns Transaction object with updated attributes
*
*/
return rest.getId(resource, id, user);
};
exports.query = async function ({limit, after, before, tags, externalIds, ids, user} = {}) {
/**
*
* Retrieve Transactions
*
* @description Receive a generator of Transaction objects previously created in the Stark Bank API
*
* Parameters (optional):
* @param limit [integer, default null]: maximum number of objects to be retrieved. Unlimited if null. ex: 35
* @param after [string, default null] date filter for objects created only after specified date. ex: '2020-03-10'
* @param before [string, default null] date filter for objects created only before specified date. ex: '2020-03-10'
* @param tags [list of strings, default null]: tags to filter retrieved objects.ex: ['tony', 'stark']
* @param externalIds [list of strings, default null]: list of external ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
* @param ids [list of strings, default null]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
* @param user [Project object, default null]: Project object. Not necessary if starkbank.user was set before function call
*
* Return:
* @returns generator of Transaction objects with updated attributes
*
*/
let query = {
limit: limit,
after: after,
before: before,
tags: tags,
externalIds: externalIds,
ids: ids
};
return rest.getList(resource, query, user);
};
exports.page = async function ({ cursor, limit, after, before, tags, externalIds, ids, user } = {}) {
/**
*
* Retrieve paged Transactions
*
* @description Receive a list of up to 100 Transaction objects previously created in the Stark Bank API and the cursor to the next page.
* Use this function instead of query if you want to manually page your requests.
*
* Parameters (optional):
* @param cursor [string, default null]: cursor returned on the previous page function call
* @param limit [integer, default null]: maximum number of objects to be retrieved. Unlimited if null. ex: 35
* @param after [string, default null] date filter for objects created only after specified date. ex: '2020-03-10'
* @param before [string, default null] date filter for objects created only before specified date. ex: '2020-03-10'
* @param tags [list of strings, default null]: tags to filter retrieved objects.ex: ['tony', 'stark']
* @param externalIds [list of strings, default null]: list of external ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
* @param ids [list of strings, default null]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
* @param user [Project object, default null]: Project object. Not necessary if starkbank.user was set before function call
*
* Return:
* @returns list of Transaction objects with updated attributes and cursor to retrieve the next page of Transaction objects
*
*/
let query = {
cursor: cursor,
limit: limit,
after: after,
before: before,
tags: tags,
externalIds: externalIds,
ids: ids
};
return rest.getPage(resource, query, user);
};