UNPKG

box-node-sdk

Version:

Official SDK for Box Platform APIs

595 lines 26.9 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.RetentionPoliciesManager = exports.DeleteRetentionPolicyByIdHeaders = exports.UpdateRetentionPolicyByIdHeaders = exports.GetRetentionPolicyByIdHeaders = exports.CreateRetentionPolicyHeaders = exports.GetRetentionPoliciesHeaders = exports.DeleteRetentionPolicyByIdOptionals = exports.UpdateRetentionPolicyByIdOptionals = exports.GetRetentionPolicyByIdOptionals = exports.CreateRetentionPolicyOptionals = void 0; exports.serializeGetRetentionPoliciesQueryParamsPolicyTypeField = serializeGetRetentionPoliciesQueryParamsPolicyTypeField; exports.deserializeGetRetentionPoliciesQueryParamsPolicyTypeField = deserializeGetRetentionPoliciesQueryParamsPolicyTypeField; exports.serializeCreateRetentionPolicyRequestBodyPolicyTypeField = serializeCreateRetentionPolicyRequestBodyPolicyTypeField; exports.deserializeCreateRetentionPolicyRequestBodyPolicyTypeField = deserializeCreateRetentionPolicyRequestBodyPolicyTypeField; exports.serializeCreateRetentionPolicyRequestBodyDispositionActionField = serializeCreateRetentionPolicyRequestBodyDispositionActionField; exports.deserializeCreateRetentionPolicyRequestBodyDispositionActionField = deserializeCreateRetentionPolicyRequestBodyDispositionActionField; exports.serializeCreateRetentionPolicyRequestBodyRetentionTypeField = serializeCreateRetentionPolicyRequestBodyRetentionTypeField; exports.deserializeCreateRetentionPolicyRequestBodyRetentionTypeField = deserializeCreateRetentionPolicyRequestBodyRetentionTypeField; exports.serializeCreateRetentionPolicyRequestBody = serializeCreateRetentionPolicyRequestBody; exports.deserializeCreateRetentionPolicyRequestBody = deserializeCreateRetentionPolicyRequestBody; exports.serializeUpdateRetentionPolicyByIdRequestBody = serializeUpdateRetentionPolicyByIdRequestBody; exports.deserializeUpdateRetentionPolicyByIdRequestBody = deserializeUpdateRetentionPolicyByIdRequestBody; const retentionPolicies_1 = require("../schemas/retentionPolicies"); const retentionPolicy_1 = require("../schemas/retentionPolicy"); const userMini_1 = require("../schemas/userMini"); const userMini_2 = require("../schemas/userMini"); const userBase_1 = require("../schemas/userBase"); const userBase_2 = require("../schemas/userBase"); 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"); const json_3 = require("../serialization/json"); const json_4 = require("../serialization/json"); class CreateRetentionPolicyOptionals { headers = new CreateRetentionPolicyHeaders({}); cancellationToken = void 0; constructor(fields) { if (fields.headers !== undefined) { this.headers = fields.headers; } if (fields.cancellationToken !== undefined) { this.cancellationToken = fields.cancellationToken; } } } exports.CreateRetentionPolicyOptionals = CreateRetentionPolicyOptionals; class GetRetentionPolicyByIdOptionals { queryParams = {}; headers = new GetRetentionPolicyByIdHeaders({}); 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.GetRetentionPolicyByIdOptionals = GetRetentionPolicyByIdOptionals; class UpdateRetentionPolicyByIdOptionals { requestBody = {}; headers = new UpdateRetentionPolicyByIdHeaders({}); 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.UpdateRetentionPolicyByIdOptionals = UpdateRetentionPolicyByIdOptionals; class DeleteRetentionPolicyByIdOptionals { headers = new DeleteRetentionPolicyByIdHeaders({}); cancellationToken = void 0; constructor(fields) { if (fields.headers !== undefined) { this.headers = fields.headers; } if (fields.cancellationToken !== undefined) { this.cancellationToken = fields.cancellationToken; } } } exports.DeleteRetentionPolicyByIdOptionals = DeleteRetentionPolicyByIdOptionals; class GetRetentionPoliciesHeaders { /** * Extra headers that will be included in the HTTP request. */ extraHeaders = {}; constructor(fields) { if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.GetRetentionPoliciesHeaders = GetRetentionPoliciesHeaders; class CreateRetentionPolicyHeaders { /** * Extra headers that will be included in the HTTP request. */ extraHeaders = {}; constructor(fields) { if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.CreateRetentionPolicyHeaders = CreateRetentionPolicyHeaders; class GetRetentionPolicyByIdHeaders { /** * Extra headers that will be included in the HTTP request. */ extraHeaders = {}; constructor(fields) { if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.GetRetentionPolicyByIdHeaders = GetRetentionPolicyByIdHeaders; class UpdateRetentionPolicyByIdHeaders { /** * Extra headers that will be included in the HTTP request. */ extraHeaders = {}; constructor(fields) { if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.UpdateRetentionPolicyByIdHeaders = UpdateRetentionPolicyByIdHeaders; class DeleteRetentionPolicyByIdHeaders { /** * Extra headers that will be included in the HTTP request. */ extraHeaders = {}; constructor(fields) { if (fields.extraHeaders !== undefined) { this.extraHeaders = fields.extraHeaders; } } } exports.DeleteRetentionPolicyByIdHeaders = DeleteRetentionPolicyByIdHeaders; class RetentionPoliciesManager { 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 all of the retention policies for an enterprise. * @param {GetRetentionPoliciesQueryParams} queryParams Query parameters of getRetentionPolicies method * @param {GetRetentionPoliciesHeadersInput} headersInput Headers of getRetentionPolicies method * @param {CancellationToken} cancellationToken Token used for request cancellation. * @returns {Promise<RetentionPolicies>} */ async getRetentionPolicies(queryParams = {}, headersInput = new GetRetentionPoliciesHeaders({}), cancellationToken) { const headers = new GetRetentionPoliciesHeaders({ extraHeaders: headersInput.extraHeaders, }); const queryParamsMap = (0, utils_1.prepareParams)({ ['policy_name']: (0, utils_2.toString)(queryParams.policyName), ['policy_type']: (0, utils_2.toString)(queryParams.policyType), ['created_by_user_id']: (0, utils_2.toString)(queryParams.createdByUserId), ['fields']: queryParams.fields ? queryParams.fields.map(utils_2.toString).join(',') : undefined, ['limit']: (0, utils_2.toString)(queryParams.limit), ['marker']: (0, utils_2.toString)(queryParams.marker), }); 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/retention_policies'), method: 'GET', params: queryParamsMap, headers: headersMap, responseFormat: 'json', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return { ...(0, retentionPolicies_1.deserializeRetentionPolicies)(response.data), rawData: response.data, }; } /** * Creates a retention policy. * @param {CreateRetentionPolicyRequestBody} requestBody Request body of createRetentionPolicy method * @param {CreateRetentionPolicyOptionalsInput} optionalsInput * @returns {Promise<RetentionPolicy>} */ async createRetentionPolicy(requestBody, optionalsInput = {}) { const optionals = new CreateRetentionPolicyOptionals({ 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/retention_policies'), method: 'POST', headers: headersMap, data: serializeCreateRetentionPolicyRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return { ...(0, retentionPolicy_1.deserializeRetentionPolicy)(response.data), rawData: response.data, }; } /** * Retrieves a retention policy. * @param {string} retentionPolicyId The ID of the retention policy. Example: "982312" * @param {GetRetentionPolicyByIdOptionalsInput} optionalsInput * @returns {Promise<RetentionPolicy>} */ async getRetentionPolicyById(retentionPolicyId, optionalsInput = {}) { const optionals = new GetRetentionPolicyByIdOptionals({ 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/retention_policies/', (0, utils_2.toString)(retentionPolicyId)), method: 'GET', params: queryParamsMap, headers: headersMap, responseFormat: 'json', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return { ...(0, retentionPolicy_1.deserializeRetentionPolicy)(response.data), rawData: response.data, }; } /** * Updates a retention policy. * @param {string} retentionPolicyId The ID of the retention policy. Example: "982312" * @param {UpdateRetentionPolicyByIdOptionalsInput} optionalsInput * @returns {Promise<RetentionPolicy>} */ async updateRetentionPolicyById(retentionPolicyId, optionalsInput = {}) { const optionals = new UpdateRetentionPolicyByIdOptionals({ 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)({ ...{}, ...headers.extraHeaders }); const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({ url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/retention_policies/', (0, utils_2.toString)(retentionPolicyId)), method: 'PUT', headers: headersMap, data: serializeUpdateRetentionPolicyByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return { ...(0, retentionPolicy_1.deserializeRetentionPolicy)(response.data), rawData: response.data, }; } /** * Permanently deletes a retention policy. * @param {string} retentionPolicyId The ID of the retention policy. Example: "982312" * @param {DeleteRetentionPolicyByIdOptionalsInput} optionalsInput * @returns {Promise<undefined>} */ async deleteRetentionPolicyById(retentionPolicyId, optionalsInput = {}) { const optionals = new DeleteRetentionPolicyByIdOptionals({ 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/retention_policies/', (0, utils_2.toString)(retentionPolicyId)), method: 'DELETE', headers: headersMap, responseFormat: 'no_content', auth: this.auth, networkSession: this.networkSession, cancellationToken: cancellationToken, })); return void 0; } } exports.RetentionPoliciesManager = RetentionPoliciesManager; function serializeGetRetentionPoliciesQueryParamsPolicyTypeField(val) { return val; } function deserializeGetRetentionPoliciesQueryParamsPolicyTypeField(val) { if (val == 'finite') { return val; } if (val == 'indefinite') { return val; } if ((0, json_2.sdIsString)(val)) { return val; } throw new errors_1.BoxSdkError({ message: "Can't deserialize GetRetentionPoliciesQueryParamsPolicyTypeField", }); } function serializeCreateRetentionPolicyRequestBodyPolicyTypeField(val) { return val; } function deserializeCreateRetentionPolicyRequestBodyPolicyTypeField(val) { if (val == 'finite') { return val; } if (val == 'indefinite') { return val; } if ((0, json_2.sdIsString)(val)) { return val; } throw new errors_1.BoxSdkError({ message: "Can't deserialize CreateRetentionPolicyRequestBodyPolicyTypeField", }); } function serializeCreateRetentionPolicyRequestBodyDispositionActionField(val) { return val; } function deserializeCreateRetentionPolicyRequestBodyDispositionActionField(val) { if (val == 'permanently_delete') { return val; } if (val == 'remove_retention') { return val; } if ((0, json_2.sdIsString)(val)) { return val; } throw new errors_1.BoxSdkError({ message: "Can't deserialize CreateRetentionPolicyRequestBodyDispositionActionField", }); } function serializeCreateRetentionPolicyRequestBodyRetentionTypeField(val) { return val; } function deserializeCreateRetentionPolicyRequestBodyRetentionTypeField(val) { if (val == 'modifiable') { return val; } if (val == 'non_modifiable') { return val; } if ((0, json_2.sdIsString)(val)) { return val; } throw new errors_1.BoxSdkError({ message: "Can't deserialize CreateRetentionPolicyRequestBodyRetentionTypeField", }); } function serializeCreateRetentionPolicyRequestBody(val) { return { ['policy_name']: val.policyName, ['description']: val.description, ['policy_type']: serializeCreateRetentionPolicyRequestBodyPolicyTypeField(val.policyType), ['disposition_action']: serializeCreateRetentionPolicyRequestBodyDispositionActionField(val.dispositionAction), ['retention_length']: val.retentionLength, ['retention_type']: val.retentionType == void 0 ? val.retentionType : serializeCreateRetentionPolicyRequestBodyRetentionTypeField(val.retentionType), ['can_owner_extend_retention']: val.canOwnerExtendRetention, ['are_owners_notified']: val.areOwnersNotified, ['custom_notification_recipients']: val.customNotificationRecipients == void 0 ? val.customNotificationRecipients : val.customNotificationRecipients.map(function (item) { return (0, userMini_1.serializeUserMini)(item); }), }; } function deserializeCreateRetentionPolicyRequestBody(val) { if (!(0, json_4.sdIsMap)(val)) { throw new errors_1.BoxSdkError({ message: 'Expecting a map for "CreateRetentionPolicyRequestBody"', }); } if (val.policy_name == void 0) { throw new errors_1.BoxSdkError({ message: 'Expecting "policy_name" of type "CreateRetentionPolicyRequestBody" to be defined', }); } if (!(0, json_2.sdIsString)(val.policy_name)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "policy_name" of type "CreateRetentionPolicyRequestBody"', }); } 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 "CreateRetentionPolicyRequestBody"', }); } const description = val.description == void 0 ? void 0 : val.description; if (val.policy_type == void 0) { throw new errors_1.BoxSdkError({ message: 'Expecting "policy_type" of type "CreateRetentionPolicyRequestBody" to be defined', }); } const policyType = deserializeCreateRetentionPolicyRequestBodyPolicyTypeField(val.policy_type); if (val.disposition_action == void 0) { throw new errors_1.BoxSdkError({ message: 'Expecting "disposition_action" of type "CreateRetentionPolicyRequestBody" to be defined', }); } const dispositionAction = deserializeCreateRetentionPolicyRequestBodyDispositionActionField(val.disposition_action); if (!(val.retention_length == void 0) && !(0, json_2.sdIsString)(val.retention_length)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "retention_length" of type "CreateRetentionPolicyRequestBody"', }); } const retentionLength = val.retention_length == void 0 ? void 0 : val.retention_length; const retentionType = val.retention_type == void 0 ? void 0 : deserializeCreateRetentionPolicyRequestBodyRetentionTypeField(val.retention_type); if (!(val.can_owner_extend_retention == void 0) && !(0, json_1.sdIsBoolean)(val.can_owner_extend_retention)) { throw new errors_1.BoxSdkError({ message: 'Expecting boolean for "can_owner_extend_retention" of type "CreateRetentionPolicyRequestBody"', }); } const canOwnerExtendRetention = val.can_owner_extend_retention == void 0 ? void 0 : val.can_owner_extend_retention; if (!(val.are_owners_notified == void 0) && !(0, json_1.sdIsBoolean)(val.are_owners_notified)) { throw new errors_1.BoxSdkError({ message: 'Expecting boolean for "are_owners_notified" of type "CreateRetentionPolicyRequestBody"', }); } const areOwnersNotified = val.are_owners_notified == void 0 ? void 0 : val.are_owners_notified; if (!(val.custom_notification_recipients == void 0) && !(0, json_3.sdIsList)(val.custom_notification_recipients)) { throw new errors_1.BoxSdkError({ message: 'Expecting array for "custom_notification_recipients" of type "CreateRetentionPolicyRequestBody"', }); } const customNotificationRecipients = val.custom_notification_recipients == void 0 ? void 0 : (0, json_3.sdIsList)(val.custom_notification_recipients) ? val.custom_notification_recipients.map(function (itm) { return (0, userMini_2.deserializeUserMini)(itm); }) : []; return { policyName: policyName, description: description, policyType: policyType, dispositionAction: dispositionAction, retentionLength: retentionLength, retentionType: retentionType, canOwnerExtendRetention: canOwnerExtendRetention, areOwnersNotified: areOwnersNotified, customNotificationRecipients: customNotificationRecipients, }; } function serializeUpdateRetentionPolicyByIdRequestBody(val) { return { ['policy_name']: val.policyName, ['description']: val.description, ['disposition_action']: val.dispositionAction, ['retention_type']: val.retentionType, ['retention_length']: val.retentionLength, ['status']: val.status, ['can_owner_extend_retention']: val.canOwnerExtendRetention, ['are_owners_notified']: val.areOwnersNotified, ['custom_notification_recipients']: val.customNotificationRecipients == void 0 ? val.customNotificationRecipients : val.customNotificationRecipients.map(function (item) { return (0, userBase_1.serializeUserBase)(item); }), }; } function deserializeUpdateRetentionPolicyByIdRequestBody(val) { if (!(0, json_4.sdIsMap)(val)) { throw new errors_1.BoxSdkError({ message: 'Expecting a map for "UpdateRetentionPolicyByIdRequestBody"', }); } 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 "UpdateRetentionPolicyByIdRequestBody"', }); } 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 "UpdateRetentionPolicyByIdRequestBody"', }); } const description = val.description == void 0 ? void 0 : val.description; if (!(val.disposition_action == void 0) && !(0, json_2.sdIsString)(val.disposition_action)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "disposition_action" of type "UpdateRetentionPolicyByIdRequestBody"', }); } const dispositionAction = val.disposition_action == void 0 ? void 0 : val.disposition_action; if (!(val.retention_type == void 0) && !(0, json_2.sdIsString)(val.retention_type)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "retention_type" of type "UpdateRetentionPolicyByIdRequestBody"', }); } const retentionType = val.retention_type == void 0 ? void 0 : val.retention_type; if (!(val.retention_length == void 0) && !(0, json_2.sdIsString)(val.retention_length)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "retention_length" of type "UpdateRetentionPolicyByIdRequestBody"', }); } const retentionLength = val.retention_length == void 0 ? void 0 : val.retention_length; if (!(val.status == void 0) && !(0, json_2.sdIsString)(val.status)) { throw new errors_1.BoxSdkError({ message: 'Expecting string for "status" of type "UpdateRetentionPolicyByIdRequestBody"', }); } const status = val.status == void 0 ? void 0 : val.status; if (!(val.can_owner_extend_retention == void 0) && !(0, json_1.sdIsBoolean)(val.can_owner_extend_retention)) { throw new errors_1.BoxSdkError({ message: 'Expecting boolean for "can_owner_extend_retention" of type "UpdateRetentionPolicyByIdRequestBody"', }); } const canOwnerExtendRetention = val.can_owner_extend_retention == void 0 ? void 0 : val.can_owner_extend_retention; if (!(val.are_owners_notified == void 0) && !(0, json_1.sdIsBoolean)(val.are_owners_notified)) { throw new errors_1.BoxSdkError({ message: 'Expecting boolean for "are_owners_notified" of type "UpdateRetentionPolicyByIdRequestBody"', }); } const areOwnersNotified = val.are_owners_notified == void 0 ? void 0 : val.are_owners_notified; if (!(val.custom_notification_recipients == void 0) && !(0, json_3.sdIsList)(val.custom_notification_recipients)) { throw new errors_1.BoxSdkError({ message: 'Expecting array for "custom_notification_recipients" of type "UpdateRetentionPolicyByIdRequestBody"', }); } const customNotificationRecipients = val.custom_notification_recipients == void 0 ? void 0 : (0, json_3.sdIsList)(val.custom_notification_recipients) ? val.custom_notification_recipients.map(function (itm) { return (0, userBase_2.deserializeUserBase)(itm); }) : []; return { policyName: policyName, description: description, dispositionAction: dispositionAction, retentionType: retentionType, retentionLength: retentionLength, status: status, canOwnerExtendRetention: canOwnerExtendRetention, areOwnersNotified: areOwnersNotified, customNotificationRecipients: customNotificationRecipients, }; } //# sourceMappingURL=retentionPolicies.js.map