@hitc/netsuite-types/N/render.d.ts

TypeScript typings for SuiteScript 2.0

import type {File} from './file';
import type {Record} from './record';
import type {ServerResponse} from './http';
import type {Result} from './search';
import type {NSXMLDocument} from './xml';
import type {Query} from './query';

interface AddCustomDataSourceOptions {
    /** Data source alias. */
    alias: string;
    /** Data format, uses the render.DataSource enum. */
    format: DataSource;
    /** Object, document, or string. */
    data: any | NSXMLDocument | string;
}

interface AddRecordOptions {
    /** Name of the template. */
    templateName: string;
    /** The loaded record object to add. */
    record: Record;
}

interface AddSearchResultsOptions {
    /** Name of the template. */
    templateName: string;
    /** The search results to add. Note: Documentation says this is a single result, but it's actually an array of results. */
    searchResult: Result[];
}

interface BOMOptions {
    /** The internal ID of the bill of material to print. */
    entityId: number;
    /** The print output type. Set using the render.PrintMode enum. */
    printMode?: PrintMode;
}

interface EmailMergeResult {
    /** The body of the email distribution in string format. */
    body: string;
    /** The subject of the email distribution in string format. */
    subject: string;
}

interface MergeEmailOptions {
    /** Internal ID of the template. */
    templateId: number;    // One of the below fields must be included.
    /** Entity record reference. For example, an employee. */
    entity?: RecordRef;
    /** Recipient record reference.  For example, a lead. */
    recipient?: RecordRef;
    /** Custom record reference. */
    customRecord?: RecordRef;
    /** Support Case ID. */
    supportCaseId?: number;
    /** Transaction ID. */
    transactionId?: number;
}

interface PackingSlipOptions {
    /** The internal ID of the packing slip to print. */
    entityId: number;
    /** The print output type. Set using the render.PrintMode enum. */
    printMode?: PrintMode;
    /** The packing slip form number. */
    formId?: number;
    /** Fulfillment ID number. */
    fulfillmentId?: number;
}

interface PickingTicketOptions {
    /** The internal ID of the picking ticket to print. */
    entityId: number;
    /** The print output type. Set using the render.PrintMode enum. */
    printMode?: PrintMode;
    /** The packing slip form number. */
    formId?: number;
    /** Shipping group for the ticket. */
    shipgroup?: number;
    /** Location for the ticket. */
    location?: number;
}

interface RecordRef {
    id: number;
    type: string;
}

interface RenderToResponseOptions {
    /** Response that will be written to PDF. For example, the response passed from a Suitelet. */
    response: ServerResponse;
}

interface StatementOptions {
    /** Flag to convert all amount values to the base currency. */
    consolidateStatements?: boolean;
    /** The internal ID of the statement to print. */
    entityId: number;
    /** Internal ID of the form to use to print the statement. */
    formId?: number;
    /** Applies when advanced templates are used. Prints the document in the customer's locale. If basic printing is used, this parameter is ignored and the transaction form is printed in the customer's locale.*/
    inCustLocale?: boolean;
    /** Include only open transactions. */
    openTransactionsOnly?: boolean;
    /** The print output type. Set using the render.PrintMode enum. */
    printMode?: PrintMode;
    /** Date of the oldest transaction to appear on the statement. */
    startDate?: string;
    /** Statement date. NS Docs say this should be a Date object, but in practice it should be a string.*/
    statementDate?: string;
    /** Internal ID of the subsidiary. Note: This parameter only works for advance printing. */
    subsidiaryId?: number;
}

interface XMLToPDFOptions {
    /** XML document or string to convert to PDF. */
    xmlString: string;
}

/** See: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/subsect_156215822877.html#subsect_159601086460 **/
interface GLImpactOptions {
    /** The internal ID of the transaction to print GL Impact. */
    internalId: number;
    /** The print output type. Set using the render.PrintMode enum. */
    printMode?: PrintMode|string;
    /** Include only specific subsidiaries. Default to false. */
    printPerSubsidiary?: boolean;
    /** Specific subsidiaries, only available when printPerSubsidiary is set to true. */
    subsidiaries?: number[];
    /** Specific accounting books. If not specify, prints GL Impact in all accounting books. */
    accountingBooks?: number[];
    /** Internal ID of the template. If not specify, the preferred template will be used. */
    template?: number;
}

