files.com 1.0.188 → 1.0.191

package/_VERSION

@@ -1 +1 @@
-1.0.188
+1.0.191

package/docs/Errors.md

@@ -0,0 +1,186 @@
+# Errors
+
+There are many custom `Error` classes defined by this SDK that you can test against in your code.
+
+The library of errors can be imported as follows:
+
+`import * as errors from 'files.com/lib/Errors'`
+
+If using `require()` you can import using the following (note the lack of `.default`):
+
+`const errors = require('files.com/lib/Errors')`
+
+## Core Errors
+
+### FilesError
+
+This is the base class for all other errors defined by this SDK. It is never thrown directly.
+
+### FilesApiError
+
+This is the base class for failed API requests. Its properties include the message text and `code` associated with the network response.
+
+## General Errors
+
+The following errors may be thrown for general failures not related to an API request.
+
+### ConfigurationError
+### EmptyPropertyError
+### InvalidParameterError
+### MissingParameterError
+### NotImplementedError
+
+## API Error Groups
+
+Each of these error classes is used as the base class for each associated error. These errors are never thrown directly.
+
+### BadRequestError
+### NotAuthenticatedError
+### NotAuthorizedError
+### NotFoundError
+### ProcessingFailureError
+### RateLimitedError
+### ServiceUnavailableError
+### SiteConfigurationError
+
+## Grouped API Errors
+
+These errors are derived from the error groups listed above.
+
+### BadRequest_AttachmentTooLargeError
+### BadRequest_CannotDownloadDirectoryError
+### BadRequest_CantMoveWithMultipleLocationsError
+### BadRequest_DatetimeParseError
+### BadRequest_DestinationSameError
+### BadRequest_FolderMustNotBeAFileError
+### BadRequest_InvalidBodyError
+### BadRequest_InvalidCursorError
+### BadRequest_InvalidEtagsError
+### BadRequest_InvalidFilterCombinationError
+### BadRequest_InvalidFilterFieldError
+### BadRequest_InvalidInputEncodingError
+### BadRequest_InvalidInterfaceError
+### BadRequest_InvalidOauthProviderError
+### BadRequest_InvalidReturnToUrlError
+### BadRequest_InvalidUploadOffsetError
+### BadRequest_InvalidUploadPartGapError
+### BadRequest_InvalidUploadPartSizeError
+### BadRequest_MethodNotAllowedError
+### BadRequest_NoValidInputParamsError
+### BadRequest_OperationOnNonScimResourceError
+### BadRequest_PartNumberTooLargeError
+### BadRequest_ReauthenticationNeededFieldsError
+### BadRequest_RequestParamPathCannotHaveTrailingWhitespaceError
+### BadRequest_RequestParamsContainInvalidCharacterError
+### BadRequest_RequestParamsInvalidError
+### BadRequest_RequestParamsRequiredError
+### BadRequest_SearchAllOnChildPathError
+### BadRequest_UnsupportedCurrencyError
+### BadRequest_UnsupportedHttpResponseFormatError
+### BadRequest_UnsupportedMediaTypeError
+### BadRequest_UserIdInvalidError
+### BadRequest_UserIdOnUserEndpointError
+### BadRequest_UserRequiredError
+### NotAuthenticated_AuthenticationRequiredError
+### NotAuthenticated_BundleRegistrationCodeFailedError
+### NotAuthenticated_InboxRegistrationCodeFailedError
+### NotAuthenticated_InvalidCredentialsError
+### NotAuthenticated_InvalidOauthError
+### NotAuthenticated_InvalidOrExpiredCodeError
+### NotAuthenticated_InvalidUsernameOrPasswordError
+### NotAuthenticated_LockedOutError
+### NotAuthenticated_LockoutRegionMismatchError
+### NotAuthenticated_OneTimePasswordIncorrectError
+### NotAuthenticated_TwoFactorAuthenticationErrorError
+### NotAuthenticated_TwoFactorAuthenticationSetupExpiredError
+### NotAuthorized_ApiKeyIsDisabledError
+### NotAuthorized_ApiKeyIsPathRestrictedError
+### NotAuthorized_ApiKeyOnlyForDesktopAppError
+### NotAuthorized_ApiKeyOnlyForMobileAppError
+### NotAuthorized_ApiKeyOnlyForOfficeIntegrationError
+### NotAuthorized_BillingPermissionRequiredError
+### NotAuthorized_BundleMaximumUsesReachedError
+### NotAuthorized_CannotLoginWhileUsingKeyError
+### NotAuthorized_CantActForOtherUserError
+### NotAuthorized_ContactAdminForPasswordChangeHelpError
+### NotAuthorized_FolderAdminOrBillingPermissionRequiredError
+### NotAuthorized_FolderAdminPermissionRequiredError
+### NotAuthorized_FullPermissionRequiredError
+### NotAuthorized_HistoryPermissionRequiredError
+### NotAuthorized_InsufficientPermissionForParamsError
+### NotAuthorized_MustAuthenticateWithApiKeyError
+### NotAuthorized_NeedAdminPermissionForInboxError
+### NotAuthorized_NonAdminsMustQueryByFolderOrPathError
+### NotAuthorized_NotAllowedToCreateBundleError
+### NotAuthorized_PasswordChangeNotRequiredError
+### NotAuthorized_PasswordChangeRequiredError
+### NotAuthorized_ReadOnlySessionError
+### NotAuthorized_ReadPermissionRequiredError
+### NotAuthorized_ReauthenticationFailedError
+### NotAuthorized_ReauthenticationFailedFinalError
+### NotAuthorized_ReauthenticationNeededActionError
+### NotAuthorized_SelfManagedRequiredError
+### NotAuthorized_SiteAdminRequiredError
+### NotAuthorized_SiteFilesAreImmutableError
+### NotAuthorized_TwoFactorAuthenticationRequiredError
+### NotAuthorized_UserIdWithoutSiteAdminError
+### NotAuthorized_WritePermissionRequiredError
+### NotAuthorized_ZipDownloadIpMismatchError
+### NotFound_ApiKeyNotFoundError
+### NotFound_BundlePathNotFoundError
+### NotFound_CodeNotFoundError
+### NotFound_FileNotFoundError
+### NotFound_FileUploadNotFoundError
+### NotFound_FolderNotFoundError
+### NotFound_GroupNotFoundError
+### NotFound_InboxNotFoundError
+### NotFound_NestedNotFoundError
+### NotFound_PlanNotFoundError
+### NotFound_SiteNotFoundError
+### NotFound_UserNotFoundError
+### ProcessingFailure_BundleOnlyAllowsPreviewsError
+### ProcessingFailure_CouldNotCreateParentError
+### ProcessingFailure_DestinationExistsError
+### ProcessingFailure_DestinationFolderLimitedError
+### ProcessingFailure_DestinationParentConflictError
+### ProcessingFailure_DestinationParentDoesNotExistError
+### ProcessingFailure_ExpiredPrivateKeyError
+### ProcessingFailure_ExpiredPublicKeyError
+### ProcessingFailure_ExportFailureError
+### ProcessingFailure_ExportNotReadyError
+### ProcessingFailure_FailedToChangePasswordError
+### ProcessingFailure_FileLockedError
+### ProcessingFailure_FileNotUploadedError
+### ProcessingFailure_FilePendingProcessingError
+### ProcessingFailure_FileTooBigToDecryptError
+### ProcessingFailure_FileTooBigToEncryptError
+### ProcessingFailure_FileUploadedToWrongRegionError
+### ProcessingFailure_FolderLockedError
+### ProcessingFailure_FolderNotEmptyError
+### ProcessingFailure_HistoryUnavailableError
+### ProcessingFailure_InvalidBundleCodeError
+### ProcessingFailure_InvalidFileTypeError
+### ProcessingFailure_InvalidFilenameError
+### ProcessingFailure_InvalidRangeError
+### ProcessingFailure_ModelSaveErrorError
+### ProcessingFailure_MultipartUploadsRequiredForRemotesError
+### ProcessingFailure_MultipleProcessingErrorsError
+### ProcessingFailure_PathTooLongError
+### ProcessingFailure_RecipientAlreadySharedError
+### ProcessingFailure_RemoteServerErrorError
+### ProcessingFailure_ResourceLockedError
+### ProcessingFailure_SubfolderLockedError
+### ProcessingFailure_TwoFactorAuthenticationCodeAlreadySentError
+### ProcessingFailure_UpdatesNotAllowedForRemotesError
+### RateLimited_ReauthenticationRateLimitedError
+### RateLimited_TooManyConcurrentRequestsError
+### RateLimited_TooManyLoginAttemptsError
+### RateLimited_TooManyRequestsError
+### ServiceUnavailable_UploadsUnavailableError
+### SiteConfiguration_AccountAlreadyExistsError
+### SiteConfiguration_AccountOverdueError
+### SiteConfiguration_NoAccountForSiteError
+### SiteConfiguration_SiteWasRemovedError
+### SiteConfiguration_TrialExpiredError
+### SiteConfiguration_TrialLockedError
+### SiteConfiguration_UserRequestsEnabledRequiredError

