UNPKG

box-node-sdk

Version:

Official SDK for Box Platform APIs

384 lines 20.3 kB
"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.ShieldInformationBarrierSegmentsManager = exports.CreateShieldInformationBarrierSegmentHeaders = exports.GetShieldInformationBarrierSegmentsHeaders = exports.UpdateShieldInformationBarrierSegmentByIdHeaders = exports.DeleteShieldInformationBarrierSegmentByIdHeaders = exports.GetShieldInformationBarrierSegmentByIdHeaders = exports.CreateShieldInformationBarrierSegmentOptionals = exports.GetShieldInformationBarrierSegmentsOptionals = exports.UpdateShieldInformationBarrierSegmentByIdOptionals = exports.DeleteShieldInformationBarrierSegmentByIdOptionals = exports.GetShieldInformationBarrierSegmentByIdOptionals = void 0; exports.serializeUpdateShieldInformationBarrierSegmentByIdRequestBody = serializeUpdateShieldInformationBarrierSegmentByIdRequestBody; exports.deserializeUpdateShieldInformationBarrierSegmentByIdRequestBody = deserializeUpdateShieldInformationBarrierSegmentByIdRequestBody; exports.serializeCreateShieldInformationBarrierSegmentRequestBody = serializeCreateShieldInformationBarrierSegmentRequestBody; exports.deserializeCreateShieldInformationBarrierSegmentRequestBody = deserializeCreateShieldInformationBarrierSegmentRequestBody; const shieldInformationBarrierSegment_1 = require("../schemas/shieldInformationBarrierSegment"); const shieldInformationBarrierSegments_1 = require("../schemas/shieldInformationBarrierSegments"); const shieldInformationBarrierBase_1 = require("../schemas/shieldInformationBarrierBase"); const shieldInformationBarrierBase_2 = require("../schemas/shieldInformationBarrierBase"); 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 GetShieldInformationBarrierSegmentByIdOptionals { constructor(fields) { this.headers = new GetShieldInformationBarrierSegmentByIdHeaders({}); this.cancellationToken = void 0; if (fields.headers !== undefined) { this.headers = fields.headers; } if (fields.cancellationToken !== undefined) { this.cancellationToken = fields.cancellationToken; } } } exports.GetShieldInformationBarrierSegmentByIdOptionals = GetShieldInformationBarrierSegmentByIdOptionals; class DeleteShieldInformationBarrierSegmentByIdOptionals { constructor(fields) { this.headers = new DeleteShieldInformationBarrierSegmentByIdHeaders({}); this.cancellationToken = void 0; if (fields.headers !== undefined) { this.headers = fields.headers; } if (fields.cancellationToken !== undefined) { this.cancellationToken = fields.cancellationToken; } } } exports.DeleteShieldInformationBarrierSegmentByIdOptionals = DeleteShieldInformationBarrierSegmentByIdOptionals; class UpdateShieldInformationBarrierSegmentByIdOptionals { constructor(fields) { this.requestBody = {}; this.headers = new UpdateShieldInformationBarrierSegmentByIdHeaders({}); this.cancellationToken = void 0; 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.UpdateShieldInformationBarrierSegmentByIdOptionals = UpdateShieldInformationBarrierSegmentByIdOptionals; class GetShieldInformationBarrierSegmentsOptionals { constructor(fields) { this.headers = new GetShieldInformationBarrierSegmentsHeaders({}); this.cancellationToken = void 0; if (fields.headers !== undefined) { this.headers = fields.headers; } if (fields.cancellationToken !== undefined) { this.cancellationToken = fields.cancellationToken; } } } exports.GetShieldInformationBarrierSegmentsOptionals = GetShieldInformationBarrierSegmentsOptionals; class CreateShieldInformationBarrierSegmentOptionals { constructor(fields) { this.headers = new CreateShieldInformationBarrierSegmentHeaders({}); this.cancellationToken = void 0; if (fields.headers !== undefined) { this.headers = fields.headers; } if (fields.cancellationToken !== undefined) { this.cancellationToken = fields.cancellationToken; } } } exports.CreateShieldInformationBarrierSegmentOptionals = CreateShieldInformationBarrierSegmentOptionals; class GetShieldInformationBarrierSegmentByIdHeaders { constructor(fields) { /** * Extra headers that will be included in the HTTP request. */ this.extraHeaders = {}; if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.GetShieldInformationBarrierSegmentByIdHeaders = GetShieldInformationBarrierSegmentByIdHeaders; class DeleteShieldInformationBarrierSegmentByIdHeaders { constructor(fields) { /** * Extra headers that will be included in the HTTP request. */ this.extraHeaders = {}; if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.DeleteShieldInformationBarrierSegmentByIdHeaders = DeleteShieldInformationBarrierSegmentByIdHeaders; class UpdateShieldInformationBarrierSegmentByIdHeaders { constructor(fields) { /** * Extra headers that will be included in the HTTP request. */ this.extraHeaders = {}; if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.UpdateShieldInformationBarrierSegmentByIdHeaders = UpdateShieldInformationBarrierSegmentByIdHeaders; class GetShieldInformationBarrierSegmentsHeaders { constructor(fields) { /** * Extra headers that will be included in the HTTP request. */ this.extraHeaders = {}; if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.GetShieldInformationBarrierSegmentsHeaders = GetShieldInformationBarrierSegmentsHeaders; class CreateShieldInformationBarrierSegmentHeaders { constructor(fields) { /** * Extra headers that will be included in the HTTP request. */ this.extraHeaders = {}; if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.CreateShieldInformationBarrierSegmentHeaders = CreateShieldInformationBarrierSegmentHeaders; class ShieldInformationBarrierSegmentsManager { 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 shield information barrier segment based on provided ID.. * @param {string} shieldInformationBarrierSegmentId The ID of the shield information barrier segment. Example: "3423" * @param {GetShieldInformationBarrierSegmentByIdOptionalsInput} optionalsInput * @returns {Promise<ShieldInformationBarrierSegment>} */ getShieldInformationBarrierSegmentById(shieldInformationBarrierSegmentId_1) { return __awaiter(this, arguments, void 0, function* (shieldInformationBarrierSegmentId, optionalsInput = {}) { const optionals = new GetShieldInformationBarrierSegmentByIdOptionals({ 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/shield_information_barrier_segments/', (0, utils_2.toString)(shieldInformationBarrierSegmentId)), method: 'GET', headers: headersMap, responseFormat: 'json', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return Object.assign(Object.assign({}, (0, shieldInformationBarrierSegment_1.deserializeShieldInformationBarrierSegment)(response.data)), { rawData: response.data }); }); } /** * Deletes the shield information barrier segment * based on provided ID. * @param {string} shieldInformationBarrierSegmentId The ID of the shield information barrier segment. Example: "3423" * @param {DeleteShieldInformationBarrierSegmentByIdOptionalsInput} optionalsInput * @returns {Promise<undefined>} */ deleteShieldInformationBarrierSegmentById(shieldInformationBarrierSegmentId_1) { return __awaiter(this, arguments, void 0, function* (shieldInformationBarrierSegmentId, optionalsInput = {}) { const optionals = new DeleteShieldInformationBarrierSegmentByIdOptionals({ 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/shield_information_barrier_segments/', (0, utils_2.toString)(shieldInformationBarrierSegmentId)), method: 'DELETE', headers: headersMap, responseFormat: 'no_content', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return void 0; }); } /** * Updates the shield information barrier segment based on provided ID.. * @param {string} shieldInformationBarrierSegmentId The ID of the shield information barrier segment. Example: "3423" * @param {UpdateShieldInformationBarrierSegmentByIdOptionalsInput} optionalsInput * @returns {Promise<ShieldInformationBarrierSegment>} */ updateShieldInformationBarrierSegmentById(shieldInformationBarrierSegmentId_1) { return __awaiter(this, arguments, void 0, function* (shieldInformationBarrierSegmentId, optionalsInput = {}) { const optionals = new UpdateShieldInformationBarrierSegmentByIdOptionals({ 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_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/shield_information_barrier_segments/', (0, utils_2.toString)(shieldInformationBarrierSegmentId)), method: 'PUT', headers: headersMap, data: serializeUpdateShieldInformationBarrierSegmentByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return Object.assign(Object.assign({}, (0, shieldInformationBarrierSegment_1.deserializeShieldInformationBarrierSegment)(response.data)), { rawData: response.data }); }); } /** * Retrieves a list of shield information barrier segment objects * for the specified Information Barrier ID. * @param {GetShieldInformationBarrierSegmentsQueryParams} queryParams Query parameters of getShieldInformationBarrierSegments method * @param {GetShieldInformationBarrierSegmentsOptionalsInput} optionalsInput * @returns {Promise<ShieldInformationBarrierSegments>} */ getShieldInformationBarrierSegments(queryParams_1) { return __awaiter(this, arguments, void 0, function* (queryParams, optionalsInput = {}) { const optionals = new GetShieldInformationBarrierSegmentsOptionals({ headers: optionalsInput.headers, cancellationToken: optionalsInput.cancellationToken, }); const headers = optionals.headers; const cancellationToken = optionals.cancellationToken; const queryParamsMap = (0, utils_1.prepareParams)({ ['shield_information_barrier_id']: (0, utils_2.toString)(queryParams.shieldInformationBarrierId), ['marker']: (0, utils_2.toString)(queryParams.marker), ['limit']: (0, utils_2.toString)(queryParams.limit), }); 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/shield_information_barrier_segments'), method: 'GET', params: queryParamsMap, headers: headersMap, responseFormat: 'json', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return Object.assign(Object.assign({}, (0, shieldInformationBarrierSegments_1.deserializeShieldInformationBarrierSegments)(response.data)), { rawData: response.data }); }); } /** * Creates a shield information barrier segment. * @param {CreateShieldInformationBarrierSegmentRequestBody} requestBody Request body of createShieldInformationBarrierSegment method * @param {CreateShieldInformationBarrierSegmentOptionalsInput} optionalsInput * @returns {Promise<ShieldInformationBarrierSegment>} */ createShieldInformationBarrierSegment(requestBody_1) { return __awaiter(this, arguments, void 0, function* (requestBody, optionalsInput = {}) { const optionals = new CreateShieldInformationBarrierSegmentOptionals({ 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/shield_information_barrier_segments'), method: 'POST', headers: headersMap, data: serializeCreateShieldInformationBarrierSegmentRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return Object.assign(Object.assign({}, (0, shieldInformationBarrierSegment_1.deserializeShieldInformationBarrierSegment)(response.data)), { rawData: response.data }); }); } } exports.ShieldInformationBarrierSegmentsManager = ShieldInformationBarrierSegmentsManager; function serializeUpdateShieldInformationBarrierSegmentByIdRequestBody(val) { return { ['name']: val.name, ['description']: val.description }; } function deserializeUpdateShieldInformationBarrierSegmentByIdRequestBody(val) { if (!(0, json_2.sdIsMap)(val)) { throw new errors_1.BoxSdkError({ message: 'Expecting a map for "UpdateShieldInformationBarrierSegmentByIdRequestBody"', }); } if (!(val.name == void 0) && !(0, json_1.sdIsString)(val.name)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "name" of type "UpdateShieldInformationBarrierSegmentByIdRequestBody"', }); } const name = val.name == void 0 ? void 0 : val.name; if (!(val.description == void 0) && !(0, json_1.sdIsString)(val.description)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "description" of type "UpdateShieldInformationBarrierSegmentByIdRequestBody"', }); } const description = val.description == void 0 ? void 0 : val.description; return { name: name, description: description, }; } function serializeCreateShieldInformationBarrierSegmentRequestBody(val) { return { ['shield_information_barrier']: (0, shieldInformationBarrierBase_1.serializeShieldInformationBarrierBase)(val.shieldInformationBarrier), ['name']: val.name, ['description']: val.description, }; } function deserializeCreateShieldInformationBarrierSegmentRequestBody(val) { if (!(0, json_2.sdIsMap)(val)) { throw new errors_1.BoxSdkError({ message: 'Expecting a map for "CreateShieldInformationBarrierSegmentRequestBody"', }); } if (val.shield_information_barrier == void 0) { throw new errors_1.BoxSdkError({ message: 'Expecting "shield_information_barrier" of type "CreateShieldInformationBarrierSegmentRequestBody" to be defined', }); } const shieldInformationBarrier = (0, shieldInformationBarrierBase_2.deserializeShieldInformationBarrierBase)(val.shield_information_barrier); if (val.name == void 0) { throw new errors_1.BoxSdkError({ message: 'Expecting "name" of type "CreateShieldInformationBarrierSegmentRequestBody" to be defined', }); } if (!(0, json_1.sdIsString)(val.name)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "name" of type "CreateShieldInformationBarrierSegmentRequestBody"', }); } const name = val.name; if (!(val.description == void 0) && !(0, json_1.sdIsString)(val.description)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "description" of type "CreateShieldInformationBarrierSegmentRequestBody"', }); } const description = val.description == void 0 ? void 0 : val.description; return { shieldInformationBarrier: shieldInformationBarrier, name: name, description: description, }; } //# sourceMappingURL=shieldInformationBarrierSegments.js.map