interface TemplateRenderer {
    /** Adds XML or JSON as custom data source to an advanced PDF/HTML template. */
    addCustomDataSource(options: AddCustomDataSourceOptions): void;
    /**
     * Uses Query as the renderer’s data source.
     * You can specify the SuiteAnalytics workbook query either in the Query object, or provide a workbook ID to use the query from an existing SuiteAnalytics workbook.
     * One of options.query or options.id is required in the script.
     */
    addQuery(options: AddQueryOptions): void;
    /** Binds a record to a template variable. */
    addRecord(options: AddRecordOptions): void;
    /** Binds a search result to a template variable. */
    addSearchResults(options: AddSearchResultsOptions): void;
    /** Uses the advanced template to produce a PDF printed form. */
    renderAsPdf(): File;
    /** Renders a server response into a PDF file. For example, you can pass in a response to be rendered as a PDF in a browser, or downloaded by a user. */
    renderPdfToResponse(options: RenderToResponseOptions): void;
    renderPdfToResponse(serverResponse: ServerResponse): void;
    /** Return template content in string form. */
    renderAsString(): string;
    /** Writes template content to a server response. */
    renderToResponse(options: RenderToResponseOptions): void;
    renderToResponse(serverResponse: ServerResponse): void;
    /** Sets the template using the internal ID. */
    setTemplateById(options: { id: number; }): void;
    /** Sets the template using the script ID. */
    setTemplateByScriptId(options: { scriptId: Uppercase<string>; }): void;
    /** Content of template. */
    templateContent: string;
}

interface AddQueryOptions {
    /** Template name. */
    templateName: string;
    /** Workbook query definition. Required if options.id is not specified. */
    query?: Query;
    /** Workbook query ID. Required if options.query is not specified. */
    id?: string;
}

interface TransactionOptions {
    /** The internal ID of the transaction to print. */
    entityId: number;
    /** The print output type. Set using the render.PrintMode enum. */
    printMode?: PrintMode|string;
    /** The transaction form number. */
    formId?: number;
    /** Applies when advanced templates are used. Print the document in the customer's locale. If basic printing is used, this parameter is ignored and the transaction form is printed in the customer's locale. */
    inCustLocale?: boolean;
}

/** Use this method to create a PDF or HTML object of a bill of material. */
export function bom(options: BOMOptions): File;
/** Use this method to produce HTML and PDF printed forms with advanced PDF/HTML templates. */
export function create(): TemplateRenderer;
/** Creates a render.EmailMergeResult object for a mail merge with an existing scriptable email template. */
export function mergeEmail(options: MergeEmailOptions): EmailMergeResult;
/** Use this method to create a PDF or HTML object of a packing slip. */
export function packingSlip(options: PackingSlipOptions): File;
/** Use this method to create a PDF or HTML object of a picking ticket. */
export function pickingTicket(options: PickingTicketOptions): File;
/** Use this method to create a PDF or HTML object of a statement. */
export function statement(options: StatementOptions): File;
/** Use this method to create a PDF or HTML object of a transaction. */
export function transaction(options: TransactionOptions): File;
/** Method used to pass XML to the Big Faceless Organization tag library (which is stored by NetSuite), and return a PDF file. */
export function xmlToPdf(options: XMLToPDFOptions): File;
/** Use this method to create a PDF or HTML object of the GL Impact of a transaction. */
export function glImpact(options: GLImpactOptions): File;

/** Holds the string values for supported data source types. Use this enum to set the options.format parameter. */
export enum DataSource {
    JSON,
    OBJECT,
    XML_DOC,
    XML_STRING
}

/** Holds the string values for supported print output types. Use this enum to set the options.printMode parameter. */
export enum PrintMode {
    DEFAULT,
    HTML,
    PDF
}