box-node-sdk 3.8.1 → 3.8.2

package/lib-esm/managers/groups.d.ts

@@ -0,0 +1,213 @@
+/**
+ * @fileoverview Manager for the Groups resource
+ * @author mwiller
+ */
+import BoxClient from '../box-client';
+/**
+ * Enum of valid access levels for groups, which are used to specify who can
+ * perform certain actions on the group.
+ * @enum {GroupAccessLevel}
+ */
+declare enum GroupAccessLevel {
+    ADMINS = "admins_only",
+    MEMBERS = "admins_and_members",
+    ALL_USERS = "all_managed_users"
+}
+/**
+ * Enum of valid user roles within a group
+ * @enum {GroupUserRole}
+ */
+declare enum GroupUserRole {
+    MEMBER = "member",
+    ADMIN = "admin"
+}
+/**
+ * Simple manager for interacting with all 'Groups' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class Groups {
+    client: BoxClient;
+    accessLevels: typeof GroupAccessLevel;
+    userRoles: typeof GroupUserRole;
+    constructor(client: BoxClient);
+    /**
+     * Used to create a new group
+     *
+     * API Endpoint: '/groups'
+     * Method: POST
+     *
+     * @param {string} name - The name for the new group
+     * @param {Object} [options] - Additional parameters
+     * @param {string} [options.provenance] - Used to track the external source where the group is coming from
+     * @param {string} [options.external_sync_identifier] - Used as a group identifier for groups coming from an external source
+     * @param {string} [options.description] - Description of the group
+     * @param {GroupAccessLevel} [options.invitability_level] - Specifies who can invite this group to collaborate on folders
+     * @param {GroupAccessLevel} [options.member_viewability_level] - Specifies who can view the members of this group
+     * @param {Function} [callback] - Passed the new group object if it was created successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the new group object
+     */
+    create(name: string, options?: {
+        provenance?: string;
+        external_sync_identifier?: string;
+        description?: string;
+        invitability_level?: GroupAccessLevel;
+        member_viewability_level?: GroupAccessLevel;
+    }, callback?: Function): any;
+    /**
+     * Used to fetch information about a group
+     *
+     * API Endpoint: '/groups/:groupID'
+     * Method: GET
+     *
+     * @param {string} groupID - The ID of the group to retrieve
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the group object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the group object
+     */
+    get(groupID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Used to update or modify a group object
+     *
+     * API Endpoint: '/groups/:groupID'
+     * Method: PUT
+     *
+     * @param {string} groupID - The ID of the group to update
+     * @param {Object} updates - Group fields to update
+     * @param {Function} [callback] - Passed the updated group object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated group object
+     */
+    update(groupID: string, updates?: Record<string, any>, callback?: Function): any;
+    /**
+     * Delete a group
+     *
+     * API Endpoint: '/groups/:groupID'
+     * Method: DELETE
+     *
+     * @param {string} groupID - The ID of the group to delete
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    delete(groupID: string, callback?: Function): any;
+    /**
+     * Add a user to a group, which creates a membership record for the user
+     *
+     * API Endpoint: '/group_memberships'
+     * Method: POST
+     *
+     * @param {string} groupID - The ID of the group to add the user to
+     * @param {string} userID - The ID of the user to add the the group
+     * @param {Object} [options] - Optional parameters for adding the user, can be left null in most cases
+     * @param {GroupUserRole} [options.role] - The role of the user in the group
+     * @param {Function} [callback] - Passed the membership record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the new membership object
+     */
+    addUser(groupID: string, userID: string, options?: {
+        role?: GroupUserRole;
+    }, callback?: Function): any;
+    /**
+     * Fetch a specific membership record, which shows that a given user is a member
+     * of some group.
+     *
+     * API Endpoint: '/group_memberships/:membershipID'
+     * Method: GET
+     *
+     * @param {string} membershipID - The ID of the membership to fetch
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the membership record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the membership object
+     */
+    getMembership(membershipID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Used to update or modify a group object
+     *
+     * API Endpoint: '/group_memberships/:membershipID'
+     * Method: PUT
+     *
+     * @param {string} membershipID - The ID of the membership to update
+     * @param {Object} options - Membership record fields to update
+     * @param {Function} [callback] - Passed the updated membership object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated membership object
+     */
+    updateMembership(membershipID: string, options: Record<string, any>, callback?: Function): any;
+    /**
+     * Used to remove a group membership
+     *
+     * API Endpoint: '/group_memberships/:membershipID'
+     * Method: DELETE
+     *
+     * @param {string} membershipID - The ID of the membership to be removed
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    removeMembership(membershipID: string, callback?: Function): any;
+    /**
+     * Retreieve a list of memberships for the group, which show which users
+     * belong to the group
+     *
+     * API Endpoint: '/groups/:groupID/memberships'
+     * Method: GET
+     *
+     * @param {string} groupID - The ID of the group to get memberships for
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {int} [options.limit] - The number of memberships to retrieve
+     * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
+     * @param {Function} [callback] - Passed a list of memberships if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of memberships
+     */
+    getMemberships(groupID: string, options?: {
+        limit?: number;
+        offset?: number;
+    }, callback?: Function): any;
+    /**
+     * Retreieve a list of groups in the caller's enterprise.  This ability is
+     * restricted to certain users with permission to view groups.
+     *
+     * API Endpoint: '/groups'
+     * Method: GET
+     *
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {string} [options.filter_term] - Limits the results to only groups whose name starts with the search term
+     * @param {int} [options.limit] - The number of memberships to retrieve
+     * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
+     * @param {Function} [callback] - Passed a list of groups if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of groups
+     */
+    getAll(options?: {
+        filter_term?: string;
+        limit?: number;
+        offset?: number;
+    }, callback?: Function): any;
+    /**
+     * Retreieve a list of collaborations for the group, which show which items the
+     * group has access to.
+     *
+     * API Endpoint: '/groups/:groupID/collaborations'
+     * Method: GET
+     *
+     * @param {string} groupID - The ID of the group to get collaborations for
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {int} [options.limit] - The number of memberships to retrieve
+     * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
+     * @param {Function} [callback] - Passed a list of collaborations if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of collaborations for the group
+     */
+    getCollaborations(groupID: string, options?: {
+        limit?: number;
+        offset?: number;
+    }, callback?: Function): any;
+    /**
+     * Validates the roles and permissions of the group,
+     * and creates asynchronous jobs to terminate the group's sessions.
+     *
+     * API Endpoint: '/groups/terminate_sessions'
+     * Method: POST
+     *
+     * @param {string[]} groupIDs A list of group IDs
+     * @returns {Promise<Object>} A promise resolving a message about the request status.
+     */
+    terminateSession(groupIDs: string[], callback?: Function): any;
+}
+export = Groups;

package/lib-esm/managers/groups.js

@@ -0,0 +1,289 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Groups resource
+ * @author mwiller
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const url_path_1 = __importDefault(require("../util/url-path"));
+// -----------------------------------------------------------------------------
+// Typedefs
+// -----------------------------------------------------------------------------
+/**
+ * Enum of valid access levels for groups, which are used to specify who can
+ * perform certain actions on the group.
+ * @enum {GroupAccessLevel}
+ */
+var GroupAccessLevel;
+(function (GroupAccessLevel) {
+    GroupAccessLevel["ADMINS"] = "admins_only";
+    GroupAccessLevel["MEMBERS"] = "admins_and_members";
+    GroupAccessLevel["ALL_USERS"] = "all_managed_users";
+})(GroupAccessLevel || (GroupAccessLevel = {}));
+/**
+ * Enum of valid user roles within a group
+ * @enum {GroupUserRole}
+ */
+var GroupUserRole;
+(function (GroupUserRole) {
+    GroupUserRole["MEMBER"] = "member";
+    GroupUserRole["ADMIN"] = "admin";
+})(GroupUserRole || (GroupUserRole = {}));
+// -----------------------------------------------------------------------------
+// Private
+// -----------------------------------------------------------------------------
+const BASE_PATH = '/groups', MEMBERSHIPS_PATH = '/group_memberships', MEMBERSHIPS_SUBRESOURCE = 'memberships', COLLABORATIONS_SUBRESOURCE = 'collaborations';
+// -----------------------------------------------------------------------------
+// Public
+// -----------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all 'Groups' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class Groups {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Used to create a new group
+     *
+     * API Endpoint: '/groups'
+     * Method: POST
+     *
+     * @param {string} name - The name for the new group
+     * @param {Object} [options] - Additional parameters
+     * @param {string} [options.provenance] - Used to track the external source where the group is coming from
+     * @param {string} [options.external_sync_identifier] - Used as a group identifier for groups coming from an external source
+     * @param {string} [options.description] - Description of the group
+     * @param {GroupAccessLevel} [options.invitability_level] - Specifies who can invite this group to collaborate on folders
+     * @param {GroupAccessLevel} [options.member_viewability_level] - Specifies who can view the members of this group
+     * @param {Function} [callback] - Passed the new group object if it was created successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the new group object
+     */
+    create(name, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH), params = {
+            body: options || {},
+        };
+        params.body.name = name;
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Used to fetch information about a group
+     *
+     * API Endpoint: '/groups/:groupID'
+     * Method: GET
+     *
+     * @param {string} groupID - The ID of the group to retrieve
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the group object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the group object
+     */
+    get(groupID, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, groupID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Used to update or modify a group object
+     *
+     * API Endpoint: '/groups/:groupID'
+     * Method: PUT
+     *
+     * @param {string} groupID - The ID of the group to update
+     * @param {Object} updates - Group fields to update
+     * @param {Function} [callback] - Passed the updated group object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated group object
+     */
+    update(groupID, updates, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, groupID), params = {
+            body: updates,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Delete a group
+     *
+     * API Endpoint: '/groups/:groupID'
+     * Method: DELETE
+     *
+     * @param {string} groupID - The ID of the group to delete
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    delete(groupID, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, groupID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+    /**
+     * Add a user to a group, which creates a membership record for the user
+     *
+     * API Endpoint: '/group_memberships'
+     * Method: POST
+     *
+     * @param {string} groupID - The ID of the group to add the user to
+     * @param {string} userID - The ID of the user to add the the group
+     * @param {Object} [options] - Optional parameters for adding the user, can be left null in most cases
+     * @param {GroupUserRole} [options.role] - The role of the user in the group
+     * @param {Function} [callback] - Passed the membership record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the new membership object
+     */
+    addUser(groupID, userID, options, callback) {
+        var apiPath = (0, url_path_1.default)(MEMBERSHIPS_PATH), params = {
+            body: {
+                user: {
+                    id: userID,
+                },
+                group: {
+                    id: groupID,
+                },
+            },
+        };
+        Object.assign(params.body, options);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Fetch a specific membership record, which shows that a given user is a member
+     * of some group.
+     *
+     * API Endpoint: '/group_memberships/:membershipID'
+     * Method: GET
+     *
+     * @param {string} membershipID - The ID of the membership to fetch
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the membership record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the membership object
+     */
+    getMembership(membershipID, options, callback) {
+        var apiPath = (0, url_path_1.default)(MEMBERSHIPS_PATH, membershipID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Used to update or modify a group object
+     *
+     * API Endpoint: '/group_memberships/:membershipID'
+     * Method: PUT
+     *
+     * @param {string} membershipID - The ID of the membership to update
+     * @param {Object} options - Membership record fields to update
+     * @param {Function} [callback] - Passed the updated membership object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated membership object
+     */
+    updateMembership(membershipID, options, callback) {
+        var apiPath = (0, url_path_1.default)(MEMBERSHIPS_PATH, membershipID), params = {
+            body: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Used to remove a group membership
+     *
+     * API Endpoint: '/group_memberships/:membershipID'
+     * Method: DELETE
+     *
+     * @param {string} membershipID - The ID of the membership to be removed
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    removeMembership(membershipID, callback) {
+        var apiPath = (0, url_path_1.default)(MEMBERSHIPS_PATH, membershipID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+    /**
+     * Retreieve a list of memberships for the group, which show which users
+     * belong to the group
+     *
+     * API Endpoint: '/groups/:groupID/memberships'
+     * Method: GET
+     *
+     * @param {string} groupID - The ID of the group to get memberships for
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {int} [options.limit] - The number of memberships to retrieve
+     * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
+     * @param {Function} [callback] - Passed a list of memberships if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of memberships
+     */
+    getMemberships(groupID, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, groupID, MEMBERSHIPS_SUBRESOURCE), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Retreieve a list of groups in the caller's enterprise.  This ability is
+     * restricted to certain users with permission to view groups.
+     *
+     * API Endpoint: '/groups'
+     * Method: GET
+     *
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {string} [options.filter_term] - Limits the results to only groups whose name starts with the search term
+     * @param {int} [options.limit] - The number of memberships to retrieve
+     * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
+     * @param {Function} [callback] - Passed a list of groups if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of groups
+     */
+    getAll(options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Retreieve a list of collaborations for the group, which show which items the
+     * group has access to.
+     *
+     * API Endpoint: '/groups/:groupID/collaborations'
+     * Method: GET
+     *
+     * @param {string} groupID - The ID of the group to get collaborations for
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {int} [options.limit] - The number of memberships to retrieve
+     * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
+     * @param {Function} [callback] - Passed a list of collaborations if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of collaborations for the group
+     */
+    getCollaborations(groupID, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, groupID, COLLABORATIONS_SUBRESOURCE), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Validates the roles and permissions of the group,
+     * and creates asynchronous jobs to terminate the group's sessions.
+     *
+     * API Endpoint: '/groups/terminate_sessions'
+     * Method: POST
+     *
+     * @param {string[]} groupIDs A list of group IDs
+     * @returns {Promise<Object>} A promise resolving a message about the request status.
+     */
+    terminateSession(groupIDs, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, 'terminate_sessions'), params = {
+            body: {
+                group_ids: groupIDs,
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+}
+/**
+ * Enum of valid access levels for groups, which are used to specify who can
+ * perform certain actions on the group.
+ * @enum {GroupAccessLevel}
+ */
+Groups.prototype.accessLevels = GroupAccessLevel;
+/**
+ * Enum of valid user roles within a group
+ * @enum {GroupUserRole}
+ */
+Groups.prototype.userRoles = GroupUserRole;
+module.exports = Groups;
+//# sourceMappingURL=groups.js.map

package/lib-esm/managers/groups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"groups.js","sourceRoot":"","sources":["../../src/managers/groups.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAOH,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;GAIG;AACH,IAAK,gBAIJ;AAJD,WAAK,gBAAgB;IACnB,0CAAsB,CAAA;IACtB,kDAA8B,CAAA;IAC9B,mDAA+B,CAAA;AACjC,CAAC,EAJI,gBAAgB,KAAhB,gBAAgB,QAIpB;AAED;;;GAGG;AACH,IAAK,aAGJ;AAHD,WAAK,aAAa;IAChB,kCAAiB,CAAA;IACjB,gCAAe,CAAA;AACjB,CAAC,EAHI,aAAa,KAAb,aAAa,QAGjB;AAED,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,SAAS,GAAG,SAAS,EACzB,gBAAgB,GAAG,oBAAoB,EACvC,uBAAuB,GAAG,aAAa,EACvC,0BAA0B,GAAG,gBAAgB,CAAC;AAEhD,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,MAAM;IAKV,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,IAAY,EACZ,OAMC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,EAC9B,MAAM,GAAwB;YAC5B,IAAI,EAAE,OAAO,IAAI,EAAE;SACpB,CAAC;QAEJ,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAExB,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,OAAe,EAAE,OAA6B,EAAE,QAAmB;QACrE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,OAAO,CAAC,EACvC,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAe,EAAE,OAA6B,EAAE,QAAmB;QACxE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,OAAO,CAAC,EACvC,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAe,EAAE,QAAmB;QACzC,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAE1C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,OAAe,EACf,MAAc,EACd,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,EAAE,EAAE,MAAM;iBACX;gBACD,KAAK,EAAE;oBACL,EAAE,EAAE,OAAO;iBACZ;aACF;SACF,CAAC;QAEJ,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CACX,YAAoB,EACpB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,EACnD,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,YAAoB,EACpB,OAA4B,EAC5B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,EACnD,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,YAAoB,EAAE,QAAmB;QACxD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CACZ,OAAe,EACf,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,OAAO,EAAE,uBAAuB,CAAC,EAChE,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,OAIC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,EAC9B,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,OAAe,EACf,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,EACnE,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,QAAkB,EAAE,QAAmB;QACtD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,oBAAoB,CAAC,EACpD,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,SAAS,EAAE,QAAQ;aACpB;SACF,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,SAAS,CAAC,YAAY,GAAG,gBAAgB,CAAC;AAEjD;;;GAGG;AACH,MAAM,CAAC,SAAS,CAAC,SAAS,GAAG,aAAa,CAAC;AAE3C,iBAAS,MAAM,CAAC"}

package/lib-esm/managers/integration-mappings.d.ts

@@ -0,0 +1,116 @@
+import BoxClient from '../box-client';
+import * as schemas from '../schemas';
+/**
+ */
+declare class IntegrationMappingsManager {
+    client: BoxClient;
+    /**
+     * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+     */
+    constructor(client: BoxClient);
+    /**
+     * List Slack integration mappings
+     *
+     * Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise.
+     *
+     * You need Admin or Co-Admin role to
+     * use this endpoint.
+     * @param {object} [options] Options for the request
+     * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
+     * @param {number} [options.limit] The maximum number of items to return per page.
+     * @param {"channel"} [options.partner_item_type] Mapped item type, for which the mapping should be returned
+     * @param {string} [options.partner_item_id] ID of the mapped item, for which the mapping should be returned
+     * @param {string} [options.box_item_id] Box item ID, for which the mappings should be returned
+     * @param {"folder"} [options.box_item_type] Box item type, for which the mappings should be returned
+     * @param {boolean} [options.is_manually_created] Whether the mapping has been manually created
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.IntegrationMappings>} A promise resolving to the result or rejecting with an error
+     */
+    getSlackIntegrationMappings(options?: {
+        /**
+         * Defines the position marker at which to begin returning results. This is
+         * used when paginating using marker-based pagination.
+         *
+         * This requires `usemarker` to be set to `true`.
+         */
+        readonly marker?: string;
+        /**
+         * The maximum number of items to return per page.
+         */
+        readonly limit?: number;
+        /**
+         * Mapped item type, for which the mapping should be returned
+         */
+        readonly partner_item_type?: 'channel';
+        /**
+         * ID of the mapped item, for which the mapping should be returned
+         */
+        readonly partner_item_id?: string;
+        /**
+         * Box item ID, for which the mappings should be returned
+         */
+        readonly box_item_id?: string;
+        /**
+         * Box item type, for which the mappings should be returned
+         */
+        readonly box_item_type?: 'folder';
+        /**
+         * Whether the mapping has been manually created
+         */
+        readonly is_manually_created?: boolean;
+    }, callback?: Function): Promise<schemas.IntegrationMappings>;
+    /**
+     * Create Slack integration mapping
+     *
+     * Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)
+     * by mapping a Slack channel to a Box item.
+     *
+     * You need Admin or Co-Admin role to
+     * use this endpoint.
+     * @param {schemas.IntegrationMappingSlackCreateRequest} body
+     * @param {object} [options] Options for the request
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.IntegrationMapping>} A promise resolving to the result or rejecting with an error
+     */
+    createSlackIntegrationMapping(body: schemas.IntegrationMappingSlackCreateRequest, options?: {}, callback?: Function): Promise<schemas.IntegrationMapping>;
+    /**
+     * Update Slack integration mapping
+     *
+     * Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack).
+     * Supports updating the Box folder ID and options.
+     *
+     * You need Admin or Co-Admin role to
+     * use this endpoint.
+     * @param {object} body
+     * @param {object} options Options for the request
+     * @param {string} options.integration_mapping_id An ID of an integration mapping
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.IntegrationMapping>} A promise resolving to the result or rejecting with an error
+     */
+    updateSlackIntegrationMapping(body: object, options: {
+        /**
+         * An ID of an integration mapping
+         */
+        readonly integration_mapping_id: string;
+    }, callback?: Function): Promise<schemas.IntegrationMapping>;
+    /**
+     * Delete Slack integration mapping
+     *
+     * Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack).
+     *
+     *
+     * You need Admin or Co-Admin role to
+     * use this endpoint.
+     * @param {object} options Options for the request
+     * @param {string} options.integration_mapping_id An ID of an integration mapping
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to the result or rejecting with an error
+     */
+    deleteSlackIntegrationMappingById(options: {
+        /**
+         * An ID of an integration mapping
+         */
+        readonly integration_mapping_id: string;
+    }, callback?: Function): Promise<void>;
+}
+export = IntegrationMappingsManager;