forma-embedded-view-sdk/dist/internal/generators.js

The Forma Embedded View SDK is a JavaScript library for creating custom extensions in Autodesk Forma Site Design (previously Spacemaker).

/**
 * Manage [generators](https://aps.autodesk.com/en/docs/forma/v1/http-specification/generators-api/) registered in Forma Site Design.
 *
 * @remarks
 * Available via {@link auto.Forma | Forma}.{@link index.EmbeddedViewSdk.generators | generators}.
 */
export class GeneratorsApi {
    #iframeMessenger;
    /** @hidden */
    constructor(iframeMessenger) {
        this.#iframeMessenger = iframeMessenger;
    }
    /**
     * Create or replace a generator.
     *
     * @returns The created or replaced generator resource model.
     */
    async put(request) {
        return await this.#iframeMessenger.sendRequest("generators/put", request);
    }
    /**
     * List out generators within the specified authcontext.
     *
     * @returns List of registered generators.
     */
    async list(request) {
        return await this.#iframeMessenger.sendRequest("generators/list", {
            authcontext: request?.authcontext,
        });
    }
}