box-node-sdk 1.35.0 → 1.37.2

package/lib/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/managers/recent-items.js

@@ -1,23 +1,18 @@
+"use strict";
 /**
  * @fileoverview Manager for the Box RecentItem Resource
  */
-
-'use strict';
-
-// ------------------------------------------------------------------------------
-// Requirements
-// ------------------------------------------------------------------------------
-var urlPath = require('../util/url-path');
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var url_path_1 = __importDefault(require("../util/url-path"));
 // ------------------------------------------------------------------------------
 // Private
 // ------------------------------------------------------------------------------
 var BASE_PATH = '/recent_items';
-
 // ------------------------------------------------------------------------------
 // Public
 // ------------------------------------------------------------------------------
-
 /**
  * Simple manager for interacting with all 'RecentItem' endpoints and actions.
  *
@@ -25,33 +20,31 @@ var BASE_PATH = '/recent_items';
  * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
  * @returns {void}
  */
-function RecentItems(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
- */
-RecentItems.prototype.get = function(options, callback) {
-	var params = {
-		qs: options
-	};
-	var apiPath = urlPath(BASE_PATH);
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * @module box-node-sdk/lib/managers/recent-items
- * @see {@Link RecentItems}
- */
+var RecentItems = /** @class */ (function () {
+    function RecentItems(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
+     */
+    RecentItems.prototype.get = function (options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = url_path_1.default(BASE_PATH);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    return RecentItems;
+}());
 module.exports = RecentItems;
+//# sourceMappingURL=recent-items.js.map

package/lib/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,8DAAuC;AAEvC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,IAAM,SAAS,GAAG,eAAe,CAAC;AAElC,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH;IAGC,qBAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,yBAAG,GAAH,UACC,OAIC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE,OAAO;SACX,CAAC;QACF,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACF,kBAAC;AAAD,CAAC,AAtCD,IAsCC;AAMD,iBAAS,WAAW,CAAC"}

package/lib/managers/retention-policies.d.ts

@@ -0,0 +1,213 @@
+/**
+ * @fileoverview Manager for the Retention Policies Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Enum of valid retention policy types, which specify how long the policy should
+ * remain in effect.
+ * @readonly
+ * @enum {RetentionPolicyType}
+ */
+declare enum RetentionPolicyType {
+    FINITE = "finite",
+    INDEFINITE = "indefinite"
+}
+/**
+ * Enum of valid retention policy disposition actions, which specify what should
+ * be done when the retention period is over
+ * @readonly
+ * @enum {RetentionPolicyDispositionAction}
+ */
+declare enum RetentionPolicyDispositionAction {
+    PERMANENTLY_DELETE = "permanently_delete",
+    REMOVE_RETENTION = "remove_retention"
+}
+/**
+ * Enum of valid policy assignment types, which specify what object the policy applies to
+ * @readonly
+ * @enum {RetentionPolicyAssignmentType}
+ */
+declare enum RetentionPolicyAssignmentType {
+    FOLDER = "folder",
+    ENTERPRISE = "enterprise",
+    METADATA = "metadata_template"
+}
+/**
+ * Metadata template fields to filter on for assigning a retention policy
+ * @typedef {Object} MetadataFilterField
+ * @property {string} field The field to filter on
+ * @property {string|int} value The value to filter against
+ */
+declare type MetadataFilterField = {
+    field: string;
+    value: string | number;
+};
+/**
+ * Simple manager for interacting with all Retention Policies endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class RetentionPolicies {
+    client: BoxClient;
+    policyTypes: typeof RetentionPolicyType;
+    dispositionActions: typeof RetentionPolicyDispositionAction;
+    assignmentTypes: typeof RetentionPolicyAssignmentType;
+    constructor(client: BoxClient);
+    /**
+     * Used to create a single retention policy for an enterprise
+     *
+     * API Endpoint: '/retention_policies'
+     * Method: POST
+     *
+     * @param {string} name - The name of the retention policy to be created
+     * @param {RetentionPolicyType} type - The type of policy to create
+     * @param {RetentionPolicyDispositionAction} action - The disposition action for the new policy
+     * @param {Object} [options] - Additional parameters
+     * @param {int} [options.retention_length] - For finite policies, the number of days to retain the content
+     * @param {Function} [callback] - Passed the new policy information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the new policy object
+     */
+    create(name: string, type: RetentionPolicyType, action: RetentionPolicyDispositionAction, options?: {
+        retention_length?: number;
+    }, callback?: Function): any;
+    /**
+     * Fetches details about a specific retention policy
+     *
+     * API Endpoint: '/retention_policies/:policyID'
+     * Method: GET
+     *
+     * @param {string} policyID - The Box ID of the retention policy being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the policy information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the policy object
+     */
+    get(policyID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Update or modify a retention policy.
+     *
+     * API Endpoint: '/retention_policies/:policyID'
+     * Method: PUT
+     *
+     * @param {string} policyID - The Box ID of the retention policy to update
+     * @param {Object} updates - The information to be updated
+     * @param {string} [updates.policy_name] - The name of the retention policy
+     * @param {RetentionPolicyDispositionAction} [updates.disposition_action] - The disposition action for the updated policy
+     * @param {string} [updates.status] - Used to retire a retention policy if status is set to retired
+     * @param {Function} [callback] - Passed the updated policy information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated policy object
+     */
+    update(policyID: string, updates: {
+        policy_name?: string;
+        disposition_action?: RetentionPolicyDispositionAction;
+        status?: string;
+    }, callback?: Function): any;
+    /**
+     * Fetches a list of retention policies for the enterprise
+     *
+     * API Endpoint: '/retention_policies
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {string} [options.policy_name] - A full or partial name to filter the retention policies by
+     * @param {RetentionPolicyType} [options.policy_type] - A policy type to filter the retention policies by
+     * @param {string} [options.created_by_user_id] - A user id to filter the retention policies by
+     * @param {Function} [callback] - Passed the policy objects if they were acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of policies
+     */
+    getAll(options?: {
+        policy_name?: string;
+        policy_type?: RetentionPolicyType;
+        created_by_user_id?: string;
+    }, callback?: Function): any;
+    /**
+     * Fetch a list of assignments for a given retention policy
+     *
+     * API Endpoint: '/retention_policies/:policyID/assignments'
+     * Method: GET
+     *
+     * @param {string} policyID - The Box ID of the retention policy to get assignments for
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {RetentionPolicyAssignmentType} [options.type] - The type of the retention policy assignment to retrieve
+     * @param {Function} [callback] - Passed the assignment objects if they were acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of policy assignments
+     */
+    getAssignments(policyID: string, options?: {
+        type?: RetentionPolicyAssignmentType;
+    }, callback?: Function): any;
+    /**
+     * Assign a retention policy to a folder or the entire enterprise.
+     *
+     * API Endpoint: '/retention_policy_assignments
+     * Method: POST
+     *
+     * @param {string} policyID - The ID of the policy to assign
+     * @param {RetentionPolicyAssignmentType} assignType - The type of object the policy will be assigned to
+     * @param {string} assignID - The Box ID of the object to assign the retention policy to
+     * @param {Object} [options] - Optional parameters for the request
+     * @param {MetadataFilterField[]} [options.filter_fields] - Metadata fields to filter against, if assigning to a metadata template
+     * @param {Function} [callback] - Passed the new assignment object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created assignment object
+     */
+    assign(policyID: string, assignType: RetentionPolicyAssignmentType, assignID: string, options?: {
+        filter_fields?: MetadataFilterField[];
+    } | Function | null, callback?: Function): any;
+    /**
+     * Fetch a specific policy assignment
+     *
+     * API Endpoint: '/retention_policy_assignments/:assignmentID'
+     * Method: GET
+     *
+     * @param {string} assignmentID - The Box ID of the policy assignment object to fetch
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the assignment object if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the assignment object
+     */
+    getAssignment(assignmentID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Get the specific retention record for a retained file version. To use this feature,
+     * you must have the manage retention policies scope enabled for your API key
+     * via your application management console.
+     *
+     * API Endpoint: '/file_version_retentions/:retentionID'
+     * Method: GET
+     *
+     * @param {string} retentionID - The ID for the file retention record to retrieve
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Pass the file version retention record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the retention record
+     */
+    getFileVersionRetention(retentionID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Get a list of retention records for a retained file versions in an enterprise.
+     * To use this feature, you must have the manage retention policies scope enabled
+     * for your API key via your application management console.
+     *
+     * API Endpoint: '/file_version_retentions'
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {string} [options.file_id] - A file id to filter the file version retentions by
+     * @param {string} [options.file_version_id] - A file version id to filter the file version retentions by
+     * @param {string} [options.policy_id] - A policy id to filter the file version retentions by
+     * @param {RetentionPolicyDispositionAction} [options.disposition_action] - The disposition action of the retention policy to filter by
+     * @param {string} [options.disposition_before] - Filter by retention policies which will complete before a certain time
+     * @param {string} [options.disposition_after] - Filter by retention policies which will complete after a certain time
+     * @param {int} [options.limit] - The maximum number of items to return in a page
+     * @param {string} [options.marker] - Paging marker, left blank to begin paging from the beginning
+     * @param {Function} [callback] - Pass the file version retention record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of retention records
+     */
+    getAllFileVersionRetentions(options?: {
+        file_id?: string;
+        file_version_id?: string;
+        policy_id?: string;
+        disposition_action?: RetentionPolicyDispositionAction;
+        disposition_before?: string;
+        disposition_after?: string;
+        limit?: number;
+        marker?: string;
+    }, callback?: Function): any;
+}
+export = RetentionPolicies;