starkinfra/sdk/pixDomain/pixDomain.js

SDK to facilitate Node integrations with Stark Infra

const rest = require('../utils/rest.js');
const {Certificate} = require('./certificate');
const {parseObjects} = require('../utils/parse');
const SubResource = require('../utils/subResource').SubResource;
const certificateResource = require('./certificate.js').subResource;


class PixDomain extends SubResource {
    /**
     *
     * PixDomain object
     *
     * @description The PixDomain object displays the domain name and the QR Code domain certificate of Pix participants.
     * All certificates must be registered with the Central Bank.
     *
     * Attributes (return-only):
     * @param certificates [list of PixDomain.Certificate]: certificate information of the Pix participant.
     * @param name [string]: current active domain (URL) of the Pix participant.
     *
     */
    constructor({ 
                    certificates=null, name=null
                }) {
        super();
        
        this.certificates = parseObjects(certificates, certificateResource, Certificate);
        this.name = name;
    }
}

exports.PixDomain = PixDomain;
let resource = {'class': exports.PixDomain, 'name': 'PixDomain'};

exports.query = async function ({ user } = {}) {
    /**
     *
     * Retrieve PixDomains
     *
     * @description Receive a generator of PixDomain objects.
     *
     * Parameters (optional):
     * @param user [Organization/Project object, default null]: Project object. Not necessary if starkinfra.user was set before function call
     *
     * Return:
     * @returns generator of PixDomain objects with updated attributes
     *
     */
    return rest.getList(resource, {}, user);
};