files.com 1.2.103 → 1.2.105

package/README.md

@@ -1,23 +1,29 @@
 # Files.com JavaScript SDK
 
-The Files.com JavaScript SDK provides convenient access to the Files.com API from applications written in JavaScript.
+The content included here should be enough to get started, but please visit our
+[Developer Documentation Website](https://developers.files.com/javascript/) for the complete documentation.
+
+## Introduction
 
+The Files.com JavaScript SDK provides convenient access to the Files.com API from applications written in JavaScript.
 
-## Installation
+### Installation
 
 To install the package:
 
-    yarn add files.com
+```shell
+yarn add files.com
+```
 
 or
 
-    npm install files.com
-
-
-## Usage
+```shell
+npm install files.com
+```
 
+### Usage
 
-### Import and initialize
+#### Import and initialize
 
 ```js
 import Files from "files.com/lib/Files.js";
@@ -28,8 +34,7 @@ import Files from "files.com/lib/Files.js";
 Files.setBaseUrl("https://MY-SUBDOMAIN.files.com");
 ```
 
-
-#### `require()` vs. `import`
+##### `require()` vs. `import`
 
 The examples provided in the documentation here use the newer ES6 `import` syntax. To
 instead use the older CommonJS module syntax with `require()`, ensure that `.default`
@@ -43,162 +48,512 @@ const User = require("files.com/lib/models/User.js").default;
 const { LogLevel } = require("files.com/lib/Logger.js").default;
 ```
 
+<Note title="Repository">
+Explore the [files-sdk-javascript](https://github.com/Files-com/files-sdk-javascript) code on GitHub.
+</Note>
 
-### Authentication
+### Getting Support
 
-There are multiple ways to authenticate to the Files.com SDK for Javascript.
+The Files.com team is happy to help with any SDK Integration challenges you
+may face.
 
+Just email support@files.com and we'll get the process started.
 
-#### Global API Key
+## Authentication
 
-You can set an API key globally like this:
+### Authenticate with an API Key
 
-    Files.setApiKey('my-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
+interface](https://www.files.com/docs/sdk-and-apis/api-keys) or [via the API or an
+SDK](/javascript/resources/developers/api-keys).
 
-#### Per-Request API Key
+Note that when using a user-specific API key, if the user is an administrator, you will have full
+access to the entire API. If the user is not an administrator, you will only be able to access files
+that user can access, and no access will be granted to site administration functions in the API.
 
-Or, you can pass an API key per-request, in the options object at the end of every method like this:
+```javascript title="Example Request"
+Files.setApiKey('YOUR_API_KEY')
 
-    import User from 'files.com/lib/models/User.js'
-    const user = new User(params, { apiKey: 'my-api-key' })
+// Alternatively, you can specify the API key on a per-object basis in the second parameter to a model constructor.
+const user = new User(params, { apiKey: 'YOUR_API_KEY' })
 
+// You may also specify the API key on a per-request basis in the final parameter to static methods.
+await User.find(id, params, { apiKey: 'YOUR_API_KEY' })
+```
 
-#### User Session
+<Note>
+Don't forget to replace the placeholder, `YOUR_API_KEY`, with your actual API key.
+</Note>
 
-Or, you can open a user session by calling `Session.create()`
+### Authenticate with a Session
 
-    import Session from 'files.com/lib/models/Session.js'
-    const session = await Session.create({ username, password })
+You can also authenticate to the REST API or SDKs 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
+user can access, and no access will be granted to site administration functions.
 
-Then use it globally for all subsequent API calls like this:
+API sessions use the exact same session timeout settings as web interface sessions. When an API
+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
+your explicit consent.
 
-    Files.setSessionId(session.id)
+#### Logging in
 
-Or, you can pass the session ID per-request, in the options array at the end of every method like this:
+To create a session, the `create` method is called on the `Session` object with the user's username and
+password.
 
-    import User from 'files.com/lib/models/User.js'
-    const user = new User(params, { sessionId: session.id })
+This returns a session object that can be used to authenticate SDK method calls.
 
+```javascript title="Example Request"
+const session = await Session.create({ username: 'motor', password: 'vroom' })
+```
+
+#### Using a session
+
+Once a session has been created, you can store the session globally, use the session per object, or use the session per request to authenticate SDK operations.
+
+```javascript title="Example Request"
+// You may set the returned session ID to be used by default for subsequent requests.
+Files.setSessionId(session.id)
 
-### Setting Global Options
+// Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
+const user = new User(params, { session_id: session.id })
 
-You can set the following global properties using static methods on the `Files` class:
+// You may also specify the session ID on a per-request basis in the final parameter to static methods.
+await User.find(id, params, { session_id: session.id })
+```
+
+#### Logging out
 
+User sessions can be ended calling the `destroy` method on the `session` object.
+
+```javascript title="Example Request"
+await Session.destroy()
+```
 
-#### Log Level
+## Configuration
 
-    import { LogLevel } from 'files.com/lib/Logger.js'
-    Files.setLogLevel(LogLevel.INFO)
+### Configuration options
 
-    /*
-    Call Files.setLogLevel() with one of the following:
-      LogLevel.NONE
-      LogLevel.ERROR
-      LogLevel.WARN
-      LogLevel.INFO (default)
-      LogLevel.DEBUG
-    */
+#### Base URL
 
+Setting the base URL for the API is required if your site is configured to disable global acceleration.
+This can also be set to use a mock server in development or CI.
+
+```javascript title="Example setting"
+Files.setBaseUrl("https://MY-SUBDOMAIN.files.com");
+```
+
+#### Log level
+
+Supported values:
+
+* LogLevel.NONE
+* LogLevel.ERROR
+* LogLevel.WARN
+* LogLevel.INFO (default)
+* LogLevel.DEBUG
+
+```javascript title="Example setting"
+import { LogLevel } from 'files.com/lib/Logger.js'
+Files.setLogLevel(LogLevel.INFO)
+```
 
 #### Debugging
 
-    Files.configureDebugging({
-      // enable debug logging of API requests (default: false)
-      debugRequest: false,
+Enable debug logging of API requests and/or response headers. Both settings default to `false`.
 
-      // enable debug logging of API response headers (default: false)
-      debugResponseHeaders: false,
-    })
+```javascript title="Example setting"
+Files.configureDebugging({
+  debugRequest: true,
+  debugResponseHeaders: true,
+})
+```
+
+#### Network settings
 
+```javascript title="Example setting"
+Files.configureNetwork({
+  // max retries (default: 3)
+  maxNetworkRetries: 3,
 
-#### Network
+  // minimum delay in seconds before retrying (default: 0.5)
+  minNetworkRetryDelay: 0.5,
 
-    Files.configureNetwork({
-      // max retries (default: 3)
-      maxNetworkRetries: 3,
+  // max delay in seconds before retrying (default: 1.5)
+  maxNetworkRetryDelay: 1.5,
 
-      // minimum delay in seconds before retrying (default: 0.5)
-      minNetworkRetryDelay: 0.5,
+  // network timeout in seconds (default: 30.0)
+  networkTimeout: 30.0,
 
-      // max delay in seconds before retrying (default: 1.5)
-      maxNetworkRetryDelay: 1.5,
+  // auto-fetch all pages when results span multiple pages (default: `true`)
+  autoPaginate: true,
+})
+```
 
-      // network timeout in seconds (default: 30.0)
-      networkTimeout: 30.0,
+### Logging
 
-      // auto-fetch all pages when results span multiple pages (default: `true`)
-      autoPaginate: true,
-    })
+The Files.com SDK is compatible with the standard log4j logging scheme.
 
+Add `com.files` logger to your `Loggers` root in the `log4j2.xml` file.
 
-### File Operations
+```xml title="log4j2.xml"
+<Loggers>
+    <!-- set preferred level -->
+    <Logger name="com.files" level="TRACE" />
+    <!-- to enable network request -->
+    <Logger name="okhttp3.logging.wire" level="INFO"/>
+</Loggers>
+```
 
+Create a `resources/log4j2.xml` file.
+
+```xml title="resources/log4j2.xml"
+<?xml version="1.0" encoding="UTF-8"?>
+<Configuration>
+    <Appenders>
+        <Console name="Console" target="SYSTEM_OUT">
+            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
+        </Console>
+    </Appenders>
+    <Loggers>
+        <!-- set preferred level -->
+        <Logger name="com.files" level="TRACE"/>
+        <!-- to enable network request -->
+        <Logger name="okhttp3.logging.wire" level="INFO"/>
+    </Loggers>
+</Configuration>
+```
 
-#### List root folder
+You can read more about [log4j2 configuration](https://logging.apache.org/log4j/2.x/manual/configuration.html).
 
-    import Folder from 'files.com/lib/models/Folder.js'
-    const dirFiles = await Folder.listFor('/')
+## Errors
 
+The Files.com JavaScript SDK will return errors by raising exceptions. There are many exception classes defined in the Files SDK that correspond
+to specific errors.
 
-#### Uploading a file
+The raised exceptions come from two categories:
 
-    import File from 'files.com/lib/models/File.js'
-    import { isBrowser } from 'files.com/lib/utils.js'
+1.  SDK Exceptions - errors that originate within the SDK
+2.  API Exceptions - errors that occur due to the response from the Files.com API.  These errors are grouped into common error types.
 
-    // uploading raw file data
-    await File.uploadData(destinationFileName, data)
+There are several types of exceptions within each category.  Exception classes indicate different types of errors and are named in a
+fashion that describe the general premise of the originating error.  More details can be found in the exception object message using the
+`message` attribute.
 
-    // uploading a file on disk (not available in browser)
-    if (!isBrowser()) {
-      await File.uploadFile(destinationFileName, sourceFilePath)
+Use standard Javascript exception handling to detect and deal with errors.  It is generally recommended to catch specific errors first, then
+catch the general `FilesError` exception as a catch-all.
+
+```javascript title="Example Error Handling"
+import Session from 'files.com/lib/models/Session.js'
+import * as FilesErrors from 'files.com/lib/Errors.js'
+
+try {
+    const session = await Session.create({ username: 'USERNAME', password: 'BADPASSWORD' })
+}
+catch(err) {
+    if (err instanceof FilesErrors.NotAuthenticatedError) {
+        console.log("Authorization Error Occured (" + err.constructor.name + "): " + err.error);
+    } else if (err instanceof FilesErrors.FilesError) {
+        console.log("Unknown Error Occured (" + err.constructor.name + "): " + err.error);
+    } else {
+        throw err;
     }
+}
+```
+
+### Error Types
+
+#### SDK Errors
+
+SDK errors are general errors that occur within the SDK code.  These errors generate exceptions.  Each of these
+exception classes inherit from a standard `FilesError` base class.
+
+```javascript title="Example SDK Exception Class Inheritance Structure"
+import * as FilesErrors from 'files.com/lib/Errors.js'
+
+FilesErrors.ConfigurationError ->
+FilesErrors.FilesError ->
+Error
+```
+##### SDK Exception Classes
 
+| Exception Class Name| Description |
+| --------------- | ------------ |
+| `ConfigurationError`| Invalid SDK configuration parameters |
+| `EmptyPropertyError`| Missing a required property |
+| `InvalidParameterError`| A passed in parameter is invalid |
+| `MissingParameterError`| A method parameter is missing |
+| `NotImplementedError`| The called method has not be implemented by the SDK |
+
+#### API Errors
+
+API errors are errors returned by the Files.com API.  Each exception class inherits from an error group base class.
+The error group base class indicates a particular type of error.
+
+```shell title="Example API Exception Class Inheritance Structure"
+import * as FilesErrors from 'files.com/lib/Errors.js'
+
+FilesErrors.NotAuthorized_FolderAdminPermissionRequiredError ->
+FilesErrors.NotAuthorizedError ->
+FilesErrors.FilesApiError  ->
+FilesErrors.FilesError  ->
+Error
+```
+##### API Exception Classes
+
+| Exception Class Name | Error Group |
+| --------- | --------- |
+|     `BadRequest_AgentUpgradeRequiredError`|  `BadRequestError` |
+|     `BadRequest_AttachmentTooLargeError`|  `BadRequestError` |
+|     `BadRequest_CannotDownloadDirectoryError`|  `BadRequestError` |
+|     `BadRequest_CantMoveWithMultipleLocationsError`|  `BadRequestError` |
+|     `BadRequest_DatetimeParseError`|  `BadRequestError` |
+|     `BadRequest_DestinationSameError`|  `BadRequestError` |
+|     `BadRequest_FolderMustNotBeAFileError`|  `BadRequestError` |
+|     `BadRequest_InvalidBodyError`|  `BadRequestError` |
+|     `BadRequest_InvalidCursorError`|  `BadRequestError` |
+|     `BadRequest_InvalidCursorTypeForSortError`|  `BadRequestError` |
+|     `BadRequest_InvalidEtagsError`|  `BadRequestError` |
+|     `BadRequest_InvalidFilterAliasCombinationError`|  `BadRequestError` |
+|     `BadRequest_InvalidFilterCombinationError`|  `BadRequestError` |
+|     `BadRequest_InvalidFilterFieldError`|  `BadRequestError` |
+|     `BadRequest_InvalidFilterParamError`|  `BadRequestError` |
+|     `BadRequest_InvalidFilterParamValueError`|  `BadRequestError` |
+|     `BadRequest_InvalidInputEncodingError`|  `BadRequestError` |
+|     `BadRequest_InvalidInterfaceError`|  `BadRequestError` |
+|     `BadRequest_InvalidOauthProviderError`|  `BadRequestError` |
+|     `BadRequest_InvalidPathError`|  `BadRequestError` |
+|     `BadRequest_InvalidReturnToUrlError`|  `BadRequestError` |
+|     `BadRequest_InvalidUploadOffsetError`|  `BadRequestError` |
+|     `BadRequest_InvalidUploadPartGapError`|  `BadRequestError` |
+|     `BadRequest_InvalidUploadPartSizeError`|  `BadRequestError` |
+|     `BadRequest_MethodNotAllowedError`|  `BadRequestError` |
+|     `BadRequest_NoValidInputParamsError`|  `BadRequestError` |
+|     `BadRequest_PartNumberTooLargeError`|  `BadRequestError` |
+|     `BadRequest_PathCannotHaveTrailingWhitespaceError`|  `BadRequestError` |
+|     `BadRequest_ReauthenticationNeededFieldsError`|  `BadRequestError` |
+|     `BadRequest_RequestParamsContainInvalidCharacterError`|  `BadRequestError` |
+|     `BadRequest_RequestParamsInvalidError`|  `BadRequestError` |
+|     `BadRequest_RequestParamsRequiredError`|  `BadRequestError` |
+|     `BadRequest_SearchAllOnChildPathError`|  `BadRequestError` |
+|     `BadRequest_UnsupportedCurrencyError`|  `BadRequestError` |
+|     `BadRequest_UnsupportedHttpResponseFormatError`|  `BadRequestError` |
+|     `BadRequest_UnsupportedMediaTypeError`|  `BadRequestError` |
+|     `BadRequest_UserIdInvalidError`|  `BadRequestError` |
+|     `BadRequest_UserIdOnUserEndpointError`|  `BadRequestError` |
+|     `BadRequest_UserRequiredError`|  `BadRequestError` |
+|     `NotAuthenticated_AdditionalAuthenticationRequiredError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_AuthenticationRequiredError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_BundleRegistrationCodeFailedError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_FilesAgentTokenFailedError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_InboxRegistrationCodeFailedError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_InvalidCredentialsError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_InvalidOauthError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_InvalidOrExpiredCodeError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_InvalidSessionError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_InvalidUsernameOrPasswordError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_LockedOutError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_LockoutRegionMismatchError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_OneTimePasswordIncorrectError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_TwoFactorAuthenticationErrorError`|  `NotAuthenticatedError` |
+|     `NotAuthenticated_TwoFactorAuthenticationSetupExpiredError`|  `NotAuthenticatedError` |
+|     `NotAuthorized_ApiKeyIsDisabledError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ApiKeyIsPathRestrictedError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ApiKeyOnlyForDesktopAppError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ApiKeyOnlyForMobileAppError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ApiKeyOnlyForOfficeIntegrationError`|  `NotAuthorizedError` |
+|     `NotAuthorized_BillingPermissionRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_BundleMaximumUsesReachedError`|  `NotAuthorizedError` |
+|     `NotAuthorized_CannotLoginWhileUsingKeyError`|  `NotAuthorizedError` |
+|     `NotAuthorized_CantActForOtherUserError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ContactAdminForPasswordChangeHelpError`|  `NotAuthorizedError` |
+|     `NotAuthorized_FilesAgentFailedAuthorizationError`|  `NotAuthorizedError` |
+|     `NotAuthorized_FolderAdminOrBillingPermissionRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_FolderAdminPermissionRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_FullPermissionRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_HistoryPermissionRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_InsufficientPermissionForParamsError`|  `NotAuthorizedError` |
+|     `NotAuthorized_InsufficientPermissionForSiteError`|  `NotAuthorizedError` |
+|     `NotAuthorized_MustAuthenticateWithApiKeyError`|  `NotAuthorizedError` |
+|     `NotAuthorized_NeedAdminPermissionForInboxError`|  `NotAuthorizedError` |
+|     `NotAuthorized_NonAdminsMustQueryByFolderOrPathError`|  `NotAuthorizedError` |
+|     `NotAuthorized_NotAllowedToCreateBundleError`|  `NotAuthorizedError` |
+|     `NotAuthorized_PasswordChangeNotRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_PasswordChangeRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ReadOnlySessionError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ReadPermissionRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ReauthenticationFailedError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ReauthenticationFailedFinalError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ReauthenticationNeededActionError`|  `NotAuthorizedError` |
+|     `NotAuthorized_RecaptchaFailedError`|  `NotAuthorizedError` |
+|     `NotAuthorized_SelfManagedRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_SiteAdminRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_SiteFilesAreImmutableError`|  `NotAuthorizedError` |
+|     `NotAuthorized_TwoFactorAuthenticationRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_UserIdWithoutSiteAdminError`|  `NotAuthorizedError` |
+|     `NotAuthorized_WriteAndBundlePermissionRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_WritePermissionRequiredError`|  `NotAuthorizedError` |
+|     `NotAuthorized_ZipDownloadIpMismatchError`|  `NotAuthorizedError` |
+|     `NotFound_ApiKeyNotFoundError`|  `NotFoundError` |
+|     `NotFound_BundlePathNotFoundError`|  `NotFoundError` |
+|     `NotFound_BundleRegistrationNotFoundError`|  `NotFoundError` |
+|     `NotFound_CodeNotFoundError`|  `NotFoundError` |
+|     `NotFound_FileNotFoundError`|  `NotFoundError` |
+|     `NotFound_FileUploadNotFoundError`|  `NotFoundError` |
+|     `NotFound_FolderNotFoundError`|  `NotFoundError` |
+|     `NotFound_GroupNotFoundError`|  `NotFoundError` |
+|     `NotFound_InboxNotFoundError`|  `NotFoundError` |
+|     `NotFound_NestedNotFoundError`|  `NotFoundError` |
+|     `NotFound_PlanNotFoundError`|  `NotFoundError` |
+|     `NotFound_SiteNotFoundError`|  `NotFoundError` |
+|     `NotFound_UserNotFoundError`|  `NotFoundError` |
+|     `ProcessingFailure_AlreadyCompletedError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_AutomationCannotBeRunManuallyError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_BehaviorNotAllowedOnRemoteServerError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_BundleOnlyAllowsPreviewsError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_BundleOperationRequiresSubfolderError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_CouldNotCreateParentError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_DestinationExistsError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_DestinationFolderLimitedError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_DestinationParentConflictError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_DestinationParentDoesNotExistError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_ExpiredPrivateKeyError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_ExpiredPublicKeyError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_ExportFailureError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_ExportNotReadyError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FailedToChangePasswordError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FileLockedError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FileNotUploadedError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FilePendingProcessingError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FileProcessingErrorError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FileTooBigToDecryptError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FileTooBigToEncryptError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FileUploadedToWrongRegionError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FilenameTooLongError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FolderLockedError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_FolderNotEmptyError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_HistoryUnavailableError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_InvalidBundleCodeError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_InvalidFileTypeError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_InvalidFilenameError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_InvalidPriorityColorError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_InvalidRangeError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_ModelSaveErrorError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_MultipleProcessingErrorsError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_PathTooLongError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_RecipientAlreadySharedError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_RemoteServerErrorError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_ResourceLockedError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_SubfolderLockedError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_TwoFactorAuthenticationCodeAlreadySentError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_TwoFactorAuthenticationCountryBlacklistedError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_TwoFactorAuthenticationGeneralErrorError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_TwoFactorAuthenticationUnsubscribedRecipientError`|  `ProcessingFailureError` |
+|     `ProcessingFailure_UpdatesNotAllowedForRemotesError`|  `ProcessingFailureError` |
+|     `RateLimited_DuplicateShareRecipientError`|  `RateLimitedError` |
+|     `RateLimited_ReauthenticationRateLimitedError`|  `RateLimitedError` |
+|     `RateLimited_TooManyConcurrentLoginsError`|  `RateLimitedError` |
+|     `RateLimited_TooManyConcurrentRequestsError`|  `RateLimitedError` |
+|     `RateLimited_TooManyLoginAttemptsError`|  `RateLimitedError` |
+|     `RateLimited_TooManyRequestsError`|  `RateLimitedError` |
+|     `RateLimited_TooManySharesError`|  `RateLimitedError` |
+|     `ServiceUnavailable_AgentUnavailableError`|  `ServiceUnavailableError` |
+|     `ServiceUnavailable_AutomationsUnavailableError`|  `ServiceUnavailableError` |
+|     `ServiceUnavailable_MigrationInProgressError`|  `ServiceUnavailableError` |
+|     `ServiceUnavailable_SiteDisabledError`|  `ServiceUnavailableError` |
+|     `ServiceUnavailable_UploadsUnavailableError`|  `ServiceUnavailableError` |
+|     `SiteConfiguration_AccountAlreadyExistsError`|  `SiteConfigurationError` |
+|     `SiteConfiguration_AccountOverdueError`|  `SiteConfigurationError` |
+|     `SiteConfiguration_NoAccountForSiteError`|  `SiteConfigurationError` |
+|     `SiteConfiguration_SiteWasRemovedError`|  `SiteConfigurationError` |
+|     `SiteConfiguration_TrialExpiredError`|  `SiteConfigurationError` |
+|     `SiteConfiguration_TrialLockedError`|  `SiteConfigurationError` |
+|     `SiteConfiguration_UserRequestsEnabledRequiredError`|  `SiteConfigurationError` |
+
+## Examples
+
+### File Operations
+
+#### List root folder
+
+```javascript
+import Folder from 'files.com/lib/models/Folder.js'
+const dirFiles = await Folder.listFor('/')
+```
+
+#### Uploading a file
+
+```javascript
+import File from 'files.com/lib/models/File.js'
+import { isBrowser } from 'files.com/lib/utils.js'
+
+// uploading raw file data
+await File.uploadData(destinationFileName, data)
+
+// uploading a file on disk (not available in browser)
+if (!isBrowser()) {
+  await File.uploadFile(destinationFileName, sourceFilePath)
+}
+```
 
 #### Downloading a file
 
 ##### Get a downloadable file object by path
 
-    import File from 'files.com/lib/models/File.js'
-
-    const foundFile = await File.find(remoteFilePath)
-    const downloadableFile = await foundFile.download()
+```javascript
+import File from 'files.com/lib/models/File.js'
 
+const foundFile = await File.find(remoteFilePath)
+const downloadableFile = await foundFile.download()
+```
 
 ##### Download a file (not available in browser)
 
-    import { isBrowser } from 'files.com/lib/utils.js'
-
-    if (!isBrowser()) {
-      // download to a file on disk
-      await downloadableFile.downloadToFile(localFilePath)
+```javascript
+import { isBrowser } from 'files.com/lib/utils.js'
 
-      // download to a writable stream
-      await downloadableFile.downloadToStream(stream)
+if (!isBrowser()) {
+  // download to a file on disk
+  await downloadableFile.downloadToFile(localFilePath)
 
-      // download in memory and return as a UTF-8 string
-      const textContent = await downloadableFile.downloadToString()
-    }
+  // download to a writable stream
+  await downloadableFile.downloadToStream(stream)
 
+  // download in memory and return as a UTF-8 string
+  const textContent = await downloadableFile.downloadToString()
+}
+```
 
 #### Comparing Case insensitive files and paths
 
 For related documentation see [Case Sensitivity Documentation](https://www.files.com/docs/files-and-folders/file-system-semantics/case-sensitivity).
 
-    import { pathNormalizer } from 'files.com/lib/utils.js'
+```javascript
+import { pathNormalizer } from 'files.com/lib/utils.js'
 
-    if (pathNormalizer.same('Fïłèńämê.Txt', 'filename.txt')) {
-      // the paths are the same
-    }
+if (pathNormalizer.same('Fïłèńämê.Txt', 'filename.txt')) {
+  // the paths are the same
+}
+```
 
+## Mock Server
 
-### Additional Object Documentation
+Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
+SDKs and other direct integrations against the Files.com API in an integration test environment.
 
-Additional docs are available at <https://developers.files.com>
+It is a Ruby app that operates as a minimal server for the purpose of testing basic network
+operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
+deeply inspect your submissions for correctness.
 
+Eventually we will add more features intended for integration testing, such as the ability to
+intentionally provoke errors.
 
-## Getting Support
+Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
 
-The Files.com team is happy to help with any SDK Integration challenges you may face.
+The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
 
-Just email <support@files.com> and we'll get the process started.
+A README is available on the GitHub link.

package/_VERSION

@@ -1 +1 @@
-1.2.103
+1.2.105

package/docs/models/File.md

@@ -362,7 +362,7 @@ await file.move({
 
 ---
 
-## Begin file upload
+## Begin File Upload
 
 ```
 const file = await File.find(path)

package/docs/models/FileAction.md

@@ -10,4 +10,4 @@
 ```
 
 * `status` (string): Status of file operation.
-* `file_migration_id` (int64): If status is pending, this is the id of the FileMigration to check for status updates.
+* `file_migration_id` (int64): If status is pending, this is the id of the File Migration to check for status updates.

package/docs/models/SftpHostKey.md

@@ -11,7 +11,7 @@
 }
 ```
 
-* `id` (int64): Sftp Host Key ID
+* `id` (int64): SFTP Host Key ID
 * `name` (string): The friendly name of this SFTP Host Key.
 * `fingerprint_md5` (string): MD5 Fingerpint of the public key
 * `fingerprint_sha256` (string): SHA256 Fingerpint of the public key

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.103';
+var version = '1.2.105';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/File.js

@@ -815,7 +815,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       }
     }, _callee10);
   })));
