box-node-sdk 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,6 +4,7 @@ Box Node.js SDK
4
4
  [![Greenkeeper badge](https://badges.greenkeeper.io/box/box-node-sdk.svg)](https://greenkeeper.io/)
5
5
 
6
6
  [![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
7
+ [![Coverage](https://coveralls.io/repos/github/box/box-node-sdk/badge.svg?branch=main)](https://coveralls.io/github/box/box-node-sdk?branch=main)
7
8
 
8
9
  A Node.js interface to the [Box Content API](https://developers.box.com/docs/).
9
10
 
@@ -12,7 +13,6 @@ Getting Started Docs: https://developer.box.com/guides/tooling/sdks/node/
12
13
  <!-- START doctoc generated TOC please keep comment here to allow auto update -->
13
14
  <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
14
15
 
15
-
16
16
  - [Installation](#installation)
17
17
  - [Getting Started](#getting-started)
18
18
  - [Creating API Clients](#creating-api-clients)
@@ -21,21 +21,25 @@ Getting Started Docs: https://developer.box.com/guides/tooling/sdks/node/
21
21
  - [App Auth Client](#app-auth-client)
22
22
  - [Using the Client to Make API Calls](#using-the-client-to-make-api-calls)
23
23
  - [Constructing API Calls Manually](#constructing-api-calls-manually)
24
+ - [Versions](#versions)
25
+ - [Supported Version](#supported-version)
26
+ - [Version schedule](#version-schedule)
24
27
  - [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
25
28
  - [Contributing to the Box Node.js SDK](#contributing-to-the-box-nodejs-sdk)
29
+ - [Changelog](#changelog)
26
30
  - [Copyright and License](#copyright-and-license)
27
31
 
28
32
  <!-- END doctoc generated TOC please keep comment here to allow auto update -->
29
33
 
30
- Installation
31
- ------------
34
+ ## Installation
35
+
32
36
 
33
37
  ```
34
38
  npm install --save box-node-sdk
35
39
  ```
36
40
 
37
- Getting Started
38
- ---------------
41
+ ## Getting Started
42
+
39
43
 
40
44
  To get started with the SDK, get a Developer Token from the Configuration page
41
45
  of your app in the [Box Developer Console][dev-console].
@@ -63,8 +67,8 @@ client.users.get(client.CURRENT_USER_ID)
63
67
 
64
68
  [dev-console]: https://app.box.com/developers/console
65
69
 
66
- Creating API Clients
67
- --------------------
70
+ ## Creating API Clients
71
+
68
72
 
69
73
  Clients are used to communicate with the API on behalf of a user.
70
74
 
@@ -72,7 +76,7 @@ Box supports three different types of client:
72
76
 
73
77
  - **Basic Client:** Simple, makes calls via the given access token until the access token expires
74
78
  - **Persistent Client:** For use with traditional OAuth2 apps, can refresh its tokens automatically and persist them via a token store
75
- - **App Auth Client:** Uses the app auth JWT grant to act on behalf of app-managed users and create new tokens automatically
79
+ - **App Auth Client:** Uses the app auth JWT grant to act on behalf of app/managed users and create new tokens automatically
76
80
 
77
81
  ### Basic Client
78
82
 
@@ -130,7 +134,7 @@ var sdk = BoxSDK.getPreconfiguredInstance(sdkConfig);
130
134
  // so you don't need to specify it here
131
135
  var serviceAccountClient = sdk.getAppAuthClient('enterprise');
132
136
 
133
- // Get an app user client
137
+ // Get an app user or managed user client
134
138
  var appUserClient = sdk.getAppAuthClient('user', 'YOUR-APP-USER-ID');
135
139
  ```
136
140
 
@@ -150,13 +154,13 @@ var sdk = new BoxSDK({
150
154
  // Get the service account client, used to create and manage app user accounts
151
155
  var serviceAccountClient = sdk.getAppAuthClient('enterprise', 'APP_ENTERPRISE_ID');
152
156
 
153
- // Get an app user client
157
+ // Get an app user or managed user client
154
158
  var appUserClient = sdk.getAppAuthClient('user', 'YOUR-APP-USER-ID');
155
159
  ```
156
160
 
157
161
 
158
- Using the Client to Make API Calls
159
- ----------------------------------
162
+ ## Using the Client to Make API Calls
163
+
160
164
 
161
165
  The different API endpoints you can call are represented as methods, grouped into
162
166
  managers by the type of object they interact with.
@@ -218,15 +222,31 @@ client.del('/files/123');
218
222
  .catch(error => { /* handle any errors */ });
219
223
  ```
220
224
 
221
- Questions, Bugs, and Feature Requests?
222
- --------------------------------------
225
+ ## Versions
226
+ We use a modified version of [Semantic Versioning](https://semver.org/) for all changes. See [version strategy](VERSIONS.md) for details which is effective from 30 July 2022.
227
+
228
+ ### Supported Version
229
+
230
+ Only the current MAJOR version of SDK is supported. New features, functionality, bug fixes, and security updates will only be added to the current MAJOR version.
231
+
232
+ A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features. Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often). At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade. We always recommend that all users run the latest available minor release for whatever major version is in use. We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.
233
+
234
+ ### Version schedule
235
+
236
+ | Version | Supported Environments | State | First Release | EOL/Terminated |
237
+ |---------|------------------------|-----------|---------------|----------------|
238
+ | 2 | | Supported | 29 Sep 2021 | TBD |
239
+ | 1 | | EOL | 28 Mar 2019 | 29 Sep 2021 |
240
+
241
+ ## Questions, Bugs, and Feature Requests?
242
+
223
243
 
224
244
  [Browse the issues tickets](https://github.com/box/box-node-sdk/issues)! Or, if that doesn't work, [file a new one](https://github.com/box/box-node-sdk/issues/new) and someone will get back to you. If you have general questions about the
225
245
  Box API, you can post to the [Box Developer Forum](https://community.box.com/t5/Developer-Forum/bd-p/DeveloperForum).
226
246
 
227
247
 
228
- Contributing to the Box Node.js SDK
229
- -----------------------------------
248
+ ## Contributing to the Box Node.js SDK
249
+
230
250
 
231
251
  1. Clone this repo.
232
252
  1. Run `npm install`.
@@ -237,8 +257,12 @@ in the `tests/` directory!
237
257
 
238
258
  For more information, please see [the Contribution guidelines](./CONTRIBUTING.md).
239
259
 
240
- Copyright and License
241
- ---------------------
260
+ ## Changelog
261
+
262
+
263
+ See [CHANGELOG.md](./CHANGELOG.md).
264
+
265
+ ## Copyright and License
242
266
 
243
267
  Copyright 2018 Box, Inc. All rights reserved.
244
268
 
@@ -4,7 +4,7 @@
4
4
  /// <reference types="node" />
5
5
  /// <reference types="bluebird" />
6
6
  import { EventEmitter } from 'events';
7
- import AnonymousAPISession = require('./sessions/anonymous-session');
7
+ import CCGAPISession = require('./sessions/ccg-session');
8
8
  import APIRequestManager = require('./api-request-manager');
9
9
  import BoxClient = require('./box-client');
10
10
  import TokenManager = require('./token-manager');
@@ -36,6 +36,10 @@ import TokenManager = require('./token-manager');
36
36
  declare type TokenStore = object;
37
37
  declare type UserConfigurationOptions = object;
38
38
  declare type TokenRequestOptions = object;
39
+ declare type CCGConfig = {
40
+ boxSubjectType: "user" | "enterprise";
41
+ boxSubjectId: string;
42
+ };
39
43
  /**
40
44
  * A backend NodeJS SDK to interact with the Box V2 API.
41
45
  * This is the single entry point for all SDK consumer interactions. This is the only file that a 3rd party app
@@ -57,7 +61,7 @@ declare class BoxSDKNode extends EventEmitter {
57
61
  _eventBus: EventEmitter;
58
62
  requestManager: APIRequestManager;
59
63
  tokenManager: TokenManager;
60
- anonymousSession: AnonymousAPISession;
64
+ ccgSession: CCGAPISession;
61
65
  /**
62
66
  * Expose the BoxClient property enumerations to the SDK as a whole. This allows
63
67
  * the consumer to access and use these values from anywhere in their application
@@ -128,19 +132,28 @@ declare class BoxSDKNode extends EventEmitter {
128
132
  */
129
133
  getPersistentClient(tokenInfo: any, tokenStore?: TokenStore): BoxClient;
130
134
  /**
131
- * Returns A Box Client with an Anonymous API Session. An Anonymous API Session has access to an anonymous
132
- * client-credentials token, which isn't tied to any specific user. Because of this, the client will only
133
- * have access to endpoints that allow client-credential tokens. All Anonymous API Sessions share the
135
+ * Returns a Box Client configured to use Client Credentials Grant for a service account. Requires enterprise ID
136
+ * to be set when configuring SDK instance.
137
+ *
138
+ * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession. All Anonymous API Sessions share the
134
139
  * same tokens, which allows them to refresh them efficiently and reduce load on both the application and
135
140
  * the API.
136
- *
137
- * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession
138
141
  */
139
142
  getAnonymousClient(): BoxClient;
140
143
  /**
141
- * Create a new client using App Auth for the given entity. This allows either
144
+ * Returns a Box Client configured to use Client Credentials Grant for a specified user.
145
+ *
146
+ * @param userId the user ID to use when getting the access token
147
+ * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession. All Anonymous API Sessions share the
148
+ * same tokens, which allows them to refresh them efficiently and reduce load on both the application and
149
+ * the API.
150
+ */
151
+ getCCGClientForUser(userId: string): BoxClient;
152
+ _getCCGClient(config: CCGConfig): BoxClient;
153
+ /**
154
+ * Create a new client using App Auth for the given entity. This allows either
142
155
  * managing App Users (as the enterprise) or performing operations as the App
143
- * Users themselves (as a user).
156
+ * Users or Managed Users themselves (as a user).
144
157
  *
145
158
  * @param {string} type The type of entity to operate as, "enterprise" or "user"
146
159
  * @param {string} [id] (Optional) The Box ID of the entity to operate as
@@ -199,7 +212,7 @@ declare class BoxSDKNode extends EventEmitter {
199
212
  * @param {string} userID The ID of the App User to generate a token for
200
213
  * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
201
214
  * @param {Function} [callback] Passed the tokens if successful
202
- * @returns {Promise<TokentInfo>} Promise reolving to the token infp
215
+ * @returns {Promise<TokentInfo>} Promise resolving to the token info
203
216
  */
204
217
  getAppUserTokens(userID: string, options: TokenRequestOptions | Function | null, callback: Function): import("bluebird")<any>;
205
218
  /**
@@ -17,6 +17,17 @@ var __extends = (this && this.__extends) || (function () {
17
17
  d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
18
18
  };
19
19
  })();
20
+ var __assign = (this && this.__assign) || function () {
21
+ __assign = Object.assign || function(t) {
22
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
23
+ s = arguments[i];
24
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
25
+ t[p] = s[p];
26
+ }
27
+ return t;
28
+ };
29
+ return __assign.apply(this, arguments);
30
+ };
20
31
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
21
32
  if (k2 === undefined) k2 = k;
22
33
  Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
@@ -41,7 +52,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
41
52
  // ------------------------------------------------------------------------------
42
53
  var events_1 = require("events");
43
54
  var qs = __importStar(require("querystring"));
44
- var AnonymousAPISession = require("./sessions/anonymous-session");
55
+ var CCGAPISession = require("./sessions/ccg-session");
45
56
  var APIRequestManager = require("./api-request-manager");
46
57
  var BoxClient = require("./box-client");
47
58
  var TokenManager = require("./token-manager");
@@ -94,7 +105,7 @@ var BoxSDKNode = /** @class */ (function (_super) {
94
105
  this.requestManager = new APIRequestManager(this.config, this._eventBus);
95
106
  // Initialize the rest of the SDK with the given configuration
96
107
  this.tokenManager = new TokenManager(this.config, this.requestManager);
97
- this.anonymousSession = new AnonymousAPISession(this.config, this.tokenManager);
108
+ this.ccgSession = new CCGAPISession(this.config, this.tokenManager);
98
109
  };
99
110
  /**
100
111
  * Gets the BoxSDKNode instance by passing boxAppSettings json downloaded from the developer console.
@@ -190,21 +201,39 @@ var BoxSDKNode = /** @class */ (function (_super) {
190
201
  return new BoxClient(apiSession, this.config, this.requestManager);
191
202
  };
192
203
  /**
193
- * Returns A Box Client with an Anonymous API Session. An Anonymous API Session has access to an anonymous
194
- * client-credentials token, which isn't tied to any specific user. Because of this, the client will only
195
- * have access to endpoints that allow client-credential tokens. All Anonymous API Sessions share the
204
+ * Returns a Box Client configured to use Client Credentials Grant for a service account. Requires enterprise ID
205
+ * to be set when configuring SDK instance.
206
+ *
207
+ * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession. All Anonymous API Sessions share the
196
208
  * same tokens, which allows them to refresh them efficiently and reduce load on both the application and
197
209
  * the API.
198
- *
199
- * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession
200
210
  */
201
211
  BoxSDKNode.prototype.getAnonymousClient = function () {
202
- return new BoxClient(this.anonymousSession, this.config, this.requestManager);
212
+ if (!this.config.enterpriseID) {
213
+ throw new Error('Enterprise ID must be passed');
214
+ }
215
+ return this._getCCGClient({ boxSubjectType: "enterprise", boxSubjectId: this.config.enterpriseID });
216
+ };
217
+ /**
218
+ * Returns a Box Client configured to use Client Credentials Grant for a specified user.
219
+ *
220
+ * @param userId the user ID to use when getting the access token
221
+ * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession. All Anonymous API Sessions share the
222
+ * same tokens, which allows them to refresh them efficiently and reduce load on both the application and
223
+ * the API.
224
+ */
225
+ BoxSDKNode.prototype.getCCGClientForUser = function (userId) {
226
+ return this._getCCGClient({ boxSubjectType: "user", boxSubjectId: userId });
227
+ };
228
+ BoxSDKNode.prototype._getCCGClient = function (config) {
229
+ var anonymousTokenManager = new TokenManager(__assign(__assign({}, this.config), config), this.requestManager);
230
+ var newAnonymousSession = new CCGAPISession(this.config, anonymousTokenManager);
231
+ return new BoxClient(newAnonymousSession, this.config, this.requestManager);
203
232
  };
204
233
  /**
205
- * Create a new client using App Auth for the given entity. This allows either
234
+ * Create a new client using App Auth for the given entity. This allows either
206
235
  * managing App Users (as the enterprise) or performing operations as the App
207
- * Users themselves (as a user).
236
+ * Users or Managed Users themselves (as a user).
208
237
  *
209
238
  * @param {string} type The type of entity to operate as, "enterprise" or "user"
210
239
  * @param {string} [id] (Optional) The Box ID of the entity to operate as
@@ -293,7 +322,7 @@ var BoxSDKNode = /** @class */ (function (_super) {
293
322
  * @param {string} userID The ID of the App User to generate a token for
294
323
  * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
295
324
  * @param {Function} [callback] Passed the tokens if successful
296
- * @returns {Promise<TokentInfo>} Promise reolving to the token infp
325
+ * @returns {Promise<TokentInfo>} Promise resolving to the token info
297
326
  */
298
327
  BoxSDKNode.prototype.getAppUserTokens = function (userID, options, callback) {
299
328
  if (typeof options === 'function') {
@@ -1 +1 @@
1
- {"version":3,"file":"box-node-sdk.js","sourceRoot":"","sources":["../src/box-node-sdk.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,iCAAsC;AACtC,8CAAkC;AAClC,kEAAqE;AACrE,yDAA4D;AAC5D,wCAA2C;AAC3C,8CAAiD;AAEjD,IAAI,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,EACpC,eAAe,GAAG,OAAO,CAAC,0BAA0B,CAAC,EACrD,oBAAoB,GAAG,OAAO,CAAC,+BAA+B,CAAC,EAC/D,cAAc,GAAG,OAAO,CAAC,6BAA6B,CAAC,EACvD,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAuC3C,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;GAYG;AACH;IAAyB,8BAAY;IA2BpC,oBAAY,MAAgC;QAA5C,YACC,iBAAO,SAeP;QAbA,IAAI,QAAQ,GAAG,IAAI,qBAAY,EAAE,CAAC;QAElC,IAAI,IAAI,GAAG,KAAI,CAAC;QAChB,QAAQ,CAAC,EAAE,CAAC,UAAU,EAAE;YACvB,IAAI,IAAI,GAAoB,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,gDAAgD;QAChD,KAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,KAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,KAAI,CAAC,MAAM,EAAE,CAAC;;IACf,CAAC;IAED;;;;;;OAMG;IACH,2BAAM,GAAN;QACC,kCAAkC;QAClC,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEzE,8DAA8D;QAC9D,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACvE,IAAI,CAAC,gBAAgB,GAAG,IAAI,mBAAmB,CAC9C,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,CACjB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,mCAAwB,GAA/B,UAAgC,SAAc,CAAC,WAAW;QACzD,IAAI,OAAO,SAAS,CAAC,cAAc,KAAK,QAAQ,EAAE;YACjD,MAAM,IAAI,SAAS,CAClB,uDAAuD,CACvD,CAAC;SACF;QAED,IAAI,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;QAC9C,IAAI,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QAClC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YACjC,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;SACtE;QAED,IAAI,MAAM,GASN,EAAE,CAAC;QAEP,IAAI,OAAO,cAAc,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAChD,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SAC1C;QAED,IAAI,OAAO,cAAc,CAAC,YAAY,KAAK,QAAQ,EAAE;YACpD,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC;SAClD;QAED,2DAA2D;QAC3D,wFAAwF;QACxF,IACC,OAAO,cAAc,CAAC,OAAO,KAAK,QAAQ;YAC1C,cAAc,CAAC,OAAO,CAAC,WAAW,EACjC;YACD,MAAM,CAAC,OAAO,GAAG;gBAChB,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,WAAW;gBACzC,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,UAAU;aAC7C,CAAC;YAEF,IAAM,UAAU,GAAG,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC;YACrD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;gBACnC,MAAM,CAAC,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;aACvC;SACD;QAED,IAAI,OAAO,SAAS,CAAC,YAAY,KAAK,QAAQ,EAAE;YAC/C,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;SAC7C;QAED,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,8BAAS,GAAT,UAAU,MAAgC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACH,mCAAc,GAAd,UAAe,WAAmB;QACjC,IAAI,UAAU,GAAG,IAAI,eAAe,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACrE,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACI,yBAAc,GAArB,UAAsB,WAAmB;QACxC,OAAO,IAAI,UAAU,CAAC;YACrB,QAAQ,EAAE,EAAE;YACZ,YAAY,EAAE,EAAE;SAChB,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,wCAAmB,GAAnB,UAAoB,SAAc,CAAC,WAAW,EAAE,UAAuB;QACtE,IAAI,UAAU,GAAG,IAAI,oBAAoB,CACxC,SAAS,EACT,UAAU,EACV,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,CACjB,CAAC;QACF,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,uCAAkB,GAAlB;QACC,OAAO,IAAI,SAAS,CACnB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,cAAc,CACnB,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,qCAAgB,GAAhB,UAAiB,IAAY,EAAE,EAAW,EAAE,UAAuB;QAClE,IAAI,IAAI,KAAK,YAAY,IAAI,CAAC,EAAE,EAAE;YACjC,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;gBAC7B,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;aAC9B;iBAAM;gBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aAChD;SACD;QAED,IAAI,cAAc,GAAG,IAAI,cAAc,CACtC,IAAI,EACJ,EAAE,EACF,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,EACjB,UAAU,CACV,CAAC;QACF,OAAO,IAAI,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,oCAAe,GAAf,UAAgB,MAA8B;QAC7C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAExC,OAAU,IAAI,CAAC,MAAM,CAAC,gBAAgB,0BAAqB,EAAE,CAAC,SAAS,CACtE,MAAM,CACJ,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,oDAA+B,GAA/B,UACC,iBAAyB,EACzB,OAAmC,EACnC,QAAkB;QAElB,OAAO,IAAI,CAAC,YAAY;aACtB,+BAA+B,CAC/B,iBAAiB,EACjB,OAAc,CAAC,WAAW,CAC1B;aACA,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,0CAAqB,GAArB,UACC,YAAoB,EACpB,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,qBAAqB,CAAC,YAAY,EAAE,OAAc,CAAC,WAAW,CAAC;aAC/D,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,+CAA0B,GAA1B,UACC,YAAoB,EACpB,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,IAAI,CAAC,YAAY,EAAE;YAClB,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;gBAC7B,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;aACxC;iBAAM;gBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aAChD;SACD;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,iBAAiB,CAAC,YAAY,EAAE,YAAY,EAAE,OAAc,CAAC,WAAW,CAAC;aACzE,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,qCAAgB,GAAhB,UACC,MAAc,EACd,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAc,CAAC,WAAW,CAAC;aAC7D,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,iCAAY,GAAZ,UACC,KAAa,EACb,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,YAAY,CAAC,KAAK,EAAE,OAAc,CAAC,WAAW,CAAC;aAC/C,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAnWD;;;;OAIG;IACI,uBAAY,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;IACjD,6BAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC;IAC7D,0BAAe,GAAG,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC;IAE9D;;;;OAIG;IACI,iCAAsB,GAAG,QAAQ,CAAC,eAAe,CAAC;IAsV1D,iBAAC;CAAA,AA/WD,CAAyB,qBAAY,GA+WpC;AAED;;;;GAIG;AACH,UAAU,CAAC,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC;AACrE,UAAU,CAAC,SAAS,CAAC,kBAAkB;IACtC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC;AACxC,UAAU,CAAC,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC;AAG3E,iBAAS,UAAU,CAAC"}
1
+ {"version":3,"file":"box-node-sdk.js","sourceRoot":"","sources":["../src/box-node-sdk.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,iCAAsC;AACtC,8CAAkC;AAClC,sDAAyD;AACzD,yDAA4D;AAC5D,wCAA2C;AAC3C,8CAAiD;AAEjD,IAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,EACtC,eAAe,GAAG,OAAO,CAAC,0BAA0B,CAAC,EACrD,oBAAoB,GAAG,OAAO,CAAC,+BAA+B,CAAC,EAC/D,cAAc,GAAG,OAAO,CAAC,6BAA6B,CAAC,EACvD,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;AA2C3C,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;GAYG;AACH;IAAyB,8BAAY;IA2BpC,oBAAY,MAAgC;QAA5C,YACC,iBAAO,SAeP;QAbA,IAAM,QAAQ,GAAG,IAAI,qBAAY,EAAE,CAAC;QAEpC,IAAM,IAAI,GAAG,KAAI,CAAC;QAClB,QAAQ,CAAC,EAAE,CAAC,UAAU,EAAE;YACvB,IAAM,IAAI,GAAoB,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvD,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,gDAAgD;QAChD,KAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,KAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,KAAI,CAAC,MAAM,EAAE,CAAC;;IACf,CAAC;IAED;;;;;;OAMG;IACH,2BAAM,GAAN;QACC,kCAAkC;QAClC,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEzE,8DAA8D;QAC9D,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACvE,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAClC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,CACjB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,mCAAwB,GAA/B,UAAgC,SAAc,CAAC,WAAW;QACzD,IAAI,OAAO,SAAS,CAAC,cAAc,KAAK,QAAQ,EAAE;YACjD,MAAM,IAAI,SAAS,CAClB,uDAAuD,CACvD,CAAC;SACF;QAED,IAAM,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;QAChD,IAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QACpC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YACjC,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;SACtE;QAED,IAAM,MAAM,GASR,EAAE,CAAC;QAEP,IAAI,OAAO,cAAc,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAChD,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SAC1C;QAED,IAAI,OAAO,cAAc,CAAC,YAAY,KAAK,QAAQ,EAAE;YACpD,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC;SAClD;QAED,2DAA2D;QAC3D,wFAAwF;QACxF,IACC,OAAO,cAAc,CAAC,OAAO,KAAK,QAAQ;YAC1C,cAAc,CAAC,OAAO,CAAC,WAAW,EACjC;YACD,MAAM,CAAC,OAAO,GAAG;gBAChB,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,WAAW;gBACzC,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,UAAU;aAC7C,CAAC;YAEF,IAAM,UAAU,GAAG,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC;YACrD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;gBACnC,MAAM,CAAC,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;aACvC;SACD;QAED,IAAI,OAAO,SAAS,CAAC,YAAY,KAAK,QAAQ,EAAE;YAC/C,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;SAC7C;QAED,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,8BAAS,GAAT,UAAU,MAAgC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACH,mCAAc,GAAd,UAAe,WAAmB;QACjC,IAAM,UAAU,GAAG,IAAI,eAAe,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACvE,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACI,yBAAc,GAArB,UAAsB,WAAmB;QACxC,OAAO,IAAI,UAAU,CAAC;YACrB,QAAQ,EAAE,EAAE;YACZ,YAAY,EAAE,EAAE;SAChB,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,wCAAmB,GAAnB,UAAoB,SAAc,CAAC,WAAW,EAAE,UAAuB;QACtE,IAAM,UAAU,GAAG,IAAI,oBAAoB,CAC1C,SAAS,EACT,UAAU,EACV,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,CACjB,CAAC;QACF,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,uCAAkB,GAAlB;QACC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SAChD;QACD,OAAO,IAAI,CAAC,aAAa,CAAC,EAAC,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY,EAAC,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,wCAAmB,GAAnB,UAAoB,MAAc;QACjC,OAAO,IAAI,CAAC,aAAa,CAAC,EAAC,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAC,CAAC,CAAA;IAC1E,CAAC;IAED,kCAAa,GAAb,UAAc,MAAiB;QAC9B,IAAM,qBAAqB,GAAG,IAAI,YAAY,uBAEzC,IAAI,CAAC,MAAM,GACX,MAAM,GAEV,IAAI,CAAC,cAAc,CACnB,CAAC;QACF,IAAM,mBAAmB,GAAG,IAAI,aAAa,CAC5C,IAAI,CAAC,MAAM,EACX,qBAAqB,CACrB,CAAC;QACF,OAAO,IAAI,SAAS,CACnB,mBAAmB,EACnB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,cAAc,CACnB,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,qCAAgB,GAAhB,UAAiB,IAAY,EAAE,EAAW,EAAE,UAAuB;QAClE,IAAI,IAAI,KAAK,YAAY,IAAI,CAAC,EAAE,EAAE;YACjC,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;gBAC7B,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;aAC9B;iBAAM;gBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aAChD;SACD;QAED,IAAM,cAAc,GAAG,IAAI,cAAc,CACxC,IAAI,EACJ,EAAE,EACF,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,EACjB,UAAU,CACV,CAAC;QACF,OAAO,IAAI,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,oCAAe,GAAf,UAAgB,MAA8B;QAC7C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAExC,OAAU,IAAI,CAAC,MAAM,CAAC,gBAAgB,0BAAqB,EAAE,CAAC,SAAS,CACtE,MAAM,CACJ,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,oDAA+B,GAA/B,UACC,iBAAyB,EACzB,OAAmC,EACnC,QAAkB;QAElB,OAAO,IAAI,CAAC,YAAY;aACtB,+BAA+B,CAC/B,iBAAiB,EACjB,OAAc,CAAC,WAAW,CAC1B;aACA,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,0CAAqB,GAArB,UACC,YAAoB,EACpB,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,qBAAqB,CAAC,YAAY,EAAE,OAAc,CAAC,WAAW,CAAC;aAC/D,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,+CAA0B,GAA1B,UACC,YAAoB,EACpB,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,IAAI,CAAC,YAAY,EAAE;YAClB,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;gBAC7B,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;aACxC;iBAAM;gBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aAChD;SACD;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,iBAAiB,CAAC,YAAY,EAAE,YAAY,EAAE,OAAc,CAAC,WAAW,CAAC;aACzE,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,qCAAgB,GAAhB,UACC,MAAc,EACd,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAc,CAAC,WAAW,CAAC;aAC7D,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,iCAAY,GAAZ,UACC,KAAa,EACb,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,YAAY,CAAC,KAAK,EAAE,OAAc,CAAC,WAAW,CAAC;aAC/C,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAhYD;;;;OAIG;IACI,uBAAY,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;IACjD,6BAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC;IAC7D,0BAAe,GAAG,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC;IAE9D;;;;OAIG;IACI,iCAAsB,GAAG,QAAQ,CAAC,eAAe,CAAC;IAmX1D,iBAAC;CAAA,AA5YD,CAAyB,qBAAY,GA4YpC;AAED;;;;GAIG;AACH,UAAU,CAAC,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC;AACrE,UAAU,CAAC,SAAS,CAAC,kBAAkB;IACtC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC;AACxC,UAAU,CAAC,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC;AAG3E,iBAAS,UAAU,CAAC"}
@@ -201,7 +201,9 @@ declare class Metadata {
201
201
  */
202
202
  forceApplyCascadePolicy(policyID: string, resolutionMethod: string, callback?: Function): any;
203
203
  /**
204
- * Query Box items by their metadata
204
+ * Query Box items by their metadata.
205
+ * We no longer require the index_name/use_index for queries that leverage indexes,
206
+ * internal analysis engine determines which existing index will satisfy the query.
205
207
  *
206
208
  * API Endpoint: '/metadata_queries/execute_read'
207
209
  * Method: POST
@@ -211,7 +213,7 @@ declare class Metadata {
211
213
  * @param {Object} [options] - Optional parameters
212
214
  * @param {string} [options.query] - The logical expression of the query
213
215
  * @param {Object} [options.query_parameters] - Required if query present. The arguments for the query
214
- * @param {string} [options.index_name] - The name of the Index to use
216
+ * @param {string} [options.index_name] - DEPRECATED: This parameter is ignored. The name of the index to use
215
217
  * @param {Object} [options.order_by] - The field_key(s) to order on and the corresponding direction(s)
216
218
  * @param {Array} [options.fields] - An array of fields to return
217
219
  * @param {Function} [callback] - Passed a collection of items and their associated metadata
@@ -2,6 +2,17 @@
2
2
  /**
3
3
  * @fileoverview Manager for the Box Metadata Resource
4
4
  */
5
+ var __rest = (this && this.__rest) || function (s, e) {
6
+ var t = {};
7
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
8
+ t[p] = s[p];
9
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
10
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
11
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
12
+ t[p[i]] = s[p[i]];
13
+ }
14
+ return t;
15
+ };
5
16
  var __importDefault = (this && this.__importDefault) || function (mod) {
6
17
  return (mod && mod.__esModule) ? mod : { "default": mod };
7
18
  };
@@ -239,7 +250,9 @@ var Metadata = /** @class */ (function () {
239
250
  return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
240
251
  };
241
252
  /**
242
- * Query Box items by their metadata
253
+ * Query Box items by their metadata.
254
+ * We no longer require the index_name/use_index for queries that leverage indexes,
255
+ * internal analysis engine determines which existing index will satisfy the query.
243
256
  *
244
257
  * API Endpoint: '/metadata_queries/execute_read'
245
258
  * Method: POST
@@ -249,7 +262,7 @@ var Metadata = /** @class */ (function () {
249
262
  * @param {Object} [options] - Optional parameters
250
263
  * @param {string} [options.query] - The logical expression of the query
251
264
  * @param {Object} [options.query_parameters] - Required if query present. The arguments for the query
252
- * @param {string} [options.index_name] - The name of the Index to use
265
+ * @param {string} [options.index_name] - DEPRECATED: This parameter is ignored. The name of the index to use
253
266
  * @param {Object} [options.order_by] - The field_key(s) to order on and the corresponding direction(s)
254
267
  * @param {Array} [options.fields] - An array of fields to return
255
268
  * @param {Function} [callback] - Passed a collection of items and their associated metadata
@@ -260,8 +273,9 @@ var Metadata = /** @class */ (function () {
260
273
  from: from,
261
274
  ancestor_folder_id: ancestorFolderId,
262
275
  };
276
+ var _a = options !== null && options !== void 0 ? options : {}, indexName = _a.index_name, newOptions = __rest(_a, ["index_name"]);
263
277
  var params = {
264
- body: merge(body, options),
278
+ body: merge(body, newOptions),
265
279
  };
266
280
  return this.client.wrapWithDefaultHandler(this.client.post)(QUERY_PATH, params, callback);
267
281
  };
@@ -1 +1 @@
1
- {"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/managers/metadata.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,8DAAuC;AACvC,IAAM,KAAK,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;GAIG;AACH,IAAK,iBAMJ;AAND,WAAK,iBAAiB;IACrB,sCAAiB,CAAA;IACjB,kCAAa,CAAA;IACb,qCAAgB,CAAA;IAChB,kCAAa,CAAA;IACb,iDAA4B,CAAA;AAC7B,CAAC,EANI,iBAAiB,KAAjB,iBAAiB,QAMrB;AA0BD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAChF,IAAM,mBAAmB,GAAG,YAAY,EACvC,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;AAE/C,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH;IAQC,kBAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACH,oCAAiB,GAAjB,UAAkB,KAAa,EAAE,QAAgB,EAAE,QAAmB;QACrE,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,kCAAe,GAAf,UAAgB,UAAkB,EAAE,QAAmB;QACtD,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,+BAAY,GAAZ,UAAa,KAAa,EAAE,QAAmB;QAC9C,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,iCAAc,GAAd,UACC,YAAoB,EACpB,MAA+B,EAC/B,OAKC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,kBAAkB,CAAC,EACnD,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,KAAK,EAAE,gBAAgB;gBACvB,WAAW,EAAE,YAAY;gBACzB,MAAM,QAAA;aACN;SACD,CAAC;QAEH,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,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,iCAAc,GAAd,UACC,KAAa,EACb,QAAgB,EAChB,UAAiC,EACjC,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,CAAC,EACpE,MAAM,GAAG;YACR,IAAI,EAAE,UAAU;SAChB,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iCAAc,GAAd,UAAe,KAAa,EAAE,QAAgB,EAAE,QAAmB;QAClE,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,qCAAkB,GAAlB,UACC,QAAgB,EAChB,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,CAAC,EAC3C,MAAM,GAAG;YACR,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC;SACnD,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,mCAAgB,GAAhB,UAAiB,QAAgB,EAAE,QAAmB;QACrD,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,sCAAmB,GAAnB,UACC,KAAa,EACb,WAAmB,EACnB,QAAgB,EAChB,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,CAAC,EAC3C,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,SAAS,EAAE,QAAQ;gBACnB,KAAK,OAAA;gBACL,WAAW,aAAA;aACX;SACD,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,sCAAmB,GAAnB,UAAoB,QAAgB,EAAE,QAAmB;QACxD,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,0CAAuB,GAAvB,UACC,QAAgB,EAChB,gBAAwB,EACxB,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,EAAE,QAAQ,EAAE,OAAO,CAAC,EAC9D,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,mBAAmB,EAAE,gBAAgB;aACrC;SACD,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,wBAAK,GAAL,UACC,IAAY,EACZ,gBAAwB,EACxB,OAMC,EACD,QAAmB;QAEnB,IAAI,IAAI,GAAG;YACV,IAAI,MAAA;YACJ,kBAAkB,EAAE,gBAAgB;SACpC,CAAC;QAEF,IAAI,MAAM,GAAG;YACZ,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC;SAC1B,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,UAAU,EACV,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACF,eAAC;AAAD,CAAC,AA9VD,IA8VC;AAED,QAAQ,CAAC,SAAS,CAAC,SAAS,GAAG;IAC9B,UAAU,EAAE,mBAAmB;CAC/B,CAAC;AAEF,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG;IAC3B,UAAU,EAAE,gBAAgB;IAC5B,MAAM,EAAE,YAAY;CACpB,CAAC;AAEF,QAAQ,CAAC,SAAS,CAAC,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,iBAAiB,EAAE,MAAM;IACzB,SAAS,EAAE,WAAW;CACtB,CAAC,CAAC;AAEH;;;;GAIG;AACH,QAAQ,CAAC,SAAS,CAAC,UAAU,GAAG,iBAAiB,CAAC;AAElD,iBAAS,QAAQ,CAAC"}
1
+ {"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/managers/metadata.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;AAOH,8DAAuC;AACvC,IAAM,KAAK,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;GAIG;AACH,IAAK,iBAMJ;AAND,WAAK,iBAAiB;IACrB,sCAAiB,CAAA;IACjB,kCAAa,CAAA;IACb,qCAAgB,CAAA;IAChB,kCAAa,CAAA;IACb,iDAA4B,CAAA;AAC7B,CAAC,EANI,iBAAiB,KAAjB,iBAAiB,QAMrB;AA0BD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAChF,IAAM,mBAAmB,GAAG,YAAY,EACvC,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;AAE/C,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH;IAQC,kBAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACH,oCAAiB,GAAjB,UAAkB,KAAa,EAAE,QAAgB,EAAE,QAAmB;QACrE,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,kCAAe,GAAf,UAAgB,UAAkB,EAAE,QAAmB;QACtD,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,+BAAY,GAAZ,UAAa,KAAa,EAAE,QAAmB;QAC9C,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,iCAAc,GAAd,UACC,YAAoB,EACpB,MAA+B,EAC/B,OAKC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,kBAAkB,CAAC,EACnD,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,KAAK,EAAE,gBAAgB;gBACvB,WAAW,EAAE,YAAY;gBACzB,MAAM,QAAA;aACN;SACD,CAAC;QAEH,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,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,iCAAc,GAAd,UACC,KAAa,EACb,QAAgB,EAChB,UAAiC,EACjC,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,CAAC,EACpE,MAAM,GAAG;YACR,IAAI,EAAE,UAAU;SAChB,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iCAAc,GAAd,UAAe,KAAa,EAAE,QAAgB,EAAE,QAAmB;QAClE,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,qCAAkB,GAAlB,UACC,QAAgB,EAChB,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,CAAC,EAC3C,MAAM,GAAG;YACR,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC;SACnD,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,mCAAgB,GAAhB,UAAiB,QAAgB,EAAE,QAAmB;QACrD,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,sCAAmB,GAAnB,UACC,KAAa,EACb,WAAmB,EACnB,QAAgB,EAChB,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,CAAC,EAC3C,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,SAAS,EAAE,QAAQ;gBACnB,KAAK,OAAA;gBACL,WAAW,aAAA;aACX;SACD,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,sCAAmB,GAAnB,UAAoB,QAAgB,EAAE,QAAmB;QACxD,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,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,0CAAuB,GAAvB,UACC,QAAgB,EAChB,gBAAwB,EACxB,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,qBAAqB,EAAE,QAAQ,EAAE,OAAO,CAAC,EAC9D,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,mBAAmB,EAAE,gBAAgB;aACrC;SACD,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,wBAAK,GAAL,UACC,IAAY,EACZ,gBAAwB,EACxB,OAMC,EACD,QAAmB;QAEnB,IAAI,IAAI,GAAG;YACV,IAAI,MAAA;YACJ,kBAAkB,EAAE,gBAAgB;SACpC,CAAC;QAEF,IAAM,KAA2C,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,EAA1C,SAAS,gBAAA,EAAK,UAAU,cAAtC,cAAwC,CAAgB,CAAC;QAE/D,IAAI,MAAM,GAAG;YACZ,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC;SAC7B,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,UAAU,EACV,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACF,eAAC;AAAD,CAAC,AAlWD,IAkWC;AAED,QAAQ,CAAC,SAAS,CAAC,SAAS,GAAG;IAC9B,UAAU,EAAE,mBAAmB;CAC/B,CAAC;AAEF,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG;IAC3B,UAAU,EAAE,gBAAgB;IAC5B,MAAM,EAAE,YAAY;CACpB,CAAC;AAEF,QAAQ,CAAC,SAAS,CAAC,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,iBAAiB,EAAE,MAAM;IACzB,SAAS,EAAE,WAAW;CACtB,CAAC,CAAC;AAEH;;;;GAIG;AACH,QAAQ,CAAC,SAAS,CAAC,UAAU,GAAG,iBAAiB,CAAC;AAElD,iBAAS,QAAQ,CAAC"}
@@ -4,10 +4,10 @@ export * from './file-version-base.generated';
4
4
  export * from './file-version-mini.generated';
5
5
  export * from './folder-base.generated';
6
6
  export * from './folder-mini.generated';
7
- export * from './sign-request.generated';
8
7
  export * from './sign-request-create-request.generated';
9
8
  export * from './sign-request-create-signer.generated';
10
9
  export * from './sign-request-prefill-tag.generated';
11
- export * from './sign-requests.generated';
12
- export * from './sign-request-signer.generated';
13
10
  export * from './sign-request-signer-input.generated';
11
+ export * from './sign-request-signer.generated';
12
+ export * from './sign-request.generated';
13
+ export * from './sign-requests.generated';
@@ -16,11 +16,11 @@ __exportStar(require("./file-version-base.generated"), exports);
16
16
  __exportStar(require("./file-version-mini.generated"), exports);
17
17
  __exportStar(require("./folder-base.generated"), exports);
18
18
  __exportStar(require("./folder-mini.generated"), exports);
19
- __exportStar(require("./sign-request.generated"), exports);
20
19
  __exportStar(require("./sign-request-create-request.generated"), exports);
21
20
  __exportStar(require("./sign-request-create-signer.generated"), exports);
22
21
  __exportStar(require("./sign-request-prefill-tag.generated"), exports);
23
- __exportStar(require("./sign-requests.generated"), exports);
24
- __exportStar(require("./sign-request-signer.generated"), exports);
25
22
  __exportStar(require("./sign-request-signer-input.generated"), exports);
23
+ __exportStar(require("./sign-request-signer.generated"), exports);
24
+ __exportStar(require("./sign-request.generated"), exports);
25
+ __exportStar(require("./sign-requests.generated"), exports);
26
26
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAsC;AACtC,wDAAsC;AACtC,gEAA8C;AAC9C,gEAA8C;AAC9C,0DAAwC;AACxC,0DAAwC;AACxC,2DAAyC;AACzC,0EAAwD;AACxD,yEAAuD;AACvD,uEAAqD;AACrD,4DAA0C;AAC1C,kEAAgD;AAChD,wEAAsD"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAsC;AACtC,wDAAsC;AACtC,gEAA8C;AAC9C,gEAA8C;AAC9C,0DAAwC;AACxC,0DAAwC;AACxC,0EAAwD;AACxD,yEAAuD;AACvD,uEAAqD;AACrD,wEAAsD;AACtD,kEAAgD;AAChD,2DAAyC;AACzC,4DAA0C"}
@@ -6,12 +6,12 @@ declare type TokenManager = any;
6
6
  declare type TokenInfo = any;
7
7
  declare type TokenRequestOptions = any;
8
8
  /**
9
- * An Anonymous Box API Session.
9
+ * The Client Credentials Grant Box API Session.
10
10
  *
11
- * The Anonymous API Session holds a Client Credentials accessToken, which it
12
- * returns to the client so that it may make calls on behalf of anonymous users.
11
+ * The Client Credentials Grant API Session holds a Client Credentials accessToken, which it
12
+ * returns to the client so that it may make calls on behalf of service account or specified users.
13
13
  *
14
- * Anonymous tokens will be refreshed in the background if a request is made within the
14
+ * Tokens will be refreshed in the background if a request is made within the
15
15
  * "stale buffer" (defaults to 10 minutes before the token is set to expire).
16
16
  * If the token is also expired, all incoming requests will be held until a fresh token
17
17
  * is retrieved.
@@ -20,21 +20,21 @@ declare type TokenRequestOptions = any;
20
20
  * @param {TokenManager} tokenManager The TokenManager
21
21
  * @constructor
22
22
  */
23
- declare class AnonymousSession {
23
+ declare class CCGSession {
24
24
  _config: Config;
25
25
  _tokenManager: TokenManager;
26
26
  _tokenInfo: TokenInfo;
27
27
  _refreshPromise: Promise<any> | null;
28
28
  constructor(config: Config, tokenManager: TokenManager);
29
29
  /**
30
- * Initiate a refresh of the anonymous access tokens. New tokens should be passed to the
30
+ * Initiate a refresh of the access tokens. New tokens should be passed to the
31
31
  * caller, and then cached for later use.
32
32
  *
33
33
  * @param {?TokenRequestOptions} [options] - Sets optional behavior for the token grant
34
34
  * @returns {Promise<string>} Promise resolving to the access token
35
35
  * @private
36
36
  */
37
- _refreshAnonymousAccessToken(options?: TokenRequestOptions): Promise<any>;
37
+ _refreshAccessToken(options?: TokenRequestOptions): Promise<any>;
38
38
  /**
39
39
  * Produces a valid, anonymous access token.
40
40
  * Performs a refresh before returning if the current token is expired. If the current
@@ -53,17 +53,20 @@ declare class AnonymousSession {
53
53
  */
54
54
  revokeTokens(options?: TokenRequestOptions): any;
55
55
  /**
56
- * Return the anonymous session token, since there is no need to downscope a
57
- * token that does not have any associated user credentials.
56
+ * Exchange the client access token for one with lower scope
57
+ *
58
58
  * @param {string|string[]} scopes The scope(s) requested for the new token
59
59
  * @param {string} [resource] The absolute URL of an API resource to scope the new token to
60
- * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
61
- * @returns {Promise<TokenInfo>} Promise resolving to the new token info
60
+ * @param {Object} [options] - Optional parameters
61
+ * @param {TokenRequestOptions} [options.tokenRequestOptions] - Sets optional behavior for the token grant
62
+ * @returns {void}
62
63
  */
63
- exchangeToken(scopes: string | string[], resource?: string, options?: TokenRequestOptions): Promise<any>;
64
+ exchangeToken(scopes: string | string[], resource?: string, options?: {
65
+ tokenRequestOptions?: TokenRequestOptions;
66
+ }): Promise<any>;
64
67
  }
65
68
  /**
66
- * @module box-node-sdk/lib/sessions/anonymous-session
67
- * @see {@Link AnonymousSession}
69
+ * @module box-node-sdk/lib/sessions/ccg-session
70
+ * @see {@Link CCGSession}
68
71
  */
69
- export = AnonymousSession;
72
+ export = CCGSession;