box-node-sdk
Version:
Official SDK for Box Platform APIs
554 lines • 22.9 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.GroupsManager = exports.DeleteGroupByIdHeaders = exports.UpdateGroupByIdHeaders = exports.GetGroupByIdHeaders = exports.CreateGroupHeaders = exports.GetGroupsHeaders = exports.DeleteGroupByIdOptionals = exports.UpdateGroupByIdOptionals = exports.GetGroupByIdOptionals = exports.CreateGroupOptionals = void 0;
exports.serializeCreateGroupRequestBodyInvitabilityLevelField = serializeCreateGroupRequestBodyInvitabilityLevelField;
exports.deserializeCreateGroupRequestBodyInvitabilityLevelField = deserializeCreateGroupRequestBodyInvitabilityLevelField;
exports.serializeCreateGroupRequestBodyMemberViewabilityLevelField = serializeCreateGroupRequestBodyMemberViewabilityLevelField;
exports.deserializeCreateGroupRequestBodyMemberViewabilityLevelField = deserializeCreateGroupRequestBodyMemberViewabilityLevelField;
exports.serializeCreateGroupRequestBody = serializeCreateGroupRequestBody;
exports.deserializeCreateGroupRequestBody = deserializeCreateGroupRequestBody;
exports.serializeUpdateGroupByIdRequestBodyInvitabilityLevelField = serializeUpdateGroupByIdRequestBodyInvitabilityLevelField;
exports.deserializeUpdateGroupByIdRequestBodyInvitabilityLevelField = deserializeUpdateGroupByIdRequestBodyInvitabilityLevelField;
exports.serializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField = serializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField;
exports.deserializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField = deserializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField;
exports.serializeUpdateGroupByIdRequestBody = serializeUpdateGroupByIdRequestBody;
exports.deserializeUpdateGroupByIdRequestBody = deserializeUpdateGroupByIdRequestBody;
const groups_1 = require("../schemas/groups");
const groupFull_1 = require("../schemas/groupFull");
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 CreateGroupOptionals {
queryParams = {};
headers = new CreateGroupHeaders({});
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.CreateGroupOptionals = CreateGroupOptionals;
class GetGroupByIdOptionals {
queryParams = {};
headers = new GetGroupByIdHeaders({});
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.GetGroupByIdOptionals = GetGroupByIdOptionals;
class UpdateGroupByIdOptionals {
requestBody = {};
queryParams = {};
headers = new UpdateGroupByIdHeaders({});
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.UpdateGroupByIdOptionals = UpdateGroupByIdOptionals;
class DeleteGroupByIdOptionals {
headers = new DeleteGroupByIdHeaders({});
cancellationToken = void 0;
constructor(fields) {
if (fields.headers !== undefined) {
this.headers = fields.headers;
}
if (fields.cancellationToken !== undefined) {
this.cancellationToken = fields.cancellationToken;
}
}
}
exports.DeleteGroupByIdOptionals = DeleteGroupByIdOptionals;
class GetGroupsHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetGroupsHeaders = GetGroupsHeaders;
class CreateGroupHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.CreateGroupHeaders = CreateGroupHeaders;
class GetGroupByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.GetGroupByIdHeaders = GetGroupByIdHeaders;
class UpdateGroupByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.UpdateGroupByIdHeaders = UpdateGroupByIdHeaders;
class DeleteGroupByIdHeaders {
/**
* Extra headers that will be included in the HTTP request. */
extraHeaders = {};
constructor(fields) {
if (fields.extraHeaders !== undefined) {
this.extraHeaders = fields.extraHeaders;
}
}
}
exports.DeleteGroupByIdHeaders = DeleteGroupByIdHeaders;
class GroupsManager {
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 groups for a given enterprise. The user
* must have admin permissions to inspect enterprise's groups.
* @param {GetGroupsQueryParams} queryParams Query parameters of getGroups method
* @param {GetGroupsHeadersInput} headersInput Headers of getGroups method
* @param {CancellationToken} cancellationToken Token used for request cancellation.
* @returns {Promise<Groups>}
*/
async getGroups(queryParams = {}, headersInput = new GetGroupsHeaders({}), cancellationToken) {
const headers = new GetGroupsHeaders({
extraHeaders: headersInput.extraHeaders,
});
const queryParamsMap = (0, utils_1.prepareParams)({
['filter_term']: (0, utils_2.toString)(queryParams.filterTerm),
['fields']: queryParams.fields
? queryParams.fields.map(utils_2.toString).join(',')
: undefined,
['limit']: (0, utils_2.toString)(queryParams.limit),
['offset']: (0, utils_2.toString)(queryParams.offset),
});
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/groups'),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, groups_1.deserializeGroups)(response.data),
rawData: response.data,
};
}
/**
* Creates a new group of users in an enterprise. Only users with admin
* permissions can create new groups.
* @param {CreateGroupRequestBody} requestBody Request body of createGroup method
* @param {CreateGroupOptionalsInput} optionalsInput
* @returns {Promise<GroupFull>}
*/
async createGroup(requestBody, optionalsInput = {}) {
const optionals = new CreateGroupOptionals({
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/groups'),
method: 'POST',
params: queryParamsMap,
headers: headersMap,
data: serializeCreateGroupRequestBody(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, groupFull_1.deserializeGroupFull)(response.data),
rawData: response.data,
};
}
/**
* Retrieves information about a group. Only members of this
* group or users with admin-level permissions will be able to
* use this API.
* @param {string} groupId The ID of the group.
Example: "57645"
* @param {GetGroupByIdOptionalsInput} optionalsInput
* @returns {Promise<GroupFull>}
*/
async getGroupById(groupId, optionalsInput = {}) {
const optionals = new GetGroupByIdOptionals({
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/groups/', (0, utils_2.toString)(groupId)),
method: 'GET',
params: queryParamsMap,
headers: headersMap,
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, groupFull_1.deserializeGroupFull)(response.data),
rawData: response.data,
};
}
/**
* Updates a specific group. Only admins of this
* group or users with admin-level permissions will be able to
* use this API.
* @param {string} groupId The ID of the group.
Example: "57645"
* @param {UpdateGroupByIdOptionalsInput} optionalsInput
* @returns {Promise<GroupFull>}
*/
async updateGroupById(groupId, optionalsInput = {}) {
const optionals = new UpdateGroupByIdOptionals({
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/groups/', (0, utils_2.toString)(groupId)),
method: 'PUT',
params: queryParamsMap,
headers: headersMap,
data: serializeUpdateGroupByIdRequestBody(requestBody),
contentType: 'application/json',
responseFormat: 'json',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return {
...(0, groupFull_1.deserializeGroupFull)(response.data),
rawData: response.data,
};
}
/**
* Permanently deletes a group. Only users with
* admin-level permissions will be able to use this API.
* @param {string} groupId The ID of the group.
Example: "57645"
* @param {DeleteGroupByIdOptionalsInput} optionalsInput
* @returns {Promise<undefined>}
*/
async deleteGroupById(groupId, optionalsInput = {}) {
const optionals = new DeleteGroupByIdOptionals({
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/groups/', (0, utils_2.toString)(groupId)),
method: 'DELETE',
headers: headersMap,
responseFormat: 'no_content',
auth: this.auth,
networkSession: this.networkSession,
cancellationToken: cancellationToken,
}));
return void 0;
}
}
exports.GroupsManager = GroupsManager;
function serializeCreateGroupRequestBodyInvitabilityLevelField(val) {
return val;
}
function deserializeCreateGroupRequestBodyInvitabilityLevelField(val) {
if (val == 'admins_only') {
return val;
}
if (val == 'admins_and_members') {
return val;
}
if (val == 'all_managed_users') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize CreateGroupRequestBodyInvitabilityLevelField",
});
}
function serializeCreateGroupRequestBodyMemberViewabilityLevelField(val) {
return val;
}
function deserializeCreateGroupRequestBodyMemberViewabilityLevelField(val) {
if (val == 'admins_only') {
return val;
}
if (val == 'admins_and_members') {
return val;
}
if (val == 'all_managed_users') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize CreateGroupRequestBodyMemberViewabilityLevelField",
});
}
function serializeCreateGroupRequestBody(val) {
return {
['name']: val.name,
['provenance']: val.provenance,
['external_sync_identifier']: val.externalSyncIdentifier,
['description']: val.description,
['invitability_level']: val.invitabilityLevel == void 0
? val.invitabilityLevel
: serializeCreateGroupRequestBodyInvitabilityLevelField(val.invitabilityLevel),
['member_viewability_level']: val.memberViewabilityLevel == void 0
? val.memberViewabilityLevel
: serializeCreateGroupRequestBodyMemberViewabilityLevelField(val.memberViewabilityLevel),
};
}
function deserializeCreateGroupRequestBody(val) {
if (!(0, json_2.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "CreateGroupRequestBody"',
});
}
if (val.name == void 0) {
throw new errors_1.BoxSdkError({
message: 'Expecting "name" of type "CreateGroupRequestBody" to be defined',
});
}
if (!(0, json_1.sdIsString)(val.name)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "name" of type "CreateGroupRequestBody"',
});
}
const name = val.name;
if (!(val.provenance == void 0) && !(0, json_1.sdIsString)(val.provenance)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "provenance" of type "CreateGroupRequestBody"',
});
}
const provenance = val.provenance == void 0 ? void 0 : val.provenance;
if (!(val.external_sync_identifier == void 0) &&
!(0, json_1.sdIsString)(val.external_sync_identifier)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "external_sync_identifier" of type "CreateGroupRequestBody"',
});
}
const externalSyncIdentifier = val.external_sync_identifier == void 0
? void 0
: val.external_sync_identifier;
if (!(val.description == void 0) && !(0, json_1.sdIsString)(val.description)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "description" of type "CreateGroupRequestBody"',
});
}
const description = val.description == void 0 ? void 0 : val.description;
const invitabilityLevel = val.invitability_level == void 0
? void 0
: deserializeCreateGroupRequestBodyInvitabilityLevelField(val.invitability_level);
const memberViewabilityLevel = val.member_viewability_level == void 0
? void 0
: deserializeCreateGroupRequestBodyMemberViewabilityLevelField(val.member_viewability_level);
return {
name: name,
provenance: provenance,
externalSyncIdentifier: externalSyncIdentifier,
description: description,
invitabilityLevel: invitabilityLevel,
memberViewabilityLevel: memberViewabilityLevel,
};
}
function serializeUpdateGroupByIdRequestBodyInvitabilityLevelField(val) {
return val;
}
function deserializeUpdateGroupByIdRequestBodyInvitabilityLevelField(val) {
if (val == 'admins_only') {
return val;
}
if (val == 'admins_and_members') {
return val;
}
if (val == 'all_managed_users') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize UpdateGroupByIdRequestBodyInvitabilityLevelField",
});
}
function serializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField(val) {
return val;
}
function deserializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField(val) {
if (val == 'admins_only') {
return val;
}
if (val == 'admins_and_members') {
return val;
}
if (val == 'all_managed_users') {
return val;
}
if ((0, json_1.sdIsString)(val)) {
return val;
}
throw new errors_1.BoxSdkError({
message: "Can't deserialize UpdateGroupByIdRequestBodyMemberViewabilityLevelField",
});
}
function serializeUpdateGroupByIdRequestBody(val) {
return {
['name']: val.name,
['provenance']: val.provenance,
['external_sync_identifier']: val.externalSyncIdentifier,
['description']: val.description,
['invitability_level']: val.invitabilityLevel == void 0
? val.invitabilityLevel
: serializeUpdateGroupByIdRequestBodyInvitabilityLevelField(val.invitabilityLevel),
['member_viewability_level']: val.memberViewabilityLevel == void 0
? val.memberViewabilityLevel
: serializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField(val.memberViewabilityLevel),
};
}
function deserializeUpdateGroupByIdRequestBody(val) {
if (!(0, json_2.sdIsMap)(val)) {
throw new errors_1.BoxSdkError({
message: 'Expecting a map for "UpdateGroupByIdRequestBody"',
});
}
if (!(val.name == void 0) && !(0, json_1.sdIsString)(val.name)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "name" of type "UpdateGroupByIdRequestBody"',
});
}
const name = val.name == void 0 ? void 0 : val.name;
if (!(val.provenance == void 0) && !(0, json_1.sdIsString)(val.provenance)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "provenance" of type "UpdateGroupByIdRequestBody"',
});
}
const provenance = val.provenance == void 0 ? void 0 : val.provenance;
if (!(val.external_sync_identifier == void 0) &&
!(0, json_1.sdIsString)(val.external_sync_identifier)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "external_sync_identifier" of type "UpdateGroupByIdRequestBody"',
});
}
const externalSyncIdentifier = val.external_sync_identifier == void 0
? void 0
: val.external_sync_identifier;
if (!(val.description == void 0) && !(0, json_1.sdIsString)(val.description)) {
throw new errors_1.BoxSdkError({
message: 'Expecting string for "description" of type "UpdateGroupByIdRequestBody"',
});
}
const description = val.description == void 0 ? void 0 : val.description;
const invitabilityLevel = val.invitability_level == void 0
? void 0
: deserializeUpdateGroupByIdRequestBodyInvitabilityLevelField(val.invitability_level);
const memberViewabilityLevel = val.member_viewability_level == void 0
? void 0
: deserializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField(val.member_viewability_level);
return {
name: name,
provenance: provenance,
externalSyncIdentifier: externalSyncIdentifier,
description: description,
invitabilityLevel: invitabilityLevel,
memberViewabilityLevel: memberViewabilityLevel,
};
}
//# sourceMappingURL=groups.js.map