Skip to content

Commit f40763b

Browse files
committed
docs: Rename platform application
1 parent f351590 commit f40763b

File tree

4 files changed

+74
-71
lines changed

4 files changed

+74
-71
lines changed

docs/usage/files.md

Lines changed: 48 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -8,52 +8,53 @@ file's contents, upload new versions, and perform other common file operations
88
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
99
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1010

11-
- [Get a File's Information](#get-a-files-information)
12-
- [Update a File's Information](#update-a-files-information)
13-
- [Download a File](#download-a-file)
14-
- [Get Download URL](#get-download-url)
15-
- [Upload a File](#upload-a-file)
16-
- [Chunked Upload](#chunked-upload)
17-
- [Automatic Uploader](#automatic-uploader)
18-
- [Upload new file](#upload-new-file)
19-
- [Upload new file version](#upload-new-file-version)
20-
- [Preflight check before upload](#preflight-check-before-upload)
21-
- [Resume Upload](#resume-upload)
22-
- [Abort Chunked Upload](#abort-chunked-upload)
23-
- [Manual Process](#manual-process)
24-
- [Create Upload Session for File Version](#create-upload-session-for-file-version)
25-
- [Create Upload Session for File](#create-upload-session-for-file)
26-
- [Upload Part](#upload-part)
27-
- [Commit Upload Session](#commit-upload-session)
28-
- [Abort Upload Session](#abort-upload-session)
29-
- [List Upload Parts](#list-upload-parts)
30-
- [Move a File](#move-a-file)
31-
- [Copy a File](#copy-a-file)
32-
- [Rename a File](#rename-a-file)
33-
- [Delete a File](#delete-a-file)
34-
- [Get Previous Versions of a File](#get-previous-versions-of-a-file)
35-
- [Upload a New Version of a File](#upload-a-new-version-of-a-file)
36-
- [Promote a Previous Version of a File](#promote-a-previous-version-of-a-file)
37-
- [Delete a Previous Version of a File](#delete-a-previous-version-of-a-file)
38-
- [Lock a File](#lock-a-file)
39-
- [Unlock a File](#unlock-a-file)
40-
- [Create a Shared Link Download URL](#create-a-shared-link-download-url)
41-
- [Find a File for a Shared Link](#find-a-file-for-a-shared-link)
42-
- [Create or update a Shared Link](#create-or-update-a-shared-link)
43-
- [Get a Shared Link](#get-a-shared-link)
44-
- [Remove a Shared Link](#remove-a-shared-link)
45-
- [Get an Embed Link](#get-an-embed-link)
46-
- [Get File Representations](#get-file-representations)
47-
- [Get Thumbnail (Deprecated)](#get-thumbnail-deprecated)
48-
- [Get Thumbnail](#get-thumbnail)
49-
- [Set Metadata](#set-metadata)
50-
- [Get Metadata](#get-metadata)
51-
- [Remove Metadata](#remove-metadata)
52-
- [Get All Metadata](#get-all-metadata)
53-
- [Set a Classification](#set-a-classification)
54-
- [Retrieve a Classification](#retrieve-a-classification)
55-
- [Remove a Classification](#remove-a-classification)
56-
- [Set retention policy expiration date](#set-retention-policy-expiration-date)
11+
- [Files](#files)
12+
- [Get a File's Information](#get-a-files-information)
13+
- [Update a File's Information](#update-a-files-information)
14+
- [Download a File](#download-a-file)
15+
- [Get Download URL](#get-download-url)
16+
- [Upload a File](#upload-a-file)
17+
- [Chunked Upload](#chunked-upload)
18+
- [Automatic Uploader](#automatic-uploader)
19+
- [Upload new file](#upload-new-file)
20+
- [Upload new file version](#upload-new-file-version)
21+
- [Preflight check before upload](#preflight-check-before-upload)
22+
- [Resume Upload](#resume-upload)
23+
- [Abort Chunked Upload](#abort-chunked-upload)
24+
- [Manual Process](#manual-process)
25+
- [Create Upload Session for File Version](#create-upload-session-for-file-version)
26+
- [Create Upload Session for File](#create-upload-session-for-file)
27+
- [Upload Part](#upload-part)
28+
- [Commit Upload Session](#commit-upload-session)
29+
- [Abort Upload Session](#abort-upload-session)
30+
- [List Upload Parts](#list-upload-parts)
31+
- [Move a File](#move-a-file)
32+
- [Copy a File](#copy-a-file)
33+
- [Rename a File](#rename-a-file)
34+
- [Delete a File](#delete-a-file)
35+
- [Get Previous Versions of a File](#get-previous-versions-of-a-file)
36+
- [Upload a New Version of a File](#upload-a-new-version-of-a-file)
37+
- [Promote a Previous Version of a File](#promote-a-previous-version-of-a-file)
38+
- [Delete a Previous Version of a File](#delete-a-previous-version-of-a-file)
39+
- [Lock a File](#lock-a-file)
40+
- [Unlock a File](#unlock-a-file)
41+
- [Create a Shared Link Download URL](#create-a-shared-link-download-url)
42+
- [Find a File for a Shared Link](#find-a-file-for-a-shared-link)
43+
- [Create or update a Shared Link](#create-or-update-a-shared-link)
44+
- [Get a Shared Link](#get-a-shared-link)
45+
- [Remove a Shared Link](#remove-a-shared-link)
46+
- [Get an Embed Link](#get-an-embed-link)
47+
- [Get File Representations](#get-file-representations)
48+
- [Get Thumbnail (Deprecated)](#get-thumbnail-deprecated)
49+
- [Get Thumbnail](#get-thumbnail)
50+
- [Set Metadata](#set-metadata)
51+
- [Get Metadata](#get-metadata)
52+
- [Remove Metadata](#remove-metadata)
53+
- [Get All Metadata](#get-all-metadata)
54+
- [Set a Classification](#set-a-classification)
55+
- [Retrieve a Classification](#retrieve-a-classification)
56+
- [Remove a Classification](#remove-a-classification)
57+
- [Set retention policy expiration date](#set-retention-policy-expiration-date)
5758

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

@@ -786,7 +787,7 @@ representations will be returned. This method returns a `list` of `dict`s conta
786787
requested [representations][rep_api_obj].
787788

788789
Note that this method only provides information about a set of available representations; your
789-
application will need to handle checking the status of the representations and downlaoding them
790+
application will need to handle checking the status of the representations and downloading them
790791
via the provided content URL template.
791792

792793
```python

docs/usage/terms_of_service.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@ Terms of Service
22
================
33

44
Terms of Service allows Box Admins to configure a custom Terms of Service for end users to
5-
accept/re-accept/decline for custom applications
5+
accept/re-accept/decline for platform applications
66

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

1010

11-
- [Create a Terms of Service](#create-a-terms-of-service)
12-
- [Edit a Terms of Service](#edit-a-terms-of-service)
13-
- [Get Terms of Service](#get-terms-of-service)
14-
- [List Terms of Service](#list-terms-of-service)
15-
- [Accept or Decline a Terms of Service](#accept-or-decline-a-terms-of-service)
16-
- [Get User Status for a Terms of Service](#get-user-status-for-a-terms-of-service)
11+
- [Terms of Service](#terms-of-service)
12+
- [Create a Terms of Service](#create-a-terms-of-service)
13+
- [Edit a Terms of Service](#edit-a-terms-of-service)
14+
- [Get Terms of Service](#get-terms-of-service)
15+
- [List Terms of Service](#list-terms-of-service)
16+
- [Accept or Decline a Terms of Service](#accept-or-decline-a-terms-of-service)
17+
- [Get User Status for a Terms of Service](#get-user-status-for-a-terms-of-service)
1718

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

docs/usage/user.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,22 @@ Users represent an individual's account on Box.
66
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
77
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
88

9-
- [Get User Information](#get-user-information)
10-
- [Get the Current User's Information](#get-the-current-users-information)
11-
- [Create An Enterprise User](#create-an-enterprise-user)
12-
- [Get the Avatar for a User](#get-the-avatar-for-a-user)
13-
- [Upload user avatar](#upload-user-avatar)
14-
- [Delete user avatar](#delete-user-avatar)
15-
- [Create An App User](#create-an-app-user)
16-
- [Update User](#update-user)
17-
- [Delete User](#delete-user)
18-
- [Invite User to Enterprise](#invite-user-to-enterprise)
19-
- [Get Email Aliases](#get-email-aliases)
20-
- [Add Email Alias](#add-email-alias)
21-
- [Remove Email Alias](#remove-email-alias)
22-
- [Get Enterprise Users](#get-enterprise-users)
23-
- [Transfer User Content](#transfer-user-content)
9+
- [Users](#users)
10+
- [Get User Information](#get-user-information)
11+
- [Get the Current User's Information](#get-the-current-users-information)
12+
- [Create An Enterprise User](#create-an-enterprise-user)
13+
- [Get the Avatar for a User](#get-the-avatar-for-a-user)
14+
- [Upload user avatar](#upload-user-avatar)
15+
- [Delete user avatar](#delete-user-avatar)
16+
- [Create An App User](#create-an-app-user)
17+
- [Update User](#update-user)
18+
- [Delete User](#delete-user)
19+
- [Invite User to Enterprise](#invite-user-to-enterprise)
20+
- [Get Email Aliases](#get-email-aliases)
21+
- [Add Email Alias](#add-email-alias)
22+
- [Remove Email Alias](#remove-email-alias)
23+
- [Get Enterprise Users](#get-enterprise-users)
24+
- [Transfer User Content](#transfer-user-content)
2425

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

@@ -126,7 +127,7 @@ client.user('33333').delete_avatar()
126127
Create An App User
127128
------------------
128129

129-
Custom applications may create App Users, which represent a "headless" user managed exclusively by the application.
130+
Platform applications may create App Users, which represent a "headless" user managed exclusively by the application.
130131
These users can only be accessed via the API, and cannot login to the web application or other Box services.
131132

132133
To create a new app user, call [`client.create_user(name, login=None, **user_attributes)`][create_user] without a

test/integration_new/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Running integration tests locally
44

5-
### Create Custom Application
5+
### Create Platform Application
66
To run integration tests locally you will need a `Custom App` created at https://cloud.app.box.com/developers/console
77
with `Server Authentication (with JWT)` selected as authentication method.
88
Once created you can edit properties of the application:

0 commit comments

Comments
 (0)