starkinfra/sdk/user/organization.js

SDK to facilitate Node integrations with Stark Infra

const User = require('./user').User;


class Organization extends User {
    /**
     * 
     * Organization object
     * 
    * @description The Organization object is an authentication entity for the SDK that
    * represents your entire Organization, being able to access any Workspace
    * underneath it and even create new Workspaces. Only a legal representative
    * of your organization can register or change the Organization credentials.
    * All requests to the Stark Infra API must be authenticated via an SDK user,
    * which must have been previously created at the Stark Infra website
    * [https://web.sandbox.starkinfra.com] or [https://web.starkinfra.com]
    * before you can use it in this SDK. Organizations may be passed as the user parameter on
    * each request or may be defined as the default user at the start (See README).
    * If you are accessing a specific Workspace using Organization credentials, you should
    * specify the workspace ID when building the Organization object or by request, using
    * the organization.withWorkspace(workspaceId) method, which creates a copy of the organization
    * object with the altered workspace ID. If you are listing or creating new Workspaces, the
    * workspaceId should be null.
    * 
    * Parameters (required):
    * @param id [string]: unique id required to identify organization. ex: '5656565656565656'
    * @param privateKey [string]: PEM string of the private key linked to the organization. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
    * @param environment [string]: environment where the organization is being used. ex: 'sandbox' or 'production'
    * @param workspaceId [string]: unique id of the accessed Workspace, if any. ex: null or '4848484848484848'
    * 
    * Attributes (return-only):
    * @param pem [string]: private key in pem format. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
    * 
     */
    constructor({
                    id, privateKey, environment, workspaceId=null, pem=null
                }) {
        super({id, privateKey, environment});
        this.workspaceId = workspaceId
        this.pem = pem;
    }

    accessId() {
        if (this.workspaceId)
            return 'organization/' + this.id + '/workspace/' + this.workspaceId;
        return 'organization/' + this.id;
    }
}

exports.Organization = Organization

exports.replace = function (organization, workspaceId) {
    return new Organization({
        id: organization.id,
        environment: organization.environment,
        privateKey: organization.pem,
        workspaceId: workspaceId
    });
};