From f40763b46a861f1878465c33db63b4c7517cbf46 Mon Sep 17 00:00:00 2001 From: Minh Nguyen Cong Date: Fri, 10 Jan 2025 09:43:31 +0100 Subject: [PATCH] docs: Rename platform application --- docs/usage/files.md | 95 +++++++++++++++++----------------- docs/usage/terms_of_service.md | 15 +++--- docs/usage/user.md | 33 ++++++------ test/integration_new/README.md | 2 +- 4 files changed, 74 insertions(+), 71 deletions(-) diff --git a/docs/usage/files.md b/docs/usage/files.md index 125b2abb..73dab7a4 100644 --- a/docs/usage/files.md +++ b/docs/usage/files.md @@ -8,52 +8,53 @@ file's contents, upload new versions, and perform other common file operations -- [Get a File's Information](#get-a-files-information) -- [Update a File's Information](#update-a-files-information) -- [Download a File](#download-a-file) -- [Get Download URL](#get-download-url) -- [Upload a File](#upload-a-file) -- [Chunked Upload](#chunked-upload) - - [Automatic Uploader](#automatic-uploader) - - [Upload new file](#upload-new-file) - - [Upload new file version](#upload-new-file-version) - - [Preflight check before upload](#preflight-check-before-upload) - - [Resume Upload](#resume-upload) - - [Abort Chunked Upload](#abort-chunked-upload) - - [Manual Process](#manual-process) - - [Create Upload Session for File Version](#create-upload-session-for-file-version) - - [Create Upload Session for File](#create-upload-session-for-file) - - [Upload Part](#upload-part) - - [Commit Upload Session](#commit-upload-session) - - [Abort Upload Session](#abort-upload-session) - - [List Upload Parts](#list-upload-parts) -- [Move a File](#move-a-file) -- [Copy a File](#copy-a-file) -- [Rename a File](#rename-a-file) -- [Delete a File](#delete-a-file) -- [Get Previous Versions of a File](#get-previous-versions-of-a-file) -- [Upload a New Version of a File](#upload-a-new-version-of-a-file) -- [Promote a Previous Version of a File](#promote-a-previous-version-of-a-file) -- [Delete a Previous Version of a File](#delete-a-previous-version-of-a-file) -- [Lock a File](#lock-a-file) -- [Unlock a File](#unlock-a-file) -- [Create a Shared Link Download URL](#create-a-shared-link-download-url) -- [Find a File for a Shared Link](#find-a-file-for-a-shared-link) -- [Create or update a Shared Link](#create-or-update-a-shared-link) -- [Get a Shared Link](#get-a-shared-link) -- [Remove a Shared Link](#remove-a-shared-link) -- [Get an Embed Link](#get-an-embed-link) -- [Get File Representations](#get-file-representations) -- [Get Thumbnail (Deprecated)](#get-thumbnail-deprecated) -- [Get Thumbnail](#get-thumbnail) -- [Set Metadata](#set-metadata) -- [Get Metadata](#get-metadata) -- [Remove Metadata](#remove-metadata) -- [Get All Metadata](#get-all-metadata) -- [Set a Classification](#set-a-classification) -- [Retrieve a Classification](#retrieve-a-classification) -- [Remove a Classification](#remove-a-classification) -- [Set retention policy expiration date](#set-retention-policy-expiration-date) +- [Files](#files) + - [Get a File's Information](#get-a-files-information) + - [Update a File's Information](#update-a-files-information) + - [Download a File](#download-a-file) + - [Get Download URL](#get-download-url) + - [Upload a File](#upload-a-file) + - [Chunked Upload](#chunked-upload) + - [Automatic Uploader](#automatic-uploader) + - [Upload new file](#upload-new-file) + - [Upload new file version](#upload-new-file-version) + - [Preflight check before upload](#preflight-check-before-upload) + - [Resume Upload](#resume-upload) + - [Abort Chunked Upload](#abort-chunked-upload) + - [Manual Process](#manual-process) + - [Create Upload Session for File Version](#create-upload-session-for-file-version) + - [Create Upload Session for File](#create-upload-session-for-file) + - [Upload Part](#upload-part) + - [Commit Upload Session](#commit-upload-session) + - [Abort Upload Session](#abort-upload-session) + - [List Upload Parts](#list-upload-parts) + - [Move a File](#move-a-file) + - [Copy a File](#copy-a-file) + - [Rename a File](#rename-a-file) + - [Delete a File](#delete-a-file) + - [Get Previous Versions of a File](#get-previous-versions-of-a-file) + - [Upload a New Version of a File](#upload-a-new-version-of-a-file) + - [Promote a Previous Version of a File](#promote-a-previous-version-of-a-file) + - [Delete a Previous Version of a File](#delete-a-previous-version-of-a-file) + - [Lock a File](#lock-a-file) + - [Unlock a File](#unlock-a-file) + - [Create a Shared Link Download URL](#create-a-shared-link-download-url) + - [Find a File for a Shared Link](#find-a-file-for-a-shared-link) + - [Create or update a Shared Link](#create-or-update-a-shared-link) + - [Get a Shared Link](#get-a-shared-link) + - [Remove a Shared Link](#remove-a-shared-link) + - [Get an Embed Link](#get-an-embed-link) + - [Get File Representations](#get-file-representations) + - [Get Thumbnail (Deprecated)](#get-thumbnail-deprecated) + - [Get Thumbnail](#get-thumbnail) + - [Set Metadata](#set-metadata) + - [Get Metadata](#get-metadata) + - [Remove Metadata](#remove-metadata) + - [Get All Metadata](#get-all-metadata) + - [Set a Classification](#set-a-classification) + - [Retrieve a Classification](#retrieve-a-classification) + - [Remove a Classification](#remove-a-classification) + - [Set retention policy expiration date](#set-retention-policy-expiration-date) @@ -786,7 +787,7 @@ representations will be returned. This method returns a `list` of `dict`s conta requested [representations][rep_api_obj]. Note that this method only provides information about a set of available representations; your -application will need to handle checking the status of the representations and downlaoding them +application will need to handle checking the status of the representations and downloading them via the provided content URL template. ```python diff --git a/docs/usage/terms_of_service.md b/docs/usage/terms_of_service.md index 662acfaf..ae8ca936 100644 --- a/docs/usage/terms_of_service.md +++ b/docs/usage/terms_of_service.md @@ -2,18 +2,19 @@ Terms of Service ================ Terms of Service allows Box Admins to configure a custom Terms of Service for end users to -accept/re-accept/decline for custom applications +accept/re-accept/decline for platform applications -- [Create a Terms of Service](#create-a-terms-of-service) -- [Edit a Terms of Service](#edit-a-terms-of-service) -- [Get Terms of Service](#get-terms-of-service) -- [List Terms of Service](#list-terms-of-service) -- [Accept or Decline a Terms of Service](#accept-or-decline-a-terms-of-service) -- [Get User Status for a Terms of Service](#get-user-status-for-a-terms-of-service) +- [Terms of Service](#terms-of-service) + - [Create a Terms of Service](#create-a-terms-of-service) + - [Edit a Terms of Service](#edit-a-terms-of-service) + - [Get Terms of Service](#get-terms-of-service) + - [List Terms of Service](#list-terms-of-service) + - [Accept or Decline a Terms of Service](#accept-or-decline-a-terms-of-service) + - [Get User Status for a Terms of Service](#get-user-status-for-a-terms-of-service) diff --git a/docs/usage/user.md b/docs/usage/user.md index c05e46a3..67723723 100644 --- a/docs/usage/user.md +++ b/docs/usage/user.md @@ -6,21 +6,22 @@ Users represent an individual's account on Box. -- [Get User Information](#get-user-information) -- [Get the Current User's Information](#get-the-current-users-information) -- [Create An Enterprise User](#create-an-enterprise-user) -- [Get the Avatar for a User](#get-the-avatar-for-a-user) -- [Upload user avatar](#upload-user-avatar) -- [Delete user avatar](#delete-user-avatar) -- [Create An App User](#create-an-app-user) -- [Update User](#update-user) -- [Delete User](#delete-user) -- [Invite User to Enterprise](#invite-user-to-enterprise) -- [Get Email Aliases](#get-email-aliases) -- [Add Email Alias](#add-email-alias) -- [Remove Email Alias](#remove-email-alias) -- [Get Enterprise Users](#get-enterprise-users) -- [Transfer User Content](#transfer-user-content) +- [Users](#users) + - [Get User Information](#get-user-information) + - [Get the Current User's Information](#get-the-current-users-information) + - [Create An Enterprise User](#create-an-enterprise-user) + - [Get the Avatar for a User](#get-the-avatar-for-a-user) + - [Upload user avatar](#upload-user-avatar) + - [Delete user avatar](#delete-user-avatar) + - [Create An App User](#create-an-app-user) + - [Update User](#update-user) + - [Delete User](#delete-user) + - [Invite User to Enterprise](#invite-user-to-enterprise) + - [Get Email Aliases](#get-email-aliases) + - [Add Email Alias](#add-email-alias) + - [Remove Email Alias](#remove-email-alias) + - [Get Enterprise Users](#get-enterprise-users) + - [Transfer User Content](#transfer-user-content) @@ -126,7 +127,7 @@ client.user('33333').delete_avatar() Create An App User ------------------ -Custom applications may create App Users, which represent a "headless" user managed exclusively by the application. +Platform applications may create App Users, which represent a "headless" user managed exclusively by the application. These users can only be accessed via the API, and cannot login to the web application or other Box services. To create a new app user, call [`client.create_user(name, login=None, **user_attributes)`][create_user] without a diff --git a/test/integration_new/README.md b/test/integration_new/README.md index f2a7c5da..f3cb2d16 100644 --- a/test/integration_new/README.md +++ b/test/integration_new/README.md @@ -2,7 +2,7 @@ ## Running integration tests locally -### Create Custom Application +### Create Platform Application To run integration tests locally you will need a `Custom App` created at https://cloud.app.box.com/developers/console with `Server Authentication (with JWT)` selected as authentication method. Once created you can edit properties of the application: