box-node-sdk
Version:
Official SDK for Box Platform APIs
276 lines • 11.6 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.DocgenManager = exports.CreateDocgenBatchV2025R0Headers = exports.GetDocgenBatchJobByIdV2025R0Headers = exports.GetDocgenJobsV2025R0Headers = exports.GetDocgenJobByIdV2025R0Headers = exports.CreateDocgenBatchV2025R0Optionals = exports.GetDocgenBatchJobByIdV2025R0Optionals = exports.GetDocgenJobByIdV2025R0Optionals = void 0;
const docGenJobV2025R0_1 = require("../schemas/v2025R0/docGenJobV2025R0");
const docGenJobsFullV2025R0_1 = require("../schemas/v2025R0/docGenJobsFullV2025R0");
const docGenJobsV2025R0_1 = require("../schemas/v2025R0/docGenJobsV2025R0");
const docGenBatchBaseV2025R0_1 = require("../schemas/v2025R0/docGenBatchBaseV2025R0");
const docGenBatchCreateRequestV2025R0_1 = require("../schemas/v2025R0/docGenBatchCreateRequestV2025R0");
const network_1 = require("../networking/network");
const fetchOptions_1 = require("../networking/fetchOptions");
const utils_1 = require("../internal/utils");
const utils_2 = require("../internal/utils");
class GetDocgenJobByIdV2025R0Optionals {
headers = new GetDocgenJobByIdV2025R0Headers({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetDocgenJobByIdV2025R0Optionals = GetDocgenJobByIdV2025R0Optionals;
class GetDocgenBatchJobByIdV2025R0Optionals {
queryParams = {};
headers = new GetDocgenBatchJobByIdV2025R0Headers({});
cancellationToken = void 0;
constructor(fields) {
if (fields.queryParams !== undefined) {
this.queryParams = fields.queryParams;
}
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetDocgenBatchJobByIdV2025R0Optionals = GetDocgenBatchJobByIdV2025R0Optionals;
class CreateDocgenBatchV2025R0Optionals {
headers = new CreateDocgenBatchV2025R0Headers({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.CreateDocgenBatchV2025R0Optionals = CreateDocgenBatchV2025R0Optionals;
class GetDocgenJobByIdV2025R0Headers {
/**
* Version header. */
boxVersion = '2025.0';
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.boxVersion !== undefined) {
this.boxVersion = fields.boxVersion;
}
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetDocgenJobByIdV2025R0Headers = GetDocgenJobByIdV2025R0Headers;
class GetDocgenJobsV2025R0Headers {
/**
* Version header. */
boxVersion = '2025.0';
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.boxVersion !== undefined) {
this.boxVersion = fields.boxVersion;
}
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetDocgenJobsV2025R0Headers = GetDocgenJobsV2025R0Headers;
class GetDocgenBatchJobByIdV2025R0Headers {
/**
* Version header. */
boxVersion = '2025.0';
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.boxVersion !== undefined) {
this.boxVersion = fields.boxVersion;
}
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetDocgenBatchJobByIdV2025R0Headers = GetDocgenBatchJobByIdV2025R0Headers;
class CreateDocgenBatchV2025R0Headers {
/**
* Version header. */
boxVersion = '2025.0';
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.boxVersion !== undefined) {
this.boxVersion = fields.boxVersion;
}
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.CreateDocgenBatchV2025R0Headers = CreateDocgenBatchV2025R0Headers;
class DocgenManager {
auth;
networkSession = new network_1.NetworkSession({});
constructor(fields) {
if (fields.auth !== undefined) {
this.auth = fields.auth;
}
if (fields.networkSession !== undefined) {
this.networkSession = fields.networkSession;
}
}
/**
* Get details of the Box Doc Gen job.
* @param {string} jobId Box Doc Gen job ID.
Example: 123
* @param {GetDocgenJobByIdV2025R0OptionalsInput} optionalsInput
* @returns {Promise<DocGenJobV2025R0>}
*/
async getDocgenJobByIdV2025R0(jobId, optionalsInput = {}) {
const optionals = new GetDocgenJobByIdV2025R0Optionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)({
...{ ['box-version']: (0, utils_2.toString)(headers.boxVersion) },
...headers.extraHeaders,
});
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/docgen_jobs/', (0, utils_2.toString)(jobId)),
method: 'GET',
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, docGenJobV2025R0_1.deserializeDocGenJobV2025R0)(response.data),
rawData: response.data,
};
}
/**
* Lists all Box Doc Gen jobs for a user.
* @param {GetDocgenJobsV2025R0QueryParams} queryParams Query parameters of getDocgenJobsV2025R0 method
* @param {GetDocgenJobsV2025R0HeadersInput} headersInput Headers of getDocgenJobsV2025R0 method
* @param {CancellationToken} cancellationToken Token used for request cancellation.
* @returns {Promise<DocGenJobsFullV2025R0>}
*/
async getDocgenJobsV2025R0(queryParams = {}, headersInput = new GetDocgenJobsV2025R0Headers({}), cancellationToken) {
const headers = new GetDocgenJobsV2025R0Headers({
boxVersion: headersInput.boxVersion,
extraHeaders: headersInput.extraHeaders,
});
const queryParamsMap = (0, utils_1.prepareParams)({
['marker']: (0, utils_2.toString)(queryParams.marker),
['limit']: (0, utils_2.toString)(queryParams.limit),
});
const headersMap = (0, utils_1.prepareParams)({
...{ ['box-version']: (0, utils_2.toString)(headers.boxVersion) },
...headers.extraHeaders,
});
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/docgen_jobs'),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, docGenJobsFullV2025R0_1.deserializeDocGenJobsFullV2025R0)(response.data),
rawData: response.data,
};
}
/**
* Lists Box Doc Gen jobs in a batch.
* @param {string} batchId Box Doc Gen batch ID.
Example: 123
* @param {GetDocgenBatchJobByIdV2025R0OptionalsInput} optionalsInput
* @returns {Promise<DocGenJobsV2025R0>}
*/
async getDocgenBatchJobByIdV2025R0(batchId, optionalsInput = {}) {
const optionals = new GetDocgenBatchJobByIdV2025R0Optionals({
queryParams: optionalsInput.queryParams,
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const queryParams = optionals.queryParams;
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const queryParamsMap = (0, utils_1.prepareParams)({
['marker']: (0, utils_2.toString)(queryParams.marker),
['limit']: (0, utils_2.toString)(queryParams.limit),
});
const headersMap = (0, utils_1.prepareParams)({
...{ ['box-version']: (0, utils_2.toString)(headers.boxVersion) },
...headers.extraHeaders,
});
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/docgen_batch_jobs/', (0, utils_2.toString)(batchId)),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, docGenJobsV2025R0_1.deserializeDocGenJobsV2025R0)(response.data),
rawData: response.data,
};
}
/**
* Generates a document using a Box Doc Gen template.
* @param {DocGenBatchCreateRequestV2025R0} requestBody Request body of createDocgenBatchV2025R0 method
* @param {CreateDocgenBatchV2025R0OptionalsInput} optionalsInput
* @returns {Promise<DocGenBatchBaseV2025R0>}
*/
async createDocgenBatchV2025R0(requestBody, optionalsInput = {}) {
const optionals = new CreateDocgenBatchV2025R0Optionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)({
...{ ['box-version']: (0, utils_2.toString)(headers.boxVersion) },
...headers.extraHeaders,
});
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/docgen_batches'),
method: 'POST',
headers: headersMap,
data: (0, docGenBatchCreateRequestV2025R0_1.serializeDocGenBatchCreateRequestV2025R0)(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, docGenBatchBaseV2025R0_1.deserializeDocGenBatchBaseV2025R0)(response.data),
rawData: response.data,
};
}
}
exports.DocgenManager = DocgenManager;
//# sourceMappingURL=docgen.js.map