box-node-sdk 3.8.0 → 3.8.2

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

@@ -0,0 +1,232 @@
+/**
+ * @fileoverview Manager for the Box Metadata Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Valid metadata field types
+ * @readonly
+ * @enum {MetadataFieldType}
+ */
+declare enum MetadataFieldType {
+    STRING = "string",
+    ENUM = "enum",
+    NUMBER = "float",
+    DATE = "date",
+    MULTI_SELECT = "multiSelect"
+}
+/**
+ * Metadata enum option
+ * @typedef {Object} MetadataEnumOption
+ * @property {string} key The option value
+ */
+type MetadataEnumOption = {
+    key: string;
+};
+/**
+ * Field definition for a metadata template
+ * @typedef {Object} MetadataTemplateField
+ * @property {MetadataFieldType} type The type of the field
+ * @property {string} key The programmatic name of the field
+ * @property {string} displayName The display name of the field
+ * @property {boolean} hidden Whether this field is hidden in the UI for the user and can only be set through the API instead
+ * @property {MetadataEnumOption[]} [options] For enum fields, the options
+ */
+type MetadataTemplateField = {
+    type: MetadataFieldType;
+    key: string;
+    displayName: string;
+    hidden: boolean;
+    options?: MetadataEnumOption[];
+};
+/**
+ * Simple manager for interacting with all metadata endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class Metadata {
+    client: BoxClient;
+    templates: Record<string, any>;
+    scopes: Record<string, any>;
+    cascadeResolution: Record<string, any>;
+    fieldTypes: typeof MetadataFieldType;
+    constructor(client: BoxClient);
+    /**
+     * Retrieve the schema definition for a metadata template
+     *
+     * API Endpoint: '/metadata_templates/:scope/:template'
+     * Method: GET
+     *
+     * @param {string} scope - The scope of the template, e.g. "enterprise"
+     * @param {string} template - The template to retrieve
+     * @param {Function} [callback] - Called with the template schema if successful
+     * @returns {Promise<Object>} A promise resolving to the template schema
+     */
+    getTemplateSchema(scope: string, template: string, callback?: Function): any;
+    /**
+     * Retrieve the schema definition for a metadata template by ID
+     *
+     * API Endpoint: '/metadata_templates/:id'
+     * Method: GET
+     *
+     * @param {string} templateID - The ID of the template to retrieve
+     * @param {Function} [callback] - Called with the template schema if successful
+     * @returns {Promise<Object>} A promise resolving to the template schema
+     */
+    getTemplateByID(templateID: string, callback?: Function): any;
+    /**
+     * Get all templates in a given scope
+     *
+     * API Endpoint: '/metadata_templates/:scope'
+     * Method: GET
+     *
+     * @param {string} scope - The scope to retrieve templates for
+     * @param {Function} [callback] - Called with an array of templates when successful
+     * @returns {Promise<Object>} A promise resolving to the collection of templates
+     */
+    getTemplates(scope: string, callback?: Function): any;
+    /**
+     * Create a new metadata template
+     *
+     * API Endpoint: '/metadata_templates/schema',
+     * Method: POST
+     *
+     * @param {string} templateName - The name of the metadata template
+     * @param {MetadataTemplateField[]} fields - A list of fields for the template
+     * @param {Object} [options] - Optional parameters, can be left null in many cases
+     * @param {string} [options.templateKey] - The programmatic key for the template
+     * @param {boolean} [options.hidden] - Whether the template should be hidden in the UI
+     * @param {string} [options.scope=enterprise] - The scope for the template, only 'enterprise' is supported for now
+     * @param {boolean} [options.copyInstanceOnItemCopy] - Whether to include the metadata when a file or folder is copied
+     * @param {Function} [callback] - Passed the template if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created template
+     */
+    createTemplate(templateName: string, fields: MetadataTemplateField[], options?: {
+        templateKey?: string;
+        hidden?: boolean;
+        scope?: string;
+        copyInstanceOnItemCopy?: boolean;
+    }, callback?: Function): any;
+    /**
+     * Update a metadata template via one or more non-breaking operations.  Each
+     * operation is a an object descrbing one change to the template or its
+     * fields.
+     *
+     * API Endpoint: '/metadata_templates/:scope/:template/schema'
+     * Method: PUT
+     *
+     * @param {string} scope - The scope of the template to modify
+     * @param {string} template - The template to modify
+     * @param {Object[]} operations - The operations to perform
+     * @param {Function} [callback] - Passed the updated template if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated template
+     * @see {@link https://developer.box.com/en/reference/put-metadata-templates-id-id-schema/}
+     */
+    updateTemplate(scope: string, template: string, operations: Record<string, any>[], callback?: Function): any;
+    /**
+     * Delete a metadata template from an enterprise.
+     *
+     * API Endpoint: '/metadata_templates/:scope/:template/schema'
+     * Method: DELETE
+     *
+     * @param {string} scope - The scope of the template to delete
+     * @param {string} template - The template to delete
+     * @param {Function} [callback] - Passed empty response body if successful, err otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     * @see {@link https://developer.box.com/en/reference/delete-metadata-templates-id-id-schema/}
+     */
+    deleteTemplate(scope: string, template: string, callback?: Function): any;
+    /**
+     * Get the cascade policies associated with a given folder.
+     *
+     * API Endpoint: '/metadata_cascade_policies'
+     * Method: GET
+     *
+     * @param {string} folderID The ID of the folder to get cascade policies for
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.owner_enterprise_id] ID of the enterprise to get policies for
+     * @param {Function} [callback] Passed the collection of policies if successful
+     * @returns {Promise<Object>} Promise resolving to the collection of policies
+     */
+    getCascadePolicies(folderID: string, options?: {
+        owner_enterprise_id?: string;
+    }, callback?: Function): any;
+    /**
+     * Get a metadata cascade policy object by ID
+     *
+     * API Endpoint: '/metadata_cascade_policies/:policyID'
+     * Method: GET
+     *
+     * @param {string} policyID The ID of the policy to retrieve
+     * @param {Function} [callback] Passed the cascade policy if successful
+     * @returns {Promise<Object>} Promise resolving to the cascade policy
+     */
+    getCascadePolicy(policyID: string, callback?: Function): any;
+    /**
+     * Add a new cascade policy to a folder/metadata template, causing the
+     * metadata template to be applied to all items and subfolders inside the
+     * folder.
+     *
+     * API Endpoint: '/metadata_cascade_policies'
+     * Method: POST
+     *
+     * @param {string} scope Metadata template scope for the template to cascade
+     * @param {string} templateKey Metadata template key for the template to cascade
+     * @param {string} folderID The ID of the folder to cascade over
+     * @param {Function} [callback] Passed the cascade policy if successful
+     * @returns {Promise<Object>} Promise resolving to the cascade policy
+     */
+    createCascadePolicy(scope: string, templateKey: string, folderID: string, callback?: Function): any;
+    /**
+     * Delete the metadata cascade policy with the given ID
+     *
+     * API Endpoint: '/metadata_cascade_policies/:policyID'
+     * Method: DELETE
+     *
+     * @param {string} policyID The ID of the policy to delete
+     * @param {Function} [callback] Passed nothing if successful
+     * @returns {Promise<void>} Promise resolving to nothing
+     */
+    deleteCascadePolicy(policyID: string, callback?: Function): any;
+    /**
+     * If a policy already exists on a folder, this will apply that policy to all existing files and
+     * sub-folders within the target folder.
+     *
+     * API Endpoint: '/metadata_cascade_policies/:policyID/apply'
+     * Method: POST
+     *
+     * @param {string} policyID The ID of the policy to delete
+     * @param {string} resolutionMethod How to resolve conflicts, either "none" or "overwrite"
+     * @param {Function} [callback] Passed nothing if successful
+     * @returns {Promise<void>} Promise resolving to nothing
+     */
+    forceApplyCascadePolicy(policyID: string, resolutionMethod: string, callback?: Function): any;
+    /**
+     * Query Box items by their metadata.
+     *
+     * API Endpoint: '/metadata_queries/execute_read'
+     * Method: POST
+     *
+     * @param {string} from - The template used in the query. Must be in the form scope.templateKey
+     * @param {string} ancestorFolderId - The folder_id to which to restrain the query
+     * @param {Object} [options] - Optional parameters
+     * @param {string} [options.query] - The logical expression of the query
+     * @param {Object} [options.query_params] - Required if query present. The arguments for the query
+     * @param {Object} [options.order_by] - The field_key(s) to order on and the corresponding direction(s)
+     * @param {Array} [options.fields] - An array of fields to return
+     * @param {int} [options.limit=100] - The number of results to return for a single request
+     * @param {string} [options.marker] - Pagination marker
+     * @param {Function} [callback] - Passed a collection of items and their associated metadata
+     * @returns {Promise<void>} Promise resolving to a collection of items and their associated metadata
+     */
+    query(from: string, ancestorFolderId: string, options?: {
+        query?: string;
+        query_params?: Record<string, any>;
+        order_by?: Record<string, any>;
+        fields?: string[];
+        limit?: number;
+        marker?: string;
+    }, callback?: Function): any;
+}
+export = Metadata;

