box-node-sdk
Version:
Official SDK for Box Platform APIs
552 lines (542 loc) • 22.8 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.FolderMetadataManager = exports.DeleteFolderMetadataByIdHeaders = exports.UpdateFolderMetadataByIdHeaders = exports.CreateFolderMetadataByIdHeaders = exports.GetFolderMetadataByIdHeaders = exports.GetFolderMetadataHeaders = exports.DeleteFolderMetadataByIdOptionals = exports.UpdateFolderMetadataByIdOptionals = exports.CreateFolderMetadataByIdOptionals = exports.GetFolderMetadataByIdOptionals = exports.GetFolderMetadataOptionals = void 0;
exports.serializeGetFolderMetadataByIdScope = serializeGetFolderMetadataByIdScope;
exports.deserializeGetFolderMetadataByIdScope = deserializeGetFolderMetadataByIdScope;
exports.serializeCreateFolderMetadataByIdScope = serializeCreateFolderMetadataByIdScope;
exports.deserializeCreateFolderMetadataByIdScope = deserializeCreateFolderMetadataByIdScope;
exports.serializeCreateFolderMetadataByIdRequestBody = serializeCreateFolderMetadataByIdRequestBody;
exports.deserializeCreateFolderMetadataByIdRequestBody = deserializeCreateFolderMetadataByIdRequestBody;
exports.serializeUpdateFolderMetadataByIdScope = serializeUpdateFolderMetadataByIdScope;
exports.deserializeUpdateFolderMetadataByIdScope = deserializeUpdateFolderMetadataByIdScope;
exports.serializeUpdateFolderMetadataByIdRequestBodyOpField = serializeUpdateFolderMetadataByIdRequestBodyOpField;
exports.deserializeUpdateFolderMetadataByIdRequestBodyOpField = deserializeUpdateFolderMetadataByIdRequestBodyOpField;
exports.serializeUpdateFolderMetadataByIdRequestBody = serializeUpdateFolderMetadataByIdRequestBody;
exports.deserializeUpdateFolderMetadataByIdRequestBody = deserializeUpdateFolderMetadataByIdRequestBody;
exports.serializeDeleteFolderMetadataByIdScope = serializeDeleteFolderMetadataByIdScope;
exports.deserializeDeleteFolderMetadataByIdScope = deserializeDeleteFolderMetadataByIdScope;
const metadatas_1 = require("../schemas/metadatas");
const metadataFull_1 = require("../schemas/metadataFull");
const metadataInstanceValue_1 = require("../schemas/metadataInstanceValue");
const metadataInstanceValue_2 = require("../schemas/metadataInstanceValue");
const errors_1 = require("../box/errors");
const network_1 = require("../networking/network");
const fetchOptions_1 = require("../networking/fetchOptions");
const utils_1 = require("../internal/utils");
const utils_2 = require("../internal/utils");
const json_1 = require("../serialization/json");
const json_2 = require("../serialization/json");
class GetFolderMetadataOptionals {
queryParams = {};
headers = new GetFolderMetadataHeaders({});
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.GetFolderMetadataOptionals = GetFolderMetadataOptionals;
class GetFolderMetadataByIdOptionals {
headers = new GetFolderMetadataByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetFolderMetadataByIdOptionals = GetFolderMetadataByIdOptionals;
class CreateFolderMetadataByIdOptionals {
headers = new CreateFolderMetadataByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.CreateFolderMetadataByIdOptionals = CreateFolderMetadataByIdOptionals;
class UpdateFolderMetadataByIdOptionals {
headers = new UpdateFolderMetadataByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.UpdateFolderMetadataByIdOptionals = UpdateFolderMetadataByIdOptionals;
class DeleteFolderMetadataByIdOptionals {
headers = new DeleteFolderMetadataByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.DeleteFolderMetadataByIdOptionals = DeleteFolderMetadataByIdOptionals;
class GetFolderMetadataHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetFolderMetadataHeaders = GetFolderMetadataHeaders;
class GetFolderMetadataByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetFolderMetadataByIdHeaders = GetFolderMetadataByIdHeaders;
class CreateFolderMetadataByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.CreateFolderMetadataByIdHeaders = CreateFolderMetadataByIdHeaders;
class UpdateFolderMetadataByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.UpdateFolderMetadataByIdHeaders = UpdateFolderMetadataByIdHeaders;
class DeleteFolderMetadataByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.DeleteFolderMetadataByIdHeaders = DeleteFolderMetadataByIdHeaders;
class FolderMetadataManager {
auth;
networkSession = new network_1.NetworkSession({});
constructor(fields) {
if (fields.auth !== undefined) {
this.auth = fields.auth;
}
if (fields.networkSession !== undefined) {
this.networkSession = fields.networkSession;
}
}
/**
* Retrieves all metadata for a given folder. This can not be used on the root
* folder with ID `0`.
* @param {string} folderId The unique identifier that represent a folder.
The ID for any folder can be determined
by visiting this folder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/folder/123`
the `folder_id` is `123`.
The root folder of a Box account is
always represented by the ID `0`.
Example: "12345"
* @param {GetFolderMetadataOptionalsInput} optionalsInput
* @returns {Promise<Metadatas>}
*/
async getFolderMetadata(folderId, optionalsInput = {}) {
const optionals = new GetFolderMetadataOptionals({
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)({ ['view']: (0, utils_2.toString)(queryParams.view) });
const headersMap = (0, utils_1.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/folders/', (0, utils_2.toString)(folderId), '/metadata'),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, metadatas_1.deserializeMetadatas)(response.data),
rawData: response.data,
};
}
/**
* Retrieves the instance of a metadata template that has been applied to a
* folder. This can not be used on the root folder with ID `0`.
* @param {string} folderId The unique identifier that represent a folder.
The ID for any folder can be determined
by visiting this folder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/folder/123`
the `folder_id` is `123`.
The root folder of a Box account is
always represented by the ID `0`.
Example: "12345"
* @param {GetFolderMetadataByIdScope} scope The scope of the metadata template.
Example: "global"
* @param {string} templateKey The name of the metadata template.
Example: "properties"
* @param {GetFolderMetadataByIdOptionalsInput} optionalsInput
* @returns {Promise<MetadataFull>}
*/
async getFolderMetadataById(folderId, scope, templateKey, optionalsInput = {}) {
const optionals = new GetFolderMetadataByIdOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/folders/', (0, utils_2.toString)(folderId), '/metadata/', (0, utils_2.toString)(scope), '/', (0, utils_2.toString)(templateKey)),
method: 'GET',
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, metadataFull_1.deserializeMetadataFull)(response.data),
rawData: response.data,
};
}
/**
* Applies an instance of a metadata template to a folder.
*
* In most cases only values that are present in the metadata template
* will be accepted, except for the `global.properties` template which accepts
* any key-value pair.
*
* To display the metadata template in the Box web app the enterprise needs to be
* configured to enable **Cascading Folder Level Metadata** for the user in the
* admin console.
* @param {string} folderId The unique identifier that represent a folder.
The ID for any folder can be determined
by visiting this folder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/folder/123`
the `folder_id` is `123`.
The root folder of a Box account is
always represented by the ID `0`.
Example: "12345"
* @param {CreateFolderMetadataByIdScope} scope The scope of the metadata template.
Example: "global"
* @param {string} templateKey The name of the metadata template.
Example: "properties"
* @param {CreateFolderMetadataByIdRequestBody} requestBody Request body of createFolderMetadataById method
* @param {CreateFolderMetadataByIdOptionalsInput} optionalsInput
* @returns {Promise<MetadataFull>}
*/
async createFolderMetadataById(folderId, scope, templateKey, requestBody, optionalsInput = {}) {
const optionals = new CreateFolderMetadataByIdOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/folders/', (0, utils_2.toString)(folderId), '/metadata/', (0, utils_2.toString)(scope), '/', (0, utils_2.toString)(templateKey)),
method: 'POST',
headers: headersMap,
data: serializeCreateFolderMetadataByIdRequestBody(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, metadataFull_1.deserializeMetadataFull)(response.data),
rawData: response.data,
};
}
/**
* Updates a piece of metadata on a folder.
*
* The metadata instance can only be updated if the template has already been
* applied to the folder before. When editing metadata, only values that match
* the metadata template schema will be accepted.
*
* The update is applied atomically. If any errors occur during the
* application of the operations, the metadata instance will not be changed.
* @param {string} folderId The unique identifier that represent a folder.
The ID for any folder can be determined
by visiting this folder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/folder/123`
the `folder_id` is `123`.
The root folder of a Box account is
always represented by the ID `0`.
Example: "12345"
* @param {UpdateFolderMetadataByIdScope} scope The scope of the metadata template.
Example: "global"
* @param {string} templateKey The name of the metadata template.
Example: "properties"
* @param {readonly UpdateFolderMetadataByIdRequestBody[]} requestBody Request body of updateFolderMetadataById method
* @param {UpdateFolderMetadataByIdOptionalsInput} optionalsInput
* @returns {Promise<MetadataFull>}
*/
async updateFolderMetadataById(folderId, scope, templateKey, requestBody, optionalsInput = {}) {
const optionals = new UpdateFolderMetadataByIdOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/folders/', (0, utils_2.toString)(folderId), '/metadata/', (0, utils_2.toString)(scope), '/', (0, utils_2.toString)(templateKey)),
method: 'PUT',
headers: headersMap,
data: requestBody.map(serializeUpdateFolderMetadataByIdRequestBody),
contentType: 'application/json-patch+json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, metadataFull_1.deserializeMetadataFull)(response.data),
rawData: response.data,
};
}
/**
* Deletes a piece of folder metadata.
* @param {string} folderId The unique identifier that represent a folder.
The ID for any folder can be determined
by visiting this folder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/folder/123`
the `folder_id` is `123`.
The root folder of a Box account is
always represented by the ID `0`.
Example: "12345"
* @param {DeleteFolderMetadataByIdScope} scope The scope of the metadata template.
Example: "global"
* @param {string} templateKey The name of the metadata template.
Example: "properties"
* @param {DeleteFolderMetadataByIdOptionalsInput} optionalsInput
* @returns {Promise<undefined>}
*/
async deleteFolderMetadataById(folderId, scope, templateKey, optionalsInput = {}) {
const optionals = new DeleteFolderMetadataByIdOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/folders/', (0, utils_2.toString)(folderId), '/metadata/', (0, utils_2.toString)(scope), '/', (0, utils_2.toString)(templateKey)),
method: 'DELETE',
headers: headersMap,
responseFormat: 'no_content',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return void 0;
}
}
exports.FolderMetadataManager = FolderMetadataManager;
function serializeGetFolderMetadataByIdScope(val) {
return val;
}
function deserializeGetFolderMetadataByIdScope(val) {
if (val == 'global') {
return val;
}
if (val == 'enterprise') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize GetFolderMetadataByIdScope",
});
}
function serializeCreateFolderMetadataByIdScope(val) {
return val;
}
function deserializeCreateFolderMetadataByIdScope(val) {
if (val == 'global') {
return val;
}
if (val == 'enterprise') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize CreateFolderMetadataByIdScope",
});
}
function serializeCreateFolderMetadataByIdRequestBody(val) {
return Object.fromEntries(Object.entries(val).map(([k, v]) => [
k,
(function (v) {
return v;
})(v),
]));
}
function deserializeCreateFolderMetadataByIdRequestBody(val) {
return (0, json_2.sdIsMap)(val)
? Object.fromEntries(Object.entries(val).map(([k, v]) => [
k,
(function (v) {
return v;
})(v),
]))
: {};
}
function serializeUpdateFolderMetadataByIdScope(val) {
return val;
}
function deserializeUpdateFolderMetadataByIdScope(val) {
if (val == 'global') {
return val;
}
if (val == 'enterprise') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize UpdateFolderMetadataByIdScope",
});
}
function serializeUpdateFolderMetadataByIdRequestBodyOpField(val) {
return val;
}
function deserializeUpdateFolderMetadataByIdRequestBodyOpField(val) {
if (val == 'add') {
return val;
}
if (val == 'replace') {
return val;
}
if (val == 'remove') {
return val;
}
if (val == 'test') {
return val;
}
if (val == 'move') {
return val;
}
if (val == 'copy') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize UpdateFolderMetadataByIdRequestBodyOpField",
});
}
function serializeUpdateFolderMetadataByIdRequestBody(val) {
return {
['op']: val.op == void 0
? val.op
: serializeUpdateFolderMetadataByIdRequestBodyOpField(val.op),
['path']: val.path,
['value']: val.value == void 0
? val.value
: (0, metadataInstanceValue_1.serializeMetadataInstanceValue)(val.value),
['from']: val.from,
};
}
function deserializeUpdateFolderMetadataByIdRequestBody(val) {
if (!(0, json_2.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "UpdateFolderMetadataByIdRequestBody"',
});
}
const op = val.op == void 0
? void 0
: deserializeUpdateFolderMetadataByIdRequestBodyOpField(val.op);
if (!(val.path == void 0) && !(0, json_1.sdIsString)(val.path)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "path" of type "UpdateFolderMetadataByIdRequestBody"',
});
}
const path = val.path == void 0 ? void 0 : val.path;
const value = val.value == void 0 ? void 0 : (0, metadataInstanceValue_2.deserializeMetadataInstanceValue)(val.value);
if (!(val.from == void 0) && !(0, json_1.sdIsString)(val.from)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "from" of type "UpdateFolderMetadataByIdRequestBody"',
});
}
const from = val.from == void 0 ? void 0 : val.from;
return {
op: op,
path: path,
value: value,
from: from,
};
}
function serializeDeleteFolderMetadataByIdScope(val) {
return val;
}
function deserializeDeleteFolderMetadataByIdScope(val) {
if (val == 'global') {
return val;
}
if (val == 'enterprise') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize DeleteFolderMetadataByIdScope",
});
}
//# sourceMappingURL=folderMetadata.js.map