box-node-sdk
Version:
Official SDK for Box Platform APIs
154 lines • 6.93 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.FileVersionLegalHoldsManager = exports.GetFileVersionLegalHoldsHeaders = exports.GetFileVersionLegalHoldByIdHeaders = exports.GetFileVersionLegalHoldsOptionals = exports.GetFileVersionLegalHoldByIdOptionals = void 0;
const fileVersionLegalHold_1 = require("../schemas/fileVersionLegalHold");
const fileVersionLegalHolds_1 = require("../schemas/fileVersionLegalHolds");
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 GetFileVersionLegalHoldByIdOptionals {
headers = new GetFileVersionLegalHoldByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetFileVersionLegalHoldByIdOptionals = GetFileVersionLegalHoldByIdOptionals;
class GetFileVersionLegalHoldsOptionals {
headers = new GetFileVersionLegalHoldsHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetFileVersionLegalHoldsOptionals = GetFileVersionLegalHoldsOptionals;
class GetFileVersionLegalHoldByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetFileVersionLegalHoldByIdHeaders = GetFileVersionLegalHoldByIdHeaders;
class GetFileVersionLegalHoldsHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetFileVersionLegalHoldsHeaders = GetFileVersionLegalHoldsHeaders;
class FileVersionLegalHoldsManager {
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 information about the legal hold policies
* assigned to a file version.
* @param {string} fileVersionLegalHoldId The ID of the file version legal hold.
Example: "2348213"
* @param {GetFileVersionLegalHoldByIdOptionalsInput} optionalsInput
* @returns {Promise<FileVersionLegalHold>}
*/
async getFileVersionLegalHoldById(fileVersionLegalHoldId, optionalsInput = {}) {
const optionals = new GetFileVersionLegalHoldByIdOptionals({
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/file_version_legal_holds/', (0, utils_2.toString)(fileVersionLegalHoldId)),
method: 'GET',
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, fileVersionLegalHold_1.deserializeFileVersionLegalHold)(response.data),
rawData: response.data,
};
}
/**
* Get a list of file versions on legal hold for a legal hold
* assignment.
*
* Due to ongoing re-architecture efforts this API might not return all file
* versions for this policy ID.
*
* Instead, this API will only return file versions held in the legacy
* architecture. Two new endpoints will available to request any file versions
* held in the new architecture.
*
* For file versions held in the new architecture, the `GET
* /legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to
* return all past file versions available for this policy assignment, and the
* `GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to
* return any current (latest) versions of a file under legal hold.
*
* 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.
*
* Once the re-architecture is completed this API will be deprecated.
* @param {GetFileVersionLegalHoldsQueryParams} queryParams Query parameters of getFileVersionLegalHolds method
* @param {GetFileVersionLegalHoldsOptionalsInput} optionalsInput
* @returns {Promise<FileVersionLegalHolds>}
*/
async getFileVersionLegalHolds(queryParams, optionalsInput = {}) {
const optionals = new GetFileVersionLegalHoldsOptionals({
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),
['marker']: (0, utils_2.toString)(queryParams.marker),
['limit']: (0, utils_2.toString)(queryParams.limit),
});
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/file_version_legal_holds'),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, fileVersionLegalHolds_1.deserializeFileVersionLegalHolds)(response.data),
rawData: response.data,
};
}
}
exports.FileVersionLegalHoldsManager = FileVersionLegalHoldsManager;
//# sourceMappingURL=fileVersionLegalHolds.js.map