Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Rename platform application #886

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 48 additions & 47 deletions docs/usage/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,52 +8,53 @@ file's contents, upload new versions, and perform other common file operations
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [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)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -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
Expand Down
15 changes: 8 additions & 7 deletions docs/usage/terms_of_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [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)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down
33 changes: 17 additions & 16 deletions docs/usage/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,22 @@ Users represent an individual's account on Box.
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [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)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/integration_new/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading