box-node-sdk
Version:
Official SDK for Box Platform APIs
415 lines • 18.8 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.MetadataCascadePoliciesManager = exports.ApplyMetadataCascadePolicyHeaders = exports.DeleteMetadataCascadePolicyByIdHeaders = exports.GetMetadataCascadePolicyByIdHeaders = exports.CreateMetadataCascadePolicyHeaders = exports.GetMetadataCascadePoliciesHeaders = exports.ApplyMetadataCascadePolicyOptionals = exports.DeleteMetadataCascadePolicyByIdOptionals = exports.GetMetadataCascadePolicyByIdOptionals = exports.CreateMetadataCascadePolicyOptionals = exports.GetMetadataCascadePoliciesOptionals = void 0;
exports.serializeCreateMetadataCascadePolicyRequestBodyScopeField = serializeCreateMetadataCascadePolicyRequestBodyScopeField;
exports.deserializeCreateMetadataCascadePolicyRequestBodyScopeField = deserializeCreateMetadataCascadePolicyRequestBodyScopeField;
exports.serializeCreateMetadataCascadePolicyRequestBody = serializeCreateMetadataCascadePolicyRequestBody;
exports.deserializeCreateMetadataCascadePolicyRequestBody = deserializeCreateMetadataCascadePolicyRequestBody;
exports.serializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField = serializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField;
exports.deserializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField = deserializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField;
exports.serializeApplyMetadataCascadePolicyRequestBody = serializeApplyMetadataCascadePolicyRequestBody;
exports.deserializeApplyMetadataCascadePolicyRequestBody = deserializeApplyMetadataCascadePolicyRequestBody;
const metadataCascadePolicies_1 = require("../schemas/metadataCascadePolicies");
const metadataCascadePolicy_1 = require("../schemas/metadataCascadePolicy");
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 GetMetadataCascadePoliciesOptionals {
headers = new GetMetadataCascadePoliciesHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetMetadataCascadePoliciesOptionals = GetMetadataCascadePoliciesOptionals;
class CreateMetadataCascadePolicyOptionals {
headers = new CreateMetadataCascadePolicyHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.CreateMetadataCascadePolicyOptionals = CreateMetadataCascadePolicyOptionals;
class GetMetadataCascadePolicyByIdOptionals {
headers = new GetMetadataCascadePolicyByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetMetadataCascadePolicyByIdOptionals = GetMetadataCascadePolicyByIdOptionals;
class DeleteMetadataCascadePolicyByIdOptionals {
headers = new DeleteMetadataCascadePolicyByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.DeleteMetadataCascadePolicyByIdOptionals = DeleteMetadataCascadePolicyByIdOptionals;
class ApplyMetadataCascadePolicyOptionals {
headers = new ApplyMetadataCascadePolicyHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.ApplyMetadataCascadePolicyOptionals = ApplyMetadataCascadePolicyOptionals;
class GetMetadataCascadePoliciesHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetMetadataCascadePoliciesHeaders = GetMetadataCascadePoliciesHeaders;
class CreateMetadataCascadePolicyHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.CreateMetadataCascadePolicyHeaders = CreateMetadataCascadePolicyHeaders;
class GetMetadataCascadePolicyByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetMetadataCascadePolicyByIdHeaders = GetMetadataCascadePolicyByIdHeaders;
class DeleteMetadataCascadePolicyByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.DeleteMetadataCascadePolicyByIdHeaders = DeleteMetadataCascadePolicyByIdHeaders;
class ApplyMetadataCascadePolicyHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.ApplyMetadataCascadePolicyHeaders = ApplyMetadataCascadePolicyHeaders;
class MetadataCascadePoliciesManager {
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 a list of all the metadata cascade policies
* that are applied to a given folder. This can not be used on the root
* folder with ID `0`.
* @param {GetMetadataCascadePoliciesQueryParams} queryParams Query parameters of getMetadataCascadePolicies method
* @param {GetMetadataCascadePoliciesOptionalsInput} optionalsInput
* @returns {Promise<MetadataCascadePolicies>}
*/
async getMetadataCascadePolicies(queryParams, optionalsInput = {}) {
const optionals = new GetMetadataCascadePoliciesOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const queryParamsMap = (0, utils_1.prepareParams)({
['folder_id']: (0, utils_2.toString)(queryParams.folderId),
['owner_enterprise_id']: (0, utils_2.toString)(queryParams.ownerEnterpriseId),
['marker']: (0, utils_2.toString)(queryParams.marker),
['offset']: (0, utils_2.toString)(queryParams.offset),
});
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/metadata_cascade_policies'),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, metadataCascadePolicies_1.deserializeMetadataCascadePolicies)(response.data),
rawData: response.data,
};
}
/**
* Creates a new metadata cascade policy that applies a given
* metadata template to a given folder and automatically
* cascades it down to any files within that folder.
*
* In order for the policy to be applied a metadata instance must first
* be applied to the folder the policy is to be applied to.
* @param {CreateMetadataCascadePolicyRequestBody} requestBody Request body of createMetadataCascadePolicy method
* @param {CreateMetadataCascadePolicyOptionalsInput} optionalsInput
* @returns {Promise<MetadataCascadePolicy>}
*/
async createMetadataCascadePolicy(requestBody, optionalsInput = {}) {
const optionals = new CreateMetadataCascadePolicyOptionals({
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/metadata_cascade_policies'),
method: 'POST',
headers: headersMap,
data: serializeCreateMetadataCascadePolicyRequestBody(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, metadataCascadePolicy_1.deserializeMetadataCascadePolicy)(response.data),
rawData: response.data,
};
}
/**
* Retrieve a specific metadata cascade policy assigned to a folder.
* @param {string} metadataCascadePolicyId The ID of the metadata cascade policy.
Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"
* @param {GetMetadataCascadePolicyByIdOptionalsInput} optionalsInput
* @returns {Promise<MetadataCascadePolicy>}
*/
async getMetadataCascadePolicyById(metadataCascadePolicyId, optionalsInput = {}) {
const optionals = new GetMetadataCascadePolicyByIdOptionals({
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/metadata_cascade_policies/', (0, utils_2.toString)(metadataCascadePolicyId)),
method: 'GET',
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, metadataCascadePolicy_1.deserializeMetadataCascadePolicy)(response.data),
rawData: response.data,
};
}
/**
* Deletes a metadata cascade policy.
* @param {string} metadataCascadePolicyId The ID of the metadata cascade policy.
Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"
* @param {DeleteMetadataCascadePolicyByIdOptionalsInput} optionalsInput
* @returns {Promise<undefined>}
*/
async deleteMetadataCascadePolicyById(metadataCascadePolicyId, optionalsInput = {}) {
const optionals = new DeleteMetadataCascadePolicyByIdOptionals({
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/metadata_cascade_policies/', (0, utils_2.toString)(metadataCascadePolicyId)),
method: 'DELETE',
headers: headersMap,
responseFormat: 'no_content',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return void 0;
}
/**
* Force the metadata on a folder with a metadata cascade policy to be applied to
* all of its children. This can be used after creating a new cascade policy to
* enforce the metadata to be cascaded down to all existing files within that
* folder.
* @param {string} metadataCascadePolicyId The ID of the cascade policy to force-apply.
Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"
* @param {ApplyMetadataCascadePolicyRequestBody} requestBody Request body of applyMetadataCascadePolicy method
* @param {ApplyMetadataCascadePolicyOptionalsInput} optionalsInput
* @returns {Promise<undefined>}
*/
async applyMetadataCascadePolicy(metadataCascadePolicyId, requestBody, optionalsInput = {}) {
const optionals = new ApplyMetadataCascadePolicyOptionals({
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/metadata_cascade_policies/', (0, utils_2.toString)(metadataCascadePolicyId), '/apply'),
method: 'POST',
headers: headersMap,
data: serializeApplyMetadataCascadePolicyRequestBody(requestBody),
contentType: 'application/json',
responseFormat: 'no_content',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return void 0;
}
}
exports.MetadataCascadePoliciesManager = MetadataCascadePoliciesManager;
function serializeCreateMetadataCascadePolicyRequestBodyScopeField(val) {
return val;
}
function deserializeCreateMetadataCascadePolicyRequestBodyScopeField(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 CreateMetadataCascadePolicyRequestBodyScopeField",
});
}
function serializeCreateMetadataCascadePolicyRequestBody(val) {
return {
['folder_id']: val.folderId,
['scope']: serializeCreateMetadataCascadePolicyRequestBodyScopeField(val.scope),
['templateKey']: val.templateKey,
};
}
function deserializeCreateMetadataCascadePolicyRequestBody(val) {
if (!(0, json_2.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "CreateMetadataCascadePolicyRequestBody"',
});
}
if (val.folder_id == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "folder_id" of type "CreateMetadataCascadePolicyRequestBody" to be defined',
});
}
if (!(0, json_1.sdIsString)(val.folder_id)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "folder_id" of type "CreateMetadataCascadePolicyRequestBody"',
});
}
const folderId = val.folder_id;
if (val.scope == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "scope" of type "CreateMetadataCascadePolicyRequestBody" to be defined',
});
}
const scope = deserializeCreateMetadataCascadePolicyRequestBodyScopeField(val.scope);
if (val.templateKey == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "templateKey" of type "CreateMetadataCascadePolicyRequestBody" to be defined',
});
}
if (!(0, json_1.sdIsString)(val.templateKey)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "templateKey" of type "CreateMetadataCascadePolicyRequestBody"',
});
}
const templateKey = val.templateKey;
return {
folderId: folderId,
scope: scope,
templateKey: templateKey,
};
}
function serializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField(val) {
return val;
}
function deserializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField(val) {
if (val == 'none') {
return val;
}
if (val == 'overwrite') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize ApplyMetadataCascadePolicyRequestBodyConflictResolutionField",
});
}
function serializeApplyMetadataCascadePolicyRequestBody(val) {
return {
['conflict_resolution']: serializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField(val.conflictResolution),
};
}
function deserializeApplyMetadataCascadePolicyRequestBody(val) {
if (!(0, json_2.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "ApplyMetadataCascadePolicyRequestBody"',
});
}
if (val.conflict_resolution == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "conflict_resolution" of type "ApplyMetadataCascadePolicyRequestBody" to be defined',
});
}
const conflictResolution = deserializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField(val.conflict_resolution);
return {
conflictResolution: conflictResolution,
};
}
//# sourceMappingURL=metadataCascadePolicies.js.map