files.com 1.2.190 → 1.2.192

package/README.md

@@ -63,12 +63,14 @@ To initiate a support conversation, you can send an [Authenticated Support Reque
 
 ## Authentication
 
+There are two ways to authenticate: API Key authentication and Session-based authentication.
+
 ### Authenticate with an API Key
 
 Authenticating with an API key is the recommended authentication method for most scenarios, and is
 the method used in the examples on this site.
 
-To use the API or SDKs with an API Key, first generate an API key from the [web
+To use an API Key, first generate an API key from the [web
 interface](https://www.files.com/docs/sdk-and-apis/api-keys) or [via the API or an
 SDK](/javascript/resources/developers/api-keys).
 
@@ -90,14 +92,14 @@ Don't forget to replace the placeholder, `YOUR_API_KEY`, with your actual API ke
 
 ### Authenticate with a Session
 
-You can also authenticate to the REST API or SDKs by creating a user session using the username and
+You can also authenticate by creating a user session using the username and
 password of an active user. If the user is an administrator, the session will have full access to
-the entire API. Sessions created from regular user accounts will only be able to access files that
+all capabilities of Files.com. Sessions created from regular user accounts will only be able to access files that
 user can access, and no access will be granted to site administration functions.
 
-API sessions use the exact same session timeout settings as web interface sessions. When an API
+Sessions use the exact same session timeout settings as web interface sessions. When a
 session times out, simply create a new session and resume where you left off. This process is not
-automatically handled by SDKs because we do not want to store password information in memory without
+automatically handled by our SDKs because we do not want to store password information in memory without
 your explicit consent.
 
 #### Logging In
@@ -136,6 +138,8 @@ await Session.destroy();
 
 ## Configuration
 
+Global configuration is performed by calling methods on the `Files` object.
+
 ### Configuration Options
 
 #### Base URL

package/_VERSION

@@ -1 +1 @@
-1.2.190
+1.2.192

package/docs/models/As2Station.md

@@ -50,6 +50,7 @@ await As2Station.list
 
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
 
 ---
 

package/docs/models/Bundle.md

@@ -150,7 +150,7 @@ await Bundle.list({
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
 
 ---
 

package/docs/models/BundleRegistration.md

@@ -51,4 +51,5 @@ await BundleRegistration.list({
 
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
 * `bundle_id` (int64): ID of the associated Bundle

package/docs/models/Clickwrap.md

@@ -33,6 +33,7 @@ await Clickwrap.list
 
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
 
 ---
 

package/docs/models/MessageComment.md

@@ -37,6 +37,7 @@ await MessageComment.list({
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
 * `message_id` (int64): Required - Message comment to return comments for.
 
 ---

package/docs/models/MessageCommentReaction.md

@@ -30,6 +30,7 @@ await MessageCommentReaction.list({
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
 * `message_comment_id` (int64): Required - Message comment to return reactions for.
 
 ---

package/docs/models/SsoStrategy.md

@@ -113,6 +113,7 @@ await SsoStrategy.list
 
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
 
 ---
 

package/lib/Files.js

@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
-var version = '1.2.190';
+var version = '1.2.192';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/As2Station.js

@@ -323,6 +323,7 @@ _As2Station = As2Station;
 // Parameters:
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
 (0, _defineProperty2.default)(As2Station, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
   var _response$data;
   var params,

package/lib/models/Bundle.js

@@ -684,7 +684,7 @@ _Bundle = Bundle;
 //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
 (0, _defineProperty2.default)(Bundle, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee5() {
   var _response$data;
   var params,

package/lib/models/BundleRegistration.js

@@ -102,6 +102,7 @@ _BundleRegistration = BundleRegistration;
 // Parameters:
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
 //   bundle_id - int64 - ID of the associated Bundle
 (0, _defineProperty2.default)(BundleRegistration, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;

package/lib/models/Clickwrap.js

@@ -260,6 +260,7 @@ _Clickwrap = Clickwrap;
 // Parameters:
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
 (0, _defineProperty2.default)(Clickwrap, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
   var _response$data;
   var params,

package/lib/models/MessageComment.js

@@ -233,6 +233,7 @@ _MessageComment = MessageComment;
 //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
 //   message_id (required) - int64 - Message comment to return comments for.
 (0, _defineProperty2.default)(MessageComment, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
   var _response$data;

package/lib/models/MessageCommentReaction.js

@@ -147,6 +147,7 @@ _MessageCommentReaction = MessageCommentReaction;
 //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
 //   message_comment_id (required) - int64 - Message comment to return reactions for.
 (0, _defineProperty2.default)(MessageCommentReaction, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee3() {
   var _response$data;

package/lib/models/SsoStrategy.js

@@ -283,6 +283,7 @@ _SsoStrategy = SsoStrategy;
 // Parameters:
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
 (0, _defineProperty2.default)(SsoStrategy, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee2() {
   var _response$data;
   var params,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.190",
+  "version": "1.2.192",
   "description": "Files.com SDK for JavaScript",
   "keywords": [
     "files.com",

package/src/Files.js

@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
-const version = '1.2.190'
+const version = '1.2.192'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/As2Station.js

@@ -231,6 +231,7 @@ class As2Station {
   // Parameters:
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
   static list = async (params = {}, options = {}) => {
     if (params.cursor && !isString(params.cursor)) {
       throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)

package/src/models/Bundle.js

@@ -542,7 +542,7 @@ class Bundle {
   //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
   static list = async (params = {}, options = {}) => {
     if (params.user_id && !isInt(params.user_id)) {
       throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params.user_id)}`)

package/src/models/BundleRegistration.js

@@ -70,6 +70,7 @@ class BundleRegistration {
   // Parameters:
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
   //   bundle_id - int64 - ID of the associated Bundle
   static list = async (params = {}, options = {}) => {
     if (params.cursor && !isString(params.cursor)) {

package/src/models/Clickwrap.js

@@ -166,6 +166,7 @@ class Clickwrap {
   // Parameters:
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
   static list = async (params = {}, options = {}) => {
     if (params.cursor && !isString(params.cursor)) {
       throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)

package/src/models/MessageComment.js

@@ -141,6 +141,7 @@ class MessageComment {
   //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
   //   message_id (required) - int64 - Message comment to return comments for.
   static list = async (params = {}, options = {}) => {
     if (!params.message_id) {

package/src/models/MessageCommentReaction.js

@@ -91,6 +91,7 @@ class MessageCommentReaction {
   //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
   //   message_comment_id (required) - int64 - Message comment to return reactions for.
   static list = async (params = {}, options = {}) => {
     if (!params.message_comment_id) {

package/src/models/SsoStrategy.js

@@ -195,6 +195,7 @@ class SsoStrategy {
   // Parameters:
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
   static list = async (params = {}, options = {}) => {
     if (params.cursor && !isString(params.cursor)) {
       throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)