-  // Begin file upload
+  // Begin File Upload
   //
   // Parameters:
   //   mkdir_parents - boolean - Create parent directories if they do not exist?

package/lib/models/FileAction.js

@@ -33,7 +33,7 @@ var FileAction = /*#__PURE__*/(0, _createClass2.default)(function FileAction() {
   (0, _defineProperty2.default)(this, "getStatus", function () {
     return _this.attributes.status;
   });
-  // int64 # If status is pending, this is the id of the FileMigration to check for status updates.
+  // int64 # If status is pending, this is the id of the File Migration to check for status updates.
   (0, _defineProperty2.default)(this, "getFileMigrationId", function () {
     return _this.attributes.file_migration_id;
   });

package/lib/models/SftpHostKey.js

@@ -33,7 +33,7 @@ var SftpHostKey = /*#__PURE__*/(0, _createClass2.default)(function SftpHostKey()
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
-  // int64 # Sftp Host Key ID
+  // int64 # SFTP Host Key ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.103",
+  "version": "1.2.105",
   "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.103'
+const version = '1.2.105'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/File.js

@@ -806,7 +806,7 @@ class File {
     return new FileAction(response?.data, this.options)
   }
 
-  // Begin file upload
+  // Begin File Upload
   //
   // Parameters:
   //   mkdir_parents - boolean - Create parent directories if they do not exist?

package/src/models/FileAction.js

@@ -31,7 +31,7 @@ class FileAction {
   // string # Status of file operation.
   getStatus = () => this.attributes.status
 
-  // int64 # If status is pending, this is the id of the FileMigration to check for status updates.
+  // int64 # If status is pending, this is the id of the File Migration to check for status updates.
   getFileMigrationId = () => this.attributes.file_migration_id
 }
 

package/src/models/SftpHostKey.js

@@ -28,7 +28,7 @@ class SftpHostKey {
 
   isLoaded = () => !!this.attributes.id
 
-  // int64 # Sftp Host Key ID
+  // int64 # SFTP Host Key ID
   getId = () => this.attributes.id
 
   setId = value => {

package/docs/models/ActionWebhookFailure.md

@@ -1,16 +0,0 @@
-
----
-
-## retry Action Webhook Failure
-
-```
-const action_webhook_failure = new ActionWebhookFailure()
-action_webhook_failure.path = myFilePath
-
-await action_webhook_failure.retry()
-```
-
-### Parameters
-
-* `id` (int64): Required - Action Webhook Failure ID.
-

package/lib/models/ActionWebhookFailure.js

@@ -1,98 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _typeof = require("@babel/runtime/helpers/typeof");
-exports.__esModule = true;
-exports.default = void 0;
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _Api = _interopRequireDefault(require("../Api"));
-var errors = _interopRequireWildcard(require("../Errors"));
-var _utils = require("../utils");
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; } /* eslint-disable no-unused-vars */
-/* eslint-enable no-unused-vars */
-/**
- * Class ActionWebhookFailure
- */
-var ActionWebhookFailure = /*#__PURE__*/(0, _createClass2.default)(function ActionWebhookFailure() {
-  var _this = this;
-  var attributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  (0, _classCallCheck2.default)(this, ActionWebhookFailure);
-  (0, _defineProperty2.default)(this, "attributes", {});
-  (0, _defineProperty2.default)(this, "options", {});
-  (0, _defineProperty2.default)(this, "isLoaded", function () {
-    return !!_this.attributes.id;
-  });
-  // retry Action Webhook Failure
-  (0, _defineProperty2.default)(this, "retry", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-    var params,
-      _args = arguments;
-    return _regenerator.default.wrap(function _callee$(_context) {
-      while (1) switch (_context.prev = _context.next) {
-        case 0:
-          params = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
-          if (_this.attributes.id) {
-            _context.next = 3;
-            break;
-          }
-          throw new errors.EmptyPropertyError('Current object has no id');
-        case 3:
-          if ((0, _utils.isObject)(params)) {
-            _context.next = 5;
-            break;
-          }
-          throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
-        case 5:
-          params.id = _this.attributes.id;
-          if (!(params.id && !(0, _utils.isInt)(params.id))) {
-            _context.next = 8;
-            break;
-          }
-          throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
-        case 8:
-          if (params.id) {
-            _context.next = 14;
-            break;
-          }
-          if (!_this.attributes.id) {
-            _context.next = 13;
-            break;
-          }
-          params.id = _this.id;
-          _context.next = 14;
-          break;
-        case 13:
-          throw new errors.MissingParameterError('Parameter missing: id');
-        case 14:
-          _context.next = 16;
-          return _Api.default.sendRequest("/action_webhook_failures/".concat(encodeURIComponent(params.id), "/retry"), 'POST', params, _this.options);
-        case 16:
-        case "end":
-          return _context.stop();
-      }
-    }, _callee);
-  })));
-  Object.entries(attributes).forEach(function (_ref2) {
-    var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
-      key = _ref3[0],
-      value = _ref3[1];
-    var normalizedKey = key.replace('?', '');
-    _this.attributes[normalizedKey] = value;
-    Object.defineProperty(_this, normalizedKey, {
-      value: value,
-      writable: false
-    });
-  });
-  this.options = _objectSpread({}, options);
-});
-var _default = exports.default = ActionWebhookFailure;
-module.exports = ActionWebhookFailure;
-module.exports.default = ActionWebhookFailure;

package/src/models/ActionWebhookFailure.js

@@ -1,61 +0,0 @@
-/* eslint-disable no-unused-vars */
-import Api from '../Api'
-import * as errors from '../Errors'
-import {
-  getType, isArray, isInt, isObject, isString,
-} from '../utils'
-/* eslint-enable no-unused-vars */
-
-/**
- * Class ActionWebhookFailure
- */
-class ActionWebhookFailure {
-  attributes = {}
-
-  options = {}
-
-  constructor(attributes = {}, options = {}) {
-    Object.entries(attributes).forEach(([key, value]) => {
-      const normalizedKey = key.replace('?', '')
-
-      this.attributes[normalizedKey] = value
-
-      Object.defineProperty(this, normalizedKey, { value, writable: false })
-    })
-
-    this.options = { ...options }
-  }
-
-  isLoaded = () => !!this.attributes.id
-
-  // retry Action Webhook Failure
-  retry = async (params = {}) => {
-    if (!this.attributes.id) {
-      throw new errors.EmptyPropertyError('Current object has no id')
-    }
-
-    if (!isObject(params)) {
-      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
-    }
-
-    params.id = this.attributes.id
-    if (params.id && !isInt(params.id)) {
-      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
-    }
-
-    if (!params.id) {
-      if (this.attributes.id) {
-        params.id = this.id
-      } else {
-        throw new errors.MissingParameterError('Parameter missing: id')
-      }
-    }
-
-    await Api.sendRequest(`/action_webhook_failures/${encodeURIComponent(params.id)}/retry`, 'POST', params, this.options)
-  }
-}
-
-export default ActionWebhookFailure
-
-module.exports = ActionWebhookFailure
-module.exports.default = ActionWebhookFailure