box-node-sdk
Version:
Official SDK for Box Platform APIs
405 lines • 17.7 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.LegalHoldPoliciesManager = exports.DeleteLegalHoldPolicyByIdHeaders = exports.UpdateLegalHoldPolicyByIdHeaders = exports.GetLegalHoldPolicyByIdHeaders = exports.CreateLegalHoldPolicyHeaders = exports.GetLegalHoldPoliciesHeaders = exports.DeleteLegalHoldPolicyByIdOptionals = exports.UpdateLegalHoldPolicyByIdOptionals = exports.GetLegalHoldPolicyByIdOptionals = exports.CreateLegalHoldPolicyOptionals = void 0;
exports.serializeCreateLegalHoldPolicyRequestBody = serializeCreateLegalHoldPolicyRequestBody;
exports.deserializeCreateLegalHoldPolicyRequestBody = deserializeCreateLegalHoldPolicyRequestBody;
exports.serializeUpdateLegalHoldPolicyByIdRequestBody = serializeUpdateLegalHoldPolicyByIdRequestBody;
exports.deserializeUpdateLegalHoldPolicyByIdRequestBody = deserializeUpdateLegalHoldPolicyByIdRequestBody;
const legalHoldPolicies_1 = require("../schemas/legalHoldPolicies");
const legalHoldPolicy_1 = require("../schemas/legalHoldPolicy");
const utils_1 = require("../internal/utils");
const utils_2 = require("../internal/utils");
const errors_1 = require("../box/errors");
const network_1 = require("../networking/network");
const fetchOptions_1 = require("../networking/fetchOptions");
const utils_3 = require("../internal/utils");
const utils_4 = require("../internal/utils");
const json_1 = require("../serialization/json");
const json_2 = require("../serialization/json");
const json_3 = require("../serialization/json");
class CreateLegalHoldPolicyOptionals {
headers = new CreateLegalHoldPolicyHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.CreateLegalHoldPolicyOptionals = CreateLegalHoldPolicyOptionals;
class GetLegalHoldPolicyByIdOptionals {
headers = new GetLegalHoldPolicyByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetLegalHoldPolicyByIdOptionals = GetLegalHoldPolicyByIdOptionals;
class UpdateLegalHoldPolicyByIdOptionals {
requestBody = {};
headers = new UpdateLegalHoldPolicyByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.requestBody !== undefined) {
this.requestBody = fields.requestBody;
}
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.UpdateLegalHoldPolicyByIdOptionals = UpdateLegalHoldPolicyByIdOptionals;
class DeleteLegalHoldPolicyByIdOptionals {
headers = new DeleteLegalHoldPolicyByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.DeleteLegalHoldPolicyByIdOptionals = DeleteLegalHoldPolicyByIdOptionals;
class GetLegalHoldPoliciesHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetLegalHoldPoliciesHeaders = GetLegalHoldPoliciesHeaders;
class CreateLegalHoldPolicyHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.CreateLegalHoldPolicyHeaders = CreateLegalHoldPolicyHeaders;
class GetLegalHoldPolicyByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetLegalHoldPolicyByIdHeaders = GetLegalHoldPolicyByIdHeaders;
class UpdateLegalHoldPolicyByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.UpdateLegalHoldPolicyByIdHeaders = UpdateLegalHoldPolicyByIdHeaders;
class DeleteLegalHoldPolicyByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.DeleteLegalHoldPolicyByIdHeaders = DeleteLegalHoldPolicyByIdHeaders;
class LegalHoldPoliciesManager {
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 legal hold policies that belong to
* an enterprise.
* @param {GetLegalHoldPoliciesQueryParams} queryParams Query parameters of getLegalHoldPolicies method
* @param {GetLegalHoldPoliciesHeadersInput} headersInput Headers of getLegalHoldPolicies method
* @param {CancellationToken} cancellationToken Token used for request cancellation.
* @returns {Promise<LegalHoldPolicies>}
*/
async getLegalHoldPolicies(queryParams = {}, headersInput = new GetLegalHoldPoliciesHeaders({}), cancellationToken) {
const headers = new GetLegalHoldPoliciesHeaders({
extraHeaders: headersInput.extraHeaders,
});
const queryParamsMap = (0, utils_3.prepareParams)({
['policy_name']: (0, utils_4.toString)(queryParams.policyName),
['fields']: queryParams.fields
? queryParams.fields.map(utils_4.toString).join(',')
: undefined,
['marker']: (0, utils_4.toString)(queryParams.marker),
['limit']: (0, utils_4.toString)(queryParams.limit),
});
const headersMap = (0, utils_3.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/legal_hold_policies'),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, legalHoldPolicies_1.deserializeLegalHoldPolicies)(response.data),
rawData: response.data,
};
}
/**
* Create a new legal hold policy.
* @param {CreateLegalHoldPolicyRequestBody} requestBody Request body of createLegalHoldPolicy method
* @param {CreateLegalHoldPolicyOptionalsInput} optionalsInput
* @returns {Promise<LegalHoldPolicy>}
*/
async createLegalHoldPolicy(requestBody, optionalsInput = {}) {
const optionals = new CreateLegalHoldPolicyOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_3.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/legal_hold_policies'),
method: 'POST',
headers: headersMap,
data: serializeCreateLegalHoldPolicyRequestBody(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, legalHoldPolicy_1.deserializeLegalHoldPolicy)(response.data),
rawData: response.data,
};
}
/**
* Retrieve a legal hold policy.
* @param {string} legalHoldPolicyId The ID of the legal hold policy.
Example: "324432"
* @param {GetLegalHoldPolicyByIdOptionalsInput} optionalsInput
* @returns {Promise<LegalHoldPolicy>}
*/
async getLegalHoldPolicyById(legalHoldPolicyId, optionalsInput = {}) {
const optionals = new GetLegalHoldPolicyByIdOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_3.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/legal_hold_policies/', (0, utils_4.toString)(legalHoldPolicyId)),
method: 'GET',
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, legalHoldPolicy_1.deserializeLegalHoldPolicy)(response.data),
rawData: response.data,
};
}
/**
* Update legal hold policy.
* @param {string} legalHoldPolicyId The ID of the legal hold policy.
Example: "324432"
* @param {UpdateLegalHoldPolicyByIdOptionalsInput} optionalsInput
* @returns {Promise<LegalHoldPolicy>}
*/
async updateLegalHoldPolicyById(legalHoldPolicyId, optionalsInput = {}) {
const optionals = new UpdateLegalHoldPolicyByIdOptionals({
requestBody: optionalsInput.requestBody,
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const requestBody = optionals.requestBody;
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_3.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/legal_hold_policies/', (0, utils_4.toString)(legalHoldPolicyId)),
method: 'PUT',
headers: headersMap,
data: serializeUpdateLegalHoldPolicyByIdRequestBody(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, legalHoldPolicy_1.deserializeLegalHoldPolicy)(response.data),
rawData: response.data,
};
}
/**
* Delete an existing legal hold policy.
*
* This is an asynchronous process. The policy will not be
* fully deleted yet when the response returns.
* @param {string} legalHoldPolicyId The ID of the legal hold policy.
Example: "324432"
* @param {DeleteLegalHoldPolicyByIdOptionalsInput} optionalsInput
* @returns {Promise<undefined>}
*/
async deleteLegalHoldPolicyById(legalHoldPolicyId, optionalsInput = {}) {
const optionals = new DeleteLegalHoldPolicyByIdOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_3.prepareParams)({ ...{}, ...headers.extraHeaders });
const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/legal_hold_policies/', (0, utils_4.toString)(legalHoldPolicyId)),
method: 'DELETE',
headers: headersMap,
responseFormat: 'no_content',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return void 0;
}
}
exports.LegalHoldPoliciesManager = LegalHoldPoliciesManager;
function serializeCreateLegalHoldPolicyRequestBody(val) {
return {
['policy_name']: val.policyName,
['description']: val.description,
['filter_started_at']: val.filterStartedAt == void 0
? val.filterStartedAt
: (0, utils_1.serializeDateTime)(val.filterStartedAt),
['filter_ended_at']: val.filterEndedAt == void 0
? val.filterEndedAt
: (0, utils_1.serializeDateTime)(val.filterEndedAt),
['is_ongoing']: val.isOngoing,
};
}
function deserializeCreateLegalHoldPolicyRequestBody(val) {
if (!(0, json_3.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "CreateLegalHoldPolicyRequestBody"',
});
}
if (val.policy_name == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "policy_name" of type "CreateLegalHoldPolicyRequestBody" to be defined',
});
}
if (!(0, json_2.sdIsString)(val.policy_name)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "policy_name" of type "CreateLegalHoldPolicyRequestBody"',
});
}
const policyName = val.policy_name;
if (!(val.description == void 0) && !(0, json_2.sdIsString)(val.description)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "description" of type "CreateLegalHoldPolicyRequestBody"',
});
}
const description = val.description == void 0 ? void 0 : val.description;
if (!(val.filter_started_at == void 0) &&
!(0, json_2.sdIsString)(val.filter_started_at)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "filter_started_at" of type "CreateLegalHoldPolicyRequestBody"',
});
}
const filterStartedAt = val.filter_started_at == void 0
? void 0
: (0, utils_2.deserializeDateTime)(val.filter_started_at);
if (!(val.filter_ended_at == void 0) && !(0, json_2.sdIsString)(val.filter_ended_at)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "filter_ended_at" of type "CreateLegalHoldPolicyRequestBody"',
});
}
const filterEndedAt = val.filter_ended_at == void 0
? void 0
: (0, utils_2.deserializeDateTime)(val.filter_ended_at);
if (!(val.is_ongoing == void 0) && !(0, json_1.sdIsBoolean)(val.is_ongoing)) {
throw new errors_1.BoxSdkError({
message: 'Expecting boolean for "is_ongoing" of type "CreateLegalHoldPolicyRequestBody"',
});
}
const isOngoing = val.is_ongoing == void 0 ? void 0 : val.is_ongoing;
return {
policyName: policyName,
description: description,
filterStartedAt: filterStartedAt,
filterEndedAt: filterEndedAt,
isOngoing: isOngoing,
};
}
function serializeUpdateLegalHoldPolicyByIdRequestBody(val) {
return {
['policy_name']: val.policyName,
['description']: val.description,
['release_notes']: val.releaseNotes,
};
}
function deserializeUpdateLegalHoldPolicyByIdRequestBody(val) {
if (!(0, json_3.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "UpdateLegalHoldPolicyByIdRequestBody"',
});
}
if (!(val.policy_name == void 0) && !(0, json_2.sdIsString)(val.policy_name)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "policy_name" of type "UpdateLegalHoldPolicyByIdRequestBody"',
});
}
const policyName = val.policy_name == void 0 ? void 0 : val.policy_name;
if (!(val.description == void 0) && !(0, json_2.sdIsString)(val.description)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "description" of type "UpdateLegalHoldPolicyByIdRequestBody"',
});
}
const description = val.description == void 0 ? void 0 : val.description;
if (!(val.release_notes == void 0) && !(0, json_2.sdIsString)(val.release_notes)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "release_notes" of type "UpdateLegalHoldPolicyByIdRequestBody"',
});
}
const releaseNotes = val.release_notes == void 0 ? void 0 : val.release_notes;
return {
policyName: policyName,
description: description,
releaseNotes: releaseNotes,
};
}
//# sourceMappingURL=legalHoldPolicies.js.map