package/docs/models/AccountLineItem.md

@@ -0,0 +1,53 @@
+# AccountLineItem
+
+## Example AccountLineItem Object
+
+```
+{
+  "id": 1,
+  "amount": 1.0,
+  "balance": 1.0,
+  "created_at": "2000-01-01T01:00:00Z",
+  "currency": "USD",
+  "download_uri": "https://url...",
+  "invoice_line_items": {
+    "amount": 1.0,
+    "created_at": "2000-01-01T01:00:00Z",
+    "description": "Service from 2019-01-01 through 2019-12-31",
+    "type": "invoice",
+    "service_end_at": "2000-01-01T01:00:00Z",
+    "service_start_at": "2000-01-01T01:00:00Z",
+    "updated_at": "2000-01-01T01:00:00Z",
+    "plan": "Enterprise",
+    "site": "My site"
+  },
+  "method": "paypal",
+  "payment_line_items": {
+    "amount": 1.0,
+    "created_at": "2000-01-01T01:00:00Z",
+    "invoice_id": 1,
+    "payment_id": 1,
+    "updated_at": "2000-01-01T01:00:00Z"
+  },
+  "payment_reversed_at": "2000-01-01T01:00:00Z",
+  "payment_type": "",
+  "site_name": "My Site",
+  "type": "invoice",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Line item Id
+* `amount` (double): Line item amount
+* `balance` (double): Line item balance
+* `created_at` (date-time): Line item created at
+* `currency` (string): Line item currency
+* `download_uri` (string): Line item download uri
+* `invoice_line_items` (InvoiceLineItem): Associated invoice line items
+* `method` (string): Line item payment method
+* `payment_line_items` (PaymentLineItem): Associated payment line items
+* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
+* `payment_type` (string): Type of payment if applicable
+* `site_name` (string): Site name this line item is for
+* `type` (string): Type of line item, either payment or invoice
+* `updated_at` (date-time): Line item updated at

package/docs/models/Action.md

@@ -0,0 +1,37 @@
+# Action
+
+## Example Action Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "when": "2000-01-01T01:00:00Z",
+  "destination": "/to_path",
+  "display": "Actual text of the action here.",
+  "ip": "192.283.128.182",
+  "source": "/from_path",
+  "targets": [
+
+  ],
+  "user_id": 1,
+  "username": "user",
+  "action": "create",
+  "failure_type": "none",
+  "interface": "web"
+}
+```
+
+* `id` (int64): Action ID
+* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `when` (date-time): Action occurrence date/time
+* `destination` (string): The destination path for this action, if applicable
+* `display` (string): Friendly displayed output
+* `ip` (string): IP Address that performed this action
+* `source` (string): The source path for this action, if applicable
+* `targets` (array): Targets
+* `user_id` (int64): User ID
+* `username` (string): Username
+* `action` (string): Type of action
+* `failure_type` (string): Failure type.  If action was a user login or session failure, why did it fail?
+* `interface` (string): Interface on which this action occurred.