package/lib-esm/managers/metadata.js

@@ -0,0 +1,288 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box Metadata Resource
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const url_path_1 = __importDefault(require("../util/url-path"));
+const merge = require('merge-options');
+// -----------------------------------------------------------------------------
+// Typedefs
+// -----------------------------------------------------------------------------
+/**
+ * Valid metadata field types
+ * @readonly
+ * @enum {MetadataFieldType}
+ */
+var MetadataFieldType;
+(function (MetadataFieldType) {
+    MetadataFieldType["STRING"] = "string";
+    MetadataFieldType["ENUM"] = "enum";
+    MetadataFieldType["NUMBER"] = "float";
+    MetadataFieldType["DATE"] = "date";
+    MetadataFieldType["MULTI_SELECT"] = "multiSelect";
+})(MetadataFieldType || (MetadataFieldType = {}));
+// -----------------------------------------------------------------------------
+// Private
+// -----------------------------------------------------------------------------
+const PROPERTIES_TEMPLATE = 'properties', BASE_PATH = '/metadata_templates', SCHEMA_SUBRESOURCE = 'schema', ENTERPRISE_SCOPE = 'enterprise', GLOBAL_SCOPE = 'global', CASCADE_POLICIES_PATH = '/metadata_cascade_policies', QUERY_PATH = '/metadata_queries/execute_read';
+// -----------------------------------------------------------------------------
+// Public
+// -----------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all metadata endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class Metadata {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Retrieve the schema definition for a metadata template
+     *
+     * API Endpoint: '/metadata_templates/:scope/:template'
+     * Method: GET
+     *
+     * @param {string} scope - The scope of the template, e.g. "enterprise"
+     * @param {string} template - The template to retrieve
+     * @param {Function} [callback] - Called with the template schema if successful
+     * @returns {Promise<Object>} A promise resolving to the template schema
+     */
+    getTemplateSchema(scope, template, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, scope, template, SCHEMA_SUBRESOURCE);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
+    }
+    /**
+     * Retrieve the schema definition for a metadata template by ID
+     *
+     * API Endpoint: '/metadata_templates/:id'
+     * Method: GET
+     *
+     * @param {string} templateID - The ID of the template to retrieve
+     * @param {Function} [callback] - Called with the template schema if successful
+     * @returns {Promise<Object>} A promise resolving to the template schema
+     */
+    getTemplateByID(templateID, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, templateID);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
+    }
+    /**
+     * Get all templates in a given scope
+     *
+     * API Endpoint: '/metadata_templates/:scope'
+     * Method: GET
+     *
+     * @param {string} scope - The scope to retrieve templates for
+     * @param {Function} [callback] - Called with an array of templates when successful
+     * @returns {Promise<Object>} A promise resolving to the collection of templates
+     */
+    getTemplates(scope, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, scope);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
+    }
+    /**
+     * Create a new metadata template
+     *
+     * API Endpoint: '/metadata_templates/schema',
+     * Method: POST
+     *
+     * @param {string} templateName - The name of the metadata template
+     * @param {MetadataTemplateField[]} fields - A list of fields for the template
+     * @param {Object} [options] - Optional parameters, can be left null in many cases
+     * @param {string} [options.templateKey] - The programmatic key for the template
+     * @param {boolean} [options.hidden] - Whether the template should be hidden in the UI
+     * @param {string} [options.scope=enterprise] - The scope for the template, only 'enterprise' is supported for now
+     * @param {boolean} [options.copyInstanceOnItemCopy] - Whether to include the metadata when a file or folder is copied
+     * @param {Function} [callback] - Passed the template if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created template
+     */
+    createTemplate(templateName, fields, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, SCHEMA_SUBRESOURCE), params = {
+            body: {
+                scope: ENTERPRISE_SCOPE,
+                displayName: templateName,
+                fields,
+            },
+        };
+        Object.assign(params.body, options);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Update a metadata template via one or more non-breaking operations.  Each
+     * operation is a an object descrbing one change to the template or its
+     * fields.
+     *
+     * API Endpoint: '/metadata_templates/:scope/:template/schema'
+     * Method: PUT
+     *
+     * @param {string} scope - The scope of the template to modify
+     * @param {string} template - The template to modify
+     * @param {Object[]} operations - The operations to perform
+     * @param {Function} [callback] - Passed the updated template if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated template
+     * @see {@link https://developer.box.com/en/reference/put-metadata-templates-id-id-schema/}
+     */
+    updateTemplate(scope, template, operations, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, scope, template, SCHEMA_SUBRESOURCE), params = {
+            body: operations,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Delete a metadata template from an enterprise.
+     *
+     * API Endpoint: '/metadata_templates/:scope/:template/schema'
+     * Method: DELETE
+     *
+     * @param {string} scope - The scope of the template to delete
+     * @param {string} template - The template to delete
+     * @param {Function} [callback] - Passed empty response body if successful, err otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     * @see {@link https://developer.box.com/en/reference/delete-metadata-templates-id-id-schema/}
+     */
+    deleteTemplate(scope, template, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, scope, template, SCHEMA_SUBRESOURCE);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+    /**
+     * Get the cascade policies associated with a given folder.
+     *
+     * API Endpoint: '/metadata_cascade_policies'
+     * Method: GET
+     *
+     * @param {string} folderID The ID of the folder to get cascade policies for
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.owner_enterprise_id] ID of the enterprise to get policies for
+     * @param {Function} [callback] Passed the collection of policies if successful
+     * @returns {Promise<Object>} Promise resolving to the collection of policies
+     */
+    getCascadePolicies(folderID, options, callback) {
+        var apiPath = (0, url_path_1.default)(CASCADE_POLICIES_PATH), params = {
+            qs: Object.assign({ folder_id: folderID }, options),
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Get a metadata cascade policy object by ID
+     *
+     * API Endpoint: '/metadata_cascade_policies/:policyID'
+     * Method: GET
+     *
+     * @param {string} policyID The ID of the policy to retrieve
+     * @param {Function} [callback] Passed the cascade policy if successful
+     * @returns {Promise<Object>} Promise resolving to the cascade policy
+     */
+    getCascadePolicy(policyID, callback) {
+        var apiPath = (0, url_path_1.default)(CASCADE_POLICIES_PATH, policyID);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
+    }
+    /**
+     * Add a new cascade policy to a folder/metadata template, causing the
+     * metadata template to be applied to all items and subfolders inside the
+     * folder.
+     *
+     * API Endpoint: '/metadata_cascade_policies'
+     * Method: POST
+     *
+     * @param {string} scope Metadata template scope for the template to cascade
+     * @param {string} templateKey Metadata template key for the template to cascade
+     * @param {string} folderID The ID of the folder to cascade over
+     * @param {Function} [callback] Passed the cascade policy if successful
+     * @returns {Promise<Object>} Promise resolving to the cascade policy
+     */
+    createCascadePolicy(scope, templateKey, folderID, callback) {
+        var apiPath = (0, url_path_1.default)(CASCADE_POLICIES_PATH), params = {
+            body: {
+                folder_id: folderID,
+                scope,
+                templateKey,
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Delete the metadata cascade policy with the given ID
+     *
+     * API Endpoint: '/metadata_cascade_policies/:policyID'
+     * Method: DELETE
+     *
+     * @param {string} policyID The ID of the policy to delete
+     * @param {Function} [callback] Passed nothing if successful
+     * @returns {Promise<void>} Promise resolving to nothing
+     */
+    deleteCascadePolicy(policyID, callback) {
+        var apiPath = (0, url_path_1.default)(CASCADE_POLICIES_PATH, policyID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+    /**
+     * If a policy already exists on a folder, this will apply that policy to all existing files and
+     * sub-folders within the target folder.
+     *
+     * API Endpoint: '/metadata_cascade_policies/:policyID/apply'
+     * Method: POST
+     *
+     * @param {string} policyID The ID of the policy to delete
+     * @param {string} resolutionMethod How to resolve conflicts, either "none" or "overwrite"
+     * @param {Function} [callback] Passed nothing if successful
+     * @returns {Promise<void>} Promise resolving to nothing
+     */
+    forceApplyCascadePolicy(policyID, resolutionMethod, callback) {
+        var apiPath = (0, url_path_1.default)(CASCADE_POLICIES_PATH, policyID, 'apply'), params = {
+            body: {
+                conflict_resolution: resolutionMethod,
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Query Box items by their metadata.
+     *
+     * API Endpoint: '/metadata_queries/execute_read'
+     * Method: POST
+     *
+     * @param {string} from - The template used in the query. Must be in the form scope.templateKey
+     * @param {string} ancestorFolderId - The folder_id to which to restrain the query
+     * @param {Object} [options] - Optional parameters
+     * @param {string} [options.query] - The logical expression of the query
+     * @param {Object} [options.query_params] - Required if query present. The arguments for the query
+     * @param {Object} [options.order_by] - The field_key(s) to order on and the corresponding direction(s)
+     * @param {Array} [options.fields] - An array of fields to return
+     * @param {int} [options.limit=100] - The number of results to return for a single request
+     * @param {string} [options.marker] - Pagination marker
+     * @param {Function} [callback] - Passed a collection of items and their associated metadata
+     * @returns {Promise<void>} Promise resolving to a collection of items and their associated metadata
+     */
+    query(from, ancestorFolderId, options, callback) {
+        var body = {
+            from,
+            ancestor_folder_id: ancestorFolderId,
+        };
+        var params = {
+            body: merge(body, options || {}),
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(QUERY_PATH, params, callback);
+    }
+}
+Metadata.prototype.templates = {
+    PROPERTIES: PROPERTIES_TEMPLATE,
+};
+Metadata.prototype.scopes = {
+    ENTERPRISE: ENTERPRISE_SCOPE,
+    GLOBAL: GLOBAL_SCOPE,
+};
+Metadata.prototype.cascadeResolution = Object.freeze({
+    PRESERVE_EXISTING: 'none',
+    OVERWRITE: 'overwrite',
+});
+/**
+ * Valid metadata field types
+ * @readonly
+ * @enum {MetadataFieldType}
+ */
+Metadata.prototype.fieldTypes = MetadataFieldType;
+module.exports = Metadata;
+//# sourceMappingURL=metadata.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/managers/metadata.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AACvC,MAAM,KAAK,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;GAIG;AACH,IAAK,iBAMJ;AAND,WAAK,iBAAiB;IACpB,sCAAiB,CAAA;IACjB,kCAAa,CAAA;IACb,qCAAgB,CAAA;IAChB,kCAAa,CAAA;IACb,iDAA4B,CAAA;AAC9B,CAAC,EANI,iBAAiB,KAAjB,iBAAiB,QAMrB;AA4BD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAChF,MAAM,mBAAmB,GAAG,YAAY,EACtC,SAAS,GAAG,qBAAqB,EACjC,kBAAkB,GAAG,QAAQ,EAC7B,gBAAgB,GAAG,YAAY,EAC/B,YAAY,GAAG,QAAQ,EACvB,qBAAqB,GAAG,4BAA4B,EACpD,UAAU,GAAG,gCAAgC,CAAC;AAEhD,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,QAAQ;IAQZ,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,KAAa,EAAE,QAAgB,EAAE,QAAmB;QACpE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CAAC,UAAkB,EAAE,QAAmB;QACrD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,KAAa,EAAE,QAAmB;QAC7C,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,YAAoB,EACpB,MAA+B,EAC/B,OAKC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,kBAAkB,CAAC,EAClD,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,KAAK,EAAE,gBAAgB;gBACvB,WAAW,EAAE,YAAY;gBACzB,MAAM;aACP;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;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,KAAa,EACb,QAAgB,EAChB,UAAiC,EACjC,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,CAAC,EACnE,MAAM,GAAG;YACP,IAAI,EAAE,UAAU;SACjB,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;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,KAAa,EAAE,QAAgB,EAAE,QAAmB;QACjE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,QAAgB,EAChB,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,CAAC,EAC1C,MAAM,GAAG;YACP,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC;SACpD,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,QAAgB,EAAE,QAAmB;QACpD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;QAEvD,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,mBAAmB,CACjB,KAAa,EACb,WAAmB,EACnB,QAAgB,EAChB,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,CAAC,EAC1C,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,SAAS,EAAE,QAAQ;gBACnB,KAAK;gBACL,WAAW;aACZ;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;IAED;;;;;;;;;OASG;IACH,mBAAmB,CAAC,QAAgB,EAAE,QAAmB;QACvD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,uBAAuB,CACrB,QAAgB,EAChB,gBAAwB,EACxB,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,EAAE,QAAQ,EAAE,OAAO,CAAC,EAC7D,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,mBAAmB,EAAE,gBAAgB;aACtC;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;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CACH,IAAY,EACZ,gBAAwB,EACxB,OAOC,EACD,QAAmB;QAEnB,IAAI,IAAI,GAAG;YACT,IAAI;YACJ,kBAAkB,EAAE,gBAAgB;SACrC,CAAC;QAEF,IAAI,MAAM,GAAG;YACX,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC;SACjC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,UAAU,EACV,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAED,QAAQ,CAAC,SAAS,CAAC,SAAS,GAAG;IAC7B,UAAU,EAAE,mBAAmB;CAChC,CAAC;AAEF,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG;IAC1B,UAAU,EAAE,gBAAgB;IAC5B,MAAM,EAAE,YAAY;CACrB,CAAC;AAEF,QAAQ,CAAC,SAAS,CAAC,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IACnD,iBAAiB,EAAE,MAAM;IACzB,SAAS,EAAE,WAAW;CACvB,CAAC,CAAC;AAEH;;;;GAIG;AACH,QAAQ,CAAC,SAAS,CAAC,UAAU,GAAG,iBAAiB,CAAC;AAElD,iBAAS,QAAQ,CAAC"}

package/lib-esm/managers/recent-items.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview Manager for the Box RecentItem Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Simple manager for interacting with all 'RecentItem' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class RecentItems {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Requests all items that have been accessed by a user in the last 90 days or the last 1000 items accessed.
+     *
+     * API Endpoint: '/recent_items'
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {int} [options.limit] Maximum number of items to return
+     * @param {string} [options.marker] The position marker for marker-based paging
+     * @param {string} [options.fields] Comma-separated list of fields to include in the response
+     * @param {Function} [callback] - Passed the items information if they were acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collection of items in the collection
+     */
+    get(options?: {
+        limit?: number;
+        marker?: string;
+        fields?: string;
+    }, callback?: Function): any;
+}
+/**
+ * @module box-node-sdk/lib/managers/recent-items
+ * @see {@Link RecentItems}
+ */
+export = RecentItems;

package/lib-esm/managers/recent-items.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box RecentItem Resource
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const url_path_1 = __importDefault(require("../util/url-path"));
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+const BASE_PATH = '/recent_items';
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all 'RecentItem' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class RecentItems {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Requests all items that have been accessed by a user in the last 90 days or the last 1000 items accessed.
+     *
+     * API Endpoint: '/recent_items'
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {int} [options.limit] Maximum number of items to return
+     * @param {string} [options.marker] The position marker for marker-based paging
+     * @param {string} [options.fields] Comma-separated list of fields to include in the response
+     * @param {Function} [callback] - Passed the items information if they were acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collection of items in the collection
+     */
+    get(options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+}
+module.exports = RecentItems;
+//# sourceMappingURL=recent-items.js.map

package/lib-esm/managers/recent-items.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recent-items.js","sourceRoot":"","sources":["../../src/managers/recent-items.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAEvC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,SAAS,GAAG,eAAe,CAAC;AAElC,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,WAAW;IAGf,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CACD,OAIC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,EAAE,EAAE,OAAO;SACZ,CAAC;QACF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAMD,iBAAS,WAAW,CAAC"}