box-node-sdk
Version:
Official SDK for Box Platform APIs
275 lines (271 loc) • 13.2 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.FileRequestsManager = exports.CreateFileRequestCopyHeaders = exports.DeleteFileRequestByIdHeaders = exports.UpdateFileRequestByIdHeaders = exports.GetFileRequestByIdHeaders = exports.CreateFileRequestCopyOptionals = exports.DeleteFileRequestByIdOptionals = exports.UpdateFileRequestByIdOptionals = exports.GetFileRequestByIdOptionals = void 0;
const fileRequest_1 = require("../schemas/fileRequest");
const fileRequestUpdateRequest_1 = require("../schemas/fileRequestUpdateRequest");
const fileRequestCopyRequest_1 = require("../schemas/fileRequestCopyRequest");
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 GetFileRequestByIdOptionals {
constructor(fields) {
this.headers = new GetFileRequestByIdHeaders({});
this.cancellationToken = void 0;
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.GetFileRequestByIdOptionals = GetFileRequestByIdOptionals;
class UpdateFileRequestByIdOptionals {
constructor(fields) {
this.headers = new UpdateFileRequestByIdHeaders({});
this.cancellationToken = void 0;
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.UpdateFileRequestByIdOptionals = UpdateFileRequestByIdOptionals;
class DeleteFileRequestByIdOptionals {
constructor(fields) {
this.headers = new DeleteFileRequestByIdHeaders({});
this.cancellationToken = void 0;
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.DeleteFileRequestByIdOptionals = DeleteFileRequestByIdOptionals;
class CreateFileRequestCopyOptionals {
constructor(fields) {
this.headers = new CreateFileRequestCopyHeaders({});
this.cancellationToken = void 0;
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.CreateFileRequestCopyOptionals = CreateFileRequestCopyOptionals;
class GetFileRequestByIdHeaders {
constructor(fields) {
/**
* Extra headers that will be included in the HTTP request. */
this.extraHeaders = {};
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetFileRequestByIdHeaders = GetFileRequestByIdHeaders;
class UpdateFileRequestByIdHeaders {
constructor(fields) {
/**
* Extra headers that will be included in the HTTP request. */
this.extraHeaders = {};
if (fields.ifMatch !== undefined) {
this.ifMatch = fields.ifMatch;
}
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.UpdateFileRequestByIdHeaders = UpdateFileRequestByIdHeaders;
class DeleteFileRequestByIdHeaders {
constructor(fields) {
/**
* Extra headers that will be included in the HTTP request. */
this.extraHeaders = {};
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.DeleteFileRequestByIdHeaders = DeleteFileRequestByIdHeaders;
class CreateFileRequestCopyHeaders {
constructor(fields) {
/**
* Extra headers that will be included in the HTTP request. */
this.extraHeaders = {};
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.CreateFileRequestCopyHeaders = CreateFileRequestCopyHeaders;
class FileRequestsManager {
constructor(fields) {
this.networkSession = new network_1.NetworkSession({});
if (fields.auth !== undefined) {
this.auth = fields.auth;
}
if (fields.networkSession !== undefined) {
this.networkSession = fields.networkSession;
}
}
/**
* Retrieves the information about a file request.
* @param {string} fileRequestId The unique identifier that represent a file request.
The ID for any file request can be determined
by visiting a file request builder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/filerequest/123`
the `file_request_id` is `123`.
Example: "123"
* @param {GetFileRequestByIdOptionalsInput} optionalsInput
* @returns {Promise<FileRequest>}
*/
getFileRequestById(fileRequestId_1) {
return __awaiter(this, arguments, void 0, function* (fileRequestId, optionalsInput = {}) {
const optionals = new GetFileRequestByIdOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)(Object.assign({}, headers.extraHeaders));
const response = yield this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/file_requests/', (0, utils_2.toString)(fileRequestId)),
method: 'GET',
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return Object.assign(Object.assign({}, (0, fileRequest_1.deserializeFileRequest)(response.data)), { rawData: response.data });
});
}
/**
* Updates a file request. This can be used to activate or
* deactivate a file request.
* @param {string} fileRequestId The unique identifier that represent a file request.
The ID for any file request can be determined
by visiting a file request builder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/filerequest/123`
the `file_request_id` is `123`.
Example: "123"
* @param {FileRequestUpdateRequest} requestBody Request body of updateFileRequestById method
* @param {UpdateFileRequestByIdOptionalsInput} optionalsInput
* @returns {Promise<FileRequest>}
*/
updateFileRequestById(fileRequestId_1, requestBody_1) {
return __awaiter(this, arguments, void 0, function* (fileRequestId, requestBody, optionalsInput = {}) {
const optionals = new UpdateFileRequestByIdOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)(Object.assign({ ['if-match']: (0, utils_2.toString)(headers.ifMatch) }, headers.extraHeaders));
const response = yield this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/file_requests/', (0, utils_2.toString)(fileRequestId)),
method: 'PUT',
headers: headersMap,
data: (0, fileRequestUpdateRequest_1.serializeFileRequestUpdateRequest)(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return Object.assign(Object.assign({}, (0, fileRequest_1.deserializeFileRequest)(response.data)), { rawData: response.data });
});
}
/**
* Deletes a file request permanently.
* @param {string} fileRequestId The unique identifier that represent a file request.
The ID for any file request can be determined
by visiting a file request builder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/filerequest/123`
the `file_request_id` is `123`.
Example: "123"
* @param {DeleteFileRequestByIdOptionalsInput} optionalsInput
* @returns {Promise<undefined>}
*/
deleteFileRequestById(fileRequestId_1) {
return __awaiter(this, arguments, void 0, function* (fileRequestId, optionalsInput = {}) {
const optionals = new DeleteFileRequestByIdOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)(Object.assign({}, headers.extraHeaders));
const response = yield this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/file_requests/', (0, utils_2.toString)(fileRequestId)),
method: 'DELETE',
headers: headersMap,
responseFormat: 'no_content',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return void 0;
});
}
/**
* Copies an existing file request that is already present on one folder,
* and applies it to another folder.
* @param {string} fileRequestId The unique identifier that represent a file request.
The ID for any file request can be determined
by visiting a file request builder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/filerequest/123`
the `file_request_id` is `123`.
Example: "123"
* @param {FileRequestCopyRequest} requestBody Request body of createFileRequestCopy method
* @param {CreateFileRequestCopyOptionalsInput} optionalsInput
* @returns {Promise<FileRequest>}
*/
createFileRequestCopy(fileRequestId_1, requestBody_1) {
return __awaiter(this, arguments, void 0, function* (fileRequestId, requestBody, optionalsInput = {}) {
const optionals = new CreateFileRequestCopyOptionals({
headers: optionalsInput.headers,
cancellationToken: optionalsInput.cancellationToken,
});
const headers = optionals.headers;
const cancellationToken = optionals.cancellationToken;
const headersMap = (0, utils_1.prepareParams)(Object.assign({}, headers.extraHeaders));
const response = yield this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/file_requests/', (0, utils_2.toString)(fileRequestId), '/copy'),
method: 'POST',
headers: headersMap,
data: (0, fileRequestCopyRequest_1.serializeFileRequestCopyRequest)(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return Object.assign(Object.assign({}, (0, fileRequest_1.deserializeFileRequest)(response.data)), { rawData: response.data });
});
}
}
exports.FileRequestsManager = FileRequestsManager;
//# sourceMappingURL=fileRequests.js.map