package/docs/models/ActionNotificationExport.md

@@ -0,0 +1,82 @@
+# ActionNotificationExport
+
+## Example ActionNotificationExport Object
+
+```
+{
+  "id": 1,
+  "export_version": "20201213.2",
+  "start_at": "2000-01-01T01:00:00Z",
+  "end_at": "2000-01-01T01:00:00Z",
+  "status": "ready",
+  "query_path": "MyFile.txt",
+  "query_folder": "MyFolder",
+  "query_message": "Connection Refused",
+  "query_request_method": "GET",
+  "query_request_url": "http://example.com/webhook",
+  "query_status": "200",
+  "query_success": true,
+  "results_url": "https://files.com/action_notification_results.csv"
+}
+```
+
+* `id` (int64): History Export ID
+* `export_version` (string): Version of the underlying records for the export.
+* `start_at` (date-time): Start date/time of export range.
+* `end_at` (date-time): End date/time of export range.
+* `status` (string): Status of export.  Valid values: `building`, `ready`, or `failed`
+* `query_path` (string): Return notifications that were triggered by actions on this specific path.
+* `query_folder` (string): Return notifications that were triggered by actions in this folder.
+* `query_message` (string): Error message associated with the request, if any.
+* `query_request_method` (string): The HTTP request method used by the webhook.
+* `query_request_url` (string): The target webhook URL.
+* `query_status` (string): The HTTP status returned from the server in response to the webhook request.
+* `query_success` (boolean): true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
+* `results_url` (string): If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+
+---
+
+## Show Action Notification Export
+
+```
+await ActionNotificationExport.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Action Notification Export ID.
+
+---
+
+## Create Action Notification Export
+
+```
+await ActionNotificationExport.create({
+  'user_id': 1,
+  'start_at': "2000-01-01T01:00:00Z",
+  'end_at': "2000-01-01T01:00:00Z",
+  'query_message': "Connection Refused",
+  'query_request_method': "GET",
+  'query_request_url': "http://example.com/webhook",
+  'query_status': "200",
+  'query_success': true,
+  'query_path': "MyFile.txt",
+  'query_folder': "MyFolder",
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `start_at` (string): Start date/time of export range.
+* `end_at` (string): End date/time of export range.
+* `query_message` (string): Error message associated with the request, if any.
+* `query_request_method` (string): The HTTP request method used by the webhook.
+* `query_request_url` (string): The target webhook URL.
+* `query_status` (string): The HTTP status returned from the server in response to the webhook request.
+* `query_success` (boolean): true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
+* `query_path` (string): Return notifications that were triggered by actions on this specific path.
+* `query_folder` (string): Return notifications that were triggered by actions in this folder.

package/docs/models/ActionNotificationExportResult.md

@@ -0,0 +1,49 @@
+# ActionNotificationExportResult
+
+## Example ActionNotificationExportResult Object
+
+```
+{
+  "id": 1,
+  "created_at": 1,
+  "status": 200,
+  "message": "Success",
+  "success": true,
+  "request_headers": "{\"User-Agent\":\"Files.com Webhook\"}",
+  "request_method": "GET",
+  "request_url": "www.example.com/webhook_receiver",
+  "path": "MyFolder/MyFile.txt",
+  "folder": "MyFolder"
+}
+```
+
+* `id` (int64): Notification ID
+* `created_at` (int64): When the notification was sent.
+* `status` (int64): HTTP status code returned in the webhook response.
+* `message` (string): A message indicating the overall status of the webhook notification.
+* `success` (boolean): `true` if the webhook succeeded by receiving a 200 or 204 response.
+* `request_headers` (string): A JSON-encoded string with headers that were sent with the webhook.
+* `request_method` (string): The HTTP verb used to perform the webhook.
+* `request_url` (string): The webhook request URL.
+* `path` (string): The path to the actual file that triggered this notification. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `folder` (string): The folder associated with the triggering action for this notification.
+
+---
+
+## List Action Notification Export Results
+
+```
+await ActionNotificationExportResult.list({
+  'user_id': 1,
+  'per_page': 1,
+  'action_notification_export_id': 1,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action_notification_export_id` (int64): Required - ID of the associated action notification export.

package/docs/models/ActionWebhookFailure.md

@@ -0,0 +1,16 @@
+
+---
+
+## 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/docs/models/ApiKey.md

@@ -0,0 +1,183 @@
+# ApiKey
+
+## Example ApiKey Object
+
+```
+{
+  "id": 1,
+  "descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
+  "created_at": "2000-01-01T01:00:00Z",
+  "expires_at": "2000-01-01T01:00:00Z",
+  "key": "[key]",
+  "last_use_at": "2000-01-01T01:00:00Z",
+  "name": "My Main API Key",
+  "path": "shared/docs",
+  "permission_set": "full",
+  "platform": "win32",
+  "user_id": 1
+}
+```
+
+* `id` (int64): API Key ID
+* `descriptive_label` (string): Unique label that describes this API key.  Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
+* `created_at` (date-time): Time which API Key was created
+* `expires_at` (date-time): API Key expiration date
+* `key` (string): API Key actual key string
+* `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
+* `name` (string): Internal name for the API Key.  For your use.
+* `path` (string): Folder path restriction for this api key. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+* `platform` (string): If this API key represents a Desktop app, what platform was it created on?
+* `user_id` (int64): User ID for the owner of this API Key.  May be blank for Site-wide API Keys.
+
+---
+
+## List Api Keys
+
+```
+await ApiKey.list({
+  'user_id': 1,
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `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 (e.g. sort_by[last_login_at]=desc). Valid fields are `expires_at`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `expires_at`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `expires_at`.
+
+---
+
+## Show information about current API key.  (Requires current API connection to be using an API key.)
+
+```
+await ApiKey.findCurrent
+```
+
+
+---
+
+## Show Api Key
+
+```
+await ApiKey.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Api Key ID.
+
+---
+
+## Create Api Key
+
+```
+await ApiKey.create({
+  'user_id': 1,
+  'name': "My Main API Key",
+  'expires_at': "2000-01-01T01:00:00Z",
+  'permission_set': "full",
+  'path': "shared/docs",
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `name` (string): Internal name for the API Key.  For your use.
+* `expires_at` (string): API Key expiration date
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+* `path` (string): Folder path restriction for this api key.
+
+---
+
+## Update current API key.  (Requires current API connection to be using an API key.)
+
+```
+await ApiKey.updateCurrent({
+  'expires_at': "2000-01-01T01:00:00Z",
+  'name': "My Main API Key",
+  'permission_set': "full",
+})
+```
+
+
+### Parameters
+
+* `expires_at` (string): API Key expiration date
+* `name` (string): Internal name for the API Key.  For your use.
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+
+---
+
+## Delete current API key.  (Requires current API connection to be using an API key.)
+
+```
+await ApiKey.deleteCurrent
+```
+
+
+---
+
+## Update Api Key
+
+```
+const [api_key] = await ApiKey.list()
+
+await api_key.update({
+  'name': "My Main API Key",
+  'expires_at': "2000-01-01T01:00:00Z",
+  'permission_set': "full",
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Api Key ID.
+* `name` (string): Internal name for the API Key.  For your use.
+* `expires_at` (string): API Key expiration date
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
+  "created_at": "2000-01-01T01:00:00Z",
+  "expires_at": "2000-01-01T01:00:00Z",
+  "key": "[key]",
+  "last_use_at": "2000-01-01T01:00:00Z",
+  "name": "My Main API Key",
+  "path": "shared/docs",
+  "permission_set": "full",
+  "platform": "win32",
+  "user_id": 1
+}
+```
+
+---
+
+## Delete Api Key
+
+```
+const [api_key] = await ApiKey.list()
+
+await api_key.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Api Key ID.
+

package/docs/models/App.md

@@ -0,0 +1,66 @@
+# App
+
+## Example App Object
+
+```
+{
+  "name": "",
+  "extended_description": "",
+  "short_description": "",
+  "documentation_links": "Important Info => http://files.test/learn-more",
+  "icon_url": "",
+  "logo_url": "",
+  "screenshot_list_urls": [
+    ""
+  ],
+  "logo_thumbnail_url": "",
+  "sso_strategy_type": "",
+  "remote_server_type": "",
+  "folder_behavior_type": "",
+  "external_homepage_url": "",
+  "marketing_youtube_url": "",
+  "tutorial_youtube_url": "",
+  "app_type": "",
+  "featured": true
+}
+```
+
+* `name` (string): Name of the App
+* `extended_description` (string): Long form description of the App
+* `short_description` (string): Short description of the App
+* `documentation_links` (object): Collection of named links to documentation
+* `icon_url` (string): App icon
+* `logo_url` (string): Full size logo for the App
+* `screenshot_list_urls` (string): Screenshots of the App
+* `logo_thumbnail_url` (string): Logo thumbnail for the App
+* `sso_strategy_type` (string): Associated SSO Strategy type, if any
+* `remote_server_type` (string): Associated Remote Server type, if any
+* `folder_behavior_type` (string): Associated Folder Behavior type, if any
+* `external_homepage_url` (string): Link to external homepage
+* `marketing_youtube_url` (string): Marketing video page
+* `tutorial_youtube_url` (string): Tutorial video page
+* `app_type` (string): The type of the App
+* `featured` (boolean): Is featured on the App listing?
+
+---
+
+## List Apps
+
+```
+await App.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `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 (e.g. sort_by[last_login_at]=desc). Valid fields are `name` and `app_type`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.