box-node-sdk
Version:
Official SDK for Box Platform APIs
466 lines • 21 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.LegalHoldPolicyAssignmentsManager = exports.GetLegalHoldPolicyAssignmentFileOnHoldHeaders = exports.DeleteLegalHoldPolicyAssignmentByIdHeaders = exports.GetLegalHoldPolicyAssignmentByIdHeaders = exports.CreateLegalHoldPolicyAssignmentHeaders = exports.GetLegalHoldPolicyAssignmentsHeaders = exports.GetLegalHoldPolicyAssignmentFileOnHoldOptionals = exports.DeleteLegalHoldPolicyAssignmentByIdOptionals = exports.GetLegalHoldPolicyAssignmentByIdOptionals = exports.CreateLegalHoldPolicyAssignmentOptionals = exports.GetLegalHoldPolicyAssignmentsOptionals = void 0;
exports.serializeGetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField = serializeGetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField;
exports.deserializeGetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField = deserializeGetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField;
exports.serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField = serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField;
exports.deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField = deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField;
exports.serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField = serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField;
exports.deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField = deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField;
exports.serializeCreateLegalHoldPolicyAssignmentRequestBody = serializeCreateLegalHoldPolicyAssignmentRequestBody;
exports.deserializeCreateLegalHoldPolicyAssignmentRequestBody = deserializeCreateLegalHoldPolicyAssignmentRequestBody;
const legalHoldPolicyAssignments_1 = require("../schemas/legalHoldPolicyAssignments");
const legalHoldPolicyAssignment_1 = require("../schemas/legalHoldPolicyAssignment");
const filesOnHold_1 = require("../schemas/filesOnHold");
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 GetLegalHoldPolicyAssignmentsOptionals {
headers = new GetLegalHoldPolicyAssignmentsHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetLegalHoldPolicyAssignmentsOptionals = GetLegalHoldPolicyAssignmentsOptionals;
class CreateLegalHoldPolicyAssignmentOptionals {
headers = new CreateLegalHoldPolicyAssignmentHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.CreateLegalHoldPolicyAssignmentOptionals = CreateLegalHoldPolicyAssignmentOptionals;
class GetLegalHoldPolicyAssignmentByIdOptionals {
headers = new GetLegalHoldPolicyAssignmentByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetLegalHoldPolicyAssignmentByIdOptionals = GetLegalHoldPolicyAssignmentByIdOptionals;
class DeleteLegalHoldPolicyAssignmentByIdOptionals {
headers = new DeleteLegalHoldPolicyAssignmentByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.DeleteLegalHoldPolicyAssignmentByIdOptionals = DeleteLegalHoldPolicyAssignmentByIdOptionals;
class GetLegalHoldPolicyAssignmentFileOnHoldOptionals {
queryParams = {};
headers = new GetLegalHoldPolicyAssignmentFileOnHoldHeaders({});
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.GetLegalHoldPolicyAssignmentFileOnHoldOptionals = GetLegalHoldPolicyAssignmentFileOnHoldOptionals;
class GetLegalHoldPolicyAssignmentsHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetLegalHoldPolicyAssignmentsHeaders = GetLegalHoldPolicyAssignmentsHeaders;
class CreateLegalHoldPolicyAssignmentHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.CreateLegalHoldPolicyAssignmentHeaders = CreateLegalHoldPolicyAssignmentHeaders;
class GetLegalHoldPolicyAssignmentByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetLegalHoldPolicyAssignmentByIdHeaders = GetLegalHoldPolicyAssignmentByIdHeaders;
class DeleteLegalHoldPolicyAssignmentByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.DeleteLegalHoldPolicyAssignmentByIdHeaders = DeleteLegalHoldPolicyAssignmentByIdHeaders;
class GetLegalHoldPolicyAssignmentFileOnHoldHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetLegalHoldPolicyAssignmentFileOnHoldHeaders = GetLegalHoldPolicyAssignmentFileOnHoldHeaders;
class LegalHoldPolicyAssignmentsManager {
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 items a legal hold policy has been assigned to.
* @param {GetLegalHoldPolicyAssignmentsQueryParams} queryParams Query parameters of getLegalHoldPolicyAssignments method
* @param {GetLegalHoldPolicyAssignmentsOptionalsInput} optionalsInput
* @returns {Promise<LegalHoldPolicyAssignments>}
*/
async getLegalHoldPolicyAssignments(queryParams, optionalsInput = {}) {
const optionals = new GetLegalHoldPolicyAssignmentsOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const queryParamsMap = (0, utils_1.prepareParams)({
['policy_id']: (0, utils_2.toString)(queryParams.policyId),
['assign_to_type']: (0, utils_2.toString)(queryParams.assignToType),
['assign_to_id']: (0, utils_2.toString)(queryParams.assignToId),
['marker']: (0, utils_2.toString)(queryParams.marker),
['limit']: (0, utils_2.toString)(queryParams.limit),
['fields']: queryParams.fields
? queryParams.fields.map(utils_2.toString).join(',')
: undefined,
});
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/legal_hold_policy_assignments'),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, legalHoldPolicyAssignments_1.deserializeLegalHoldPolicyAssignments)(response.data),
rawData: response.data,
};
}
/**
* Assign a legal hold to a file, file version, folder, or user.
* @param {CreateLegalHoldPolicyAssignmentRequestBody} requestBody Request body of createLegalHoldPolicyAssignment method
* @param {CreateLegalHoldPolicyAssignmentOptionalsInput} optionalsInput
* @returns {Promise<LegalHoldPolicyAssignment>}
*/
async createLegalHoldPolicyAssignment(requestBody, optionalsInput = {}) {
const optionals = new CreateLegalHoldPolicyAssignmentOptionals({
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/legal_hold_policy_assignments'),
method: 'POST',
headers: headersMap,
data: serializeCreateLegalHoldPolicyAssignmentRequestBody(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, legalHoldPolicyAssignment_1.deserializeLegalHoldPolicyAssignment)(response.data),
rawData: response.data,
};
}
/**
* Retrieve a legal hold policy assignment.
* @param {string} legalHoldPolicyAssignmentId The ID of the legal hold policy assignment.
Example: "753465"
* @param {GetLegalHoldPolicyAssignmentByIdOptionalsInput} optionalsInput
* @returns {Promise<LegalHoldPolicyAssignment>}
*/
async getLegalHoldPolicyAssignmentById(legalHoldPolicyAssignmentId, optionalsInput = {}) {
const optionals = new GetLegalHoldPolicyAssignmentByIdOptionals({
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/legal_hold_policy_assignments/', (0, utils_2.toString)(legalHoldPolicyAssignmentId)),
method: 'GET',
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, legalHoldPolicyAssignment_1.deserializeLegalHoldPolicyAssignment)(response.data),
rawData: response.data,
};
}
/**
* Remove a legal hold from an item.
*
* This is an asynchronous process. The policy will not be
* fully removed yet when the response returns.
* @param {string} legalHoldPolicyAssignmentId The ID of the legal hold policy assignment.
Example: "753465"
* @param {DeleteLegalHoldPolicyAssignmentByIdOptionalsInput} optionalsInput
* @returns {Promise<undefined>}
*/
async deleteLegalHoldPolicyAssignmentById(legalHoldPolicyAssignmentId, optionalsInput = {}) {
const optionals = new DeleteLegalHoldPolicyAssignmentByIdOptionals({
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/legal_hold_policy_assignments/', (0, utils_2.toString)(legalHoldPolicyAssignmentId)),
method: 'DELETE',
headers: headersMap,
responseFormat: 'no_content',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return void 0;
}
/**
* Get a list of files with current file versions for a legal hold
* assignment.
*
* In some cases you may want to get previous file versions instead. In these
* cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold`
* API instead to return any previous versions of a file for this legal hold
* policy assignment.
*
* Due to ongoing re-architecture efforts this API might not return all file
* versions held for this policy ID. Instead, this API will only return the
* latest file version held in the newly developed architecture. The `GET
* /file_version_legal_holds` API can be used to fetch current and past versions
* of files held within the legacy architecture.
*
* This endpoint does not support returning any content that is on hold due to
* a Custodian collaborating on a Hub.
*
* The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to
* find a list of policy assignments for a given policy ID.
* @param {string} legalHoldPolicyAssignmentId The ID of the legal hold policy assignment.
Example: "753465"
* @param {GetLegalHoldPolicyAssignmentFileOnHoldOptionalsInput} optionalsInput
* @returns {Promise<FilesOnHold>}
*/
async getLegalHoldPolicyAssignmentFileOnHold(legalHoldPolicyAssignmentId, optionalsInput = {}) {
const optionals = new GetLegalHoldPolicyAssignmentFileOnHoldOptionals({
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),
['fields']: queryParams.fields
? queryParams.fields.map(utils_2.toString).join(',')
: undefined,
});
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/legal_hold_policy_assignments/', (0, utils_2.toString)(legalHoldPolicyAssignmentId), '/files_on_hold'),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, filesOnHold_1.deserializeFilesOnHold)(response.data),
rawData: response.data,
};
}
}
exports.LegalHoldPolicyAssignmentsManager = LegalHoldPolicyAssignmentsManager;
function serializeGetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField(val) {
return val;
}
function deserializeGetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField(val) {
if (val == 'file') {
return val;
}
if (val == 'file_version') {
return val;
}
if (val == 'folder') {
return val;
}
if (val == 'user') {
return val;
}
if (val == 'ownership') {
return val;
}
if (val == 'interactions') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField",
});
}
function serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField(val) {
return val;
}
function deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField(val) {
if (val == 'file') {
return val;
}
if (val == 'file_version') {
return val;
}
if (val == 'folder') {
return val;
}
if (val == 'user') {
return val;
}
if (val == 'ownership') {
return val;
}
if (val == 'interaction') {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize CreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField",
});
}
function serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField(val) {
return {
['type']: serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField(val.type),
['id']: val.id,
};
}
function deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField(val) {
if (!(0, json_2.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "CreateLegalHoldPolicyAssignmentRequestBodyAssignToField"',
});
}
if (val.type == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "type" of type "CreateLegalHoldPolicyAssignmentRequestBodyAssignToField" to be defined',
});
}
const type = deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField(val.type);
if (val.id == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "id" of type "CreateLegalHoldPolicyAssignmentRequestBodyAssignToField" to be defined',
});
}
if (!(0, json_1.sdIsString)(val.id)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "id" of type "CreateLegalHoldPolicyAssignmentRequestBodyAssignToField"',
});
}
const id = val.id;
return {
type: type,
id: id,
};
}
function serializeCreateLegalHoldPolicyAssignmentRequestBody(val) {
return {
['policy_id']: val.policyId,
['assign_to']: serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField(val.assignTo),
};
}
function deserializeCreateLegalHoldPolicyAssignmentRequestBody(val) {
if (!(0, json_2.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "CreateLegalHoldPolicyAssignmentRequestBody"',
});
}
if (val.policy_id == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "policy_id" of type "CreateLegalHoldPolicyAssignmentRequestBody" to be defined',
});
}
if (!(0, json_1.sdIsString)(val.policy_id)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "policy_id" of type "CreateLegalHoldPolicyAssignmentRequestBody"',
});
}
const policyId = val.policy_id;
if (val.assign_to == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "assign_to" of type "CreateLegalHoldPolicyAssignmentRequestBody" to be defined',
});
}
const assignTo = deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField(val.assign_to);
return {
policyId: policyId,
assignTo: assignTo,
};
}
//# sourceMappingURL=legalHoldPolicyAssignments.js.map