box-node-sdk
Version:
Official SDK for Box Platform APIs
267 lines • 11.3 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.TrashedWebLinksManager = exports.DeleteTrashedWebLinkByIdHeaders = exports.GetTrashedWebLinkByIdHeaders = exports.RestoreWeblinkFromTrashHeaders = exports.DeleteTrashedWebLinkByIdOptionals = exports.GetTrashedWebLinkByIdOptionals = exports.RestoreWeblinkFromTrashOptionals = void 0;
exports.serializeRestoreWeblinkFromTrashRequestBodyParentField = serializeRestoreWeblinkFromTrashRequestBodyParentField;
exports.deserializeRestoreWeblinkFromTrashRequestBodyParentField = deserializeRestoreWeblinkFromTrashRequestBodyParentField;
exports.serializeRestoreWeblinkFromTrashRequestBody = serializeRestoreWeblinkFromTrashRequestBody;
exports.deserializeRestoreWeblinkFromTrashRequestBody = deserializeRestoreWeblinkFromTrashRequestBody;
const trashWebLinkRestored_1 = require("../schemas/trashWebLinkRestored");
const trashWebLink_1 = require("../schemas/trashWebLink");
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 RestoreWeblinkFromTrashOptionals {
requestBody = {};
queryParams = {};
headers = new RestoreWeblinkFromTrashHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.requestBody !== undefined) {
this.requestBody = fields.requestBody;
}
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.RestoreWeblinkFromTrashOptionals = RestoreWeblinkFromTrashOptionals;
class GetTrashedWebLinkByIdOptionals {
queryParams = {};
headers = new GetTrashedWebLinkByIdHeaders({});
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.GetTrashedWebLinkByIdOptionals = GetTrashedWebLinkByIdOptionals;
class DeleteTrashedWebLinkByIdOptionals {
headers = new DeleteTrashedWebLinkByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.DeleteTrashedWebLinkByIdOptionals = DeleteTrashedWebLinkByIdOptionals;
class RestoreWeblinkFromTrashHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.RestoreWeblinkFromTrashHeaders = RestoreWeblinkFromTrashHeaders;
class GetTrashedWebLinkByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetTrashedWebLinkByIdHeaders = GetTrashedWebLinkByIdHeaders;
class DeleteTrashedWebLinkByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.DeleteTrashedWebLinkByIdHeaders = DeleteTrashedWebLinkByIdHeaders;
class TrashedWebLinksManager {
auth;
networkSession = new network_1.NetworkSession({});
constructor(fields) {
if (fields.auth !== undefined) {
this.auth = fields.auth;
}
if (fields.networkSession !== undefined) {
this.networkSession = fields.networkSession;
}
}
/**
* Restores a web link that has been moved to the trash.
*
* An optional new parent ID can be provided to restore the web link to in case
* the original folder has been deleted.
* @param {string} webLinkId The ID of the web link.
Example: "12345"
* @param {RestoreWeblinkFromTrashOptionalsInput} optionalsInput
* @returns {Promise<TrashWebLinkRestored>}
*/
async restoreWeblinkFromTrash(webLinkId, optionalsInput = {}) {
const optionals = new RestoreWeblinkFromTrashOptionals({
requestBody: optionalsInput.requestBody,
queryParams: optionalsInput.queryParams,
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const requestBody = optionals.requestBody;
const queryParams = optionals.queryParams;
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const queryParamsMap = (0, utils_1.prepareParams)({
['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/web_links/', (0, utils_2.toString)(webLinkId)),
method: 'POST',
params: queryParamsMap,
headers: headersMap,
data: serializeRestoreWeblinkFromTrashRequestBody(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, trashWebLinkRestored_1.deserializeTrashWebLinkRestored)(response.data),
rawData: response.data,
};
}
/**
* Retrieves a web link that has been moved to the trash.
* @param {string} webLinkId The ID of the web link.
Example: "12345"
* @param {GetTrashedWebLinkByIdOptionalsInput} optionalsInput
* @returns {Promise<TrashWebLink>}
*/
async getTrashedWebLinkById(webLinkId, optionalsInput = {}) {
const optionals = new GetTrashedWebLinkByIdOptionals({
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)({
['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/web_links/', (0, utils_2.toString)(webLinkId), '/trash'),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, trashWebLink_1.deserializeTrashWebLink)(response.data),
rawData: response.data,
};
}
/**
* Permanently deletes a web link that is in the trash.
* This action cannot be undone.
* @param {string} webLinkId The ID of the web link.
Example: "12345"
* @param {DeleteTrashedWebLinkByIdOptionalsInput} optionalsInput
* @returns {Promise<undefined>}
*/
async deleteTrashedWebLinkById(webLinkId, optionalsInput = {}) {
const optionals = new DeleteTrashedWebLinkByIdOptionals({
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/web_links/', (0, utils_2.toString)(webLinkId), '/trash'),
method: 'DELETE',
headers: headersMap,
responseFormat: 'no_content',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return void 0;
}
}
exports.TrashedWebLinksManager = TrashedWebLinksManager;
function serializeRestoreWeblinkFromTrashRequestBodyParentField(val) {
return { ['id']: val.id };
}
function deserializeRestoreWeblinkFromTrashRequestBodyParentField(val) {
if (!(0, json_2.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "RestoreWeblinkFromTrashRequestBodyParentField"',
});
}
if (!(val.id == void 0) && !(0, json_1.sdIsString)(val.id)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "id" of type "RestoreWeblinkFromTrashRequestBodyParentField"',
});
}
const id = val.id == void 0 ? void 0 : val.id;
return { id: id };
}
function serializeRestoreWeblinkFromTrashRequestBody(val) {
return {
['name']: val.name,
['parent']: val.parent == void 0
? val.parent
: serializeRestoreWeblinkFromTrashRequestBodyParentField(val.parent),
};
}
function deserializeRestoreWeblinkFromTrashRequestBody(val) {
if (!(0, json_2.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "RestoreWeblinkFromTrashRequestBody"',
});
}
if (!(val.name == void 0) && !(0, json_1.sdIsString)(val.name)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "name" of type "RestoreWeblinkFromTrashRequestBody"',
});
}
const name = val.name == void 0 ? void 0 : val.name;
const parent = val.parent == void 0
? void 0
: deserializeRestoreWeblinkFromTrashRequestBodyParentField(val.parent);
return {
name: name,
parent: parent,
};
}
//# sourceMappingURL=trashedWebLinks.js.map