Skip to content

Commit

Permalink
docs: Rename platform application (#889)
Browse files Browse the repository at this point in the history
  • Loading branch information
congminh1254 authored Jan 13, 2025
1 parent 5b109ad commit 56c824d
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 34 deletions.
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,26 @@ A Node.js interface to the [Box Content API](https://developer.box.com/reference
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Installation](#installation)
- [Getting Started](#getting-started)
- [Creating API Clients](#creating-api-clients)
- [Basic Client](#basic-client)
- [Persistent Client](#persistent-client)
- [App Auth Client](#app-auth-client)
- [Using the Client to Make API Calls](#using-the-client-to-make-api-calls)
- [Constructing API Calls Manually](#constructing-api-calls-manually)
- [FIPS 140-2 Compliance](#fips-140-2-compliance)
- [Versions](#versions)
- [Supported Version](#supported-version)
- [Version schedule](#version-schedule)
- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
- [Contributing to the Box Node.js SDK](#contributing-to-the-box-nodejs-sdk)
- [Changelog](#changelog)
- [Upgrades](#upgrades)
- [Documentation](#documentation)
- [Copyright and License](#copyright-and-license)
- [Deprecation notice](#deprecation-notice)
- [Box Node.js SDK](#box-nodejs-sdk)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Creating API Clients](#creating-api-clients)
- [Basic Client](#basic-client)
- [Persistent Client](#persistent-client)
- [App Auth Client](#app-auth-client)
- [Using the Client to Make API Calls](#using-the-client-to-make-api-calls)
- [Constructing API Calls Manually](#constructing-api-calls-manually)
- [FIPS 140-2 Compliance](#fips-140-2-compliance)
- [Versions](#versions)
- [Supported Version](#supported-version)
- [Version schedule](#version-schedule)
- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
- [Contributing to the Box Node.js SDK](#contributing-to-the-box-nodejs-sdk)
- [Changelog](#changelog)
- [Upgrades](#upgrades)
- [Documentation](#documentation)
- [Copyright and License](#copyright-and-license)

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

Expand All @@ -53,7 +55,7 @@ npm install --save box-node-sdk


To get started with the SDK, get a Developer Token from the Configuration page
of your app in the [Box Developer Console][dev-console].
of your platform app in the [Box Developer Console][dev-console].
You can use this token to make test calls for your own Box account.

```js
Expand Down Expand Up @@ -129,7 +131,7 @@ Note that these methods don't pass in identifying information as arguments. You'

### App Auth Client

App Auth allows an app to fully manage the Box accounts of its users; they do not
App Auth allows an platform app to fully manage the Box accounts of its users; they do not
have direct login credentials to Box and all operations are performed through the API
using a JWT grant.

Expand Down
19 changes: 10 additions & 9 deletions docs/terms-of-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,22 @@ Terms of Service
================

Terms of Service are custom objects that the admin of an enterprise can configure. This will prompt the
end user to accept/re-accept or decline the custom Terms of Service for custom applications built on
end user to accept/re-accept or decline the custom Terms of Service for platform applications built on
Box Platform.

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


- [Get Terms of Service for an Enterprise](#get-terms-of-service-for-an-enterprise)
- [Get a Terms of Service By ID for an Enterprise](#get-a-terms-of-service-by-id-for-an-enterprise)
- [Update a Terms of Service for an Enterprise](#update-a-terms-of-service-for-an-enterprise)
- [Create a Terms of Service for an Enterprise](#create-a-terms-of-service-for-an-enterprise)
- [Get Terms of Service Status for User](#get-terms-of-service-status-for-user)
- [Create User Status on Terms of Service](#create-user-status-on-terms-of-service)
- [Update User Status on Terms of Service](#update-user-status-on-terms-of-service)
- [Accept or Decline a Terms of Service](#accept-or-decline-a-terms-of-service)
- [Terms of Service](#terms-of-service)
- [Get Terms of Service for an Enterprise](#get-terms-of-service-for-an-enterprise)
- [Get a Terms of Service By ID](#get-a-terms-of-service-by-id)
- [Update a Terms of Service for an Enterprise](#update-a-terms-of-service-for-an-enterprise)
- [Create a Terms of Service for an Enterprise](#create-a-terms-of-service-for-an-enterprise)
- [Get Terms of Service Status for User](#get-terms-of-service-status-for-user)
- [Create User Status on Terms of Service](#create-user-status-on-terms-of-service)
- [Update User Status on Terms of Service](#update-user-status-on-terms-of-service)
- [Accept or Decline a Terms of Service](#accept-or-decline-a-terms-of-service)

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

Expand Down
2 changes: 1 addition & 1 deletion tests/integration_test/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
6 changes: 2 additions & 4 deletions tests/integration_test/__tests__/metadata.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,10 @@ test('test metadata search', async() => {
const searchResults = await context.appClient.metadata.query(searchForm, ancestorFolderId, queryOptions);
// Sometimes, despite correctly sent metadata, the search does not return files because they probably haven't been properly indexed yet
expect(searchResults.entries.length).toBeGreaterThanOrEqual(0);
}
finally {
} finally {
await file.dispose();
}
}
finally {
} finally {
await context.appClient.metadata.deleteTemplate('enterprise', metadataTemplate.templateKey);
}
}, 120000);
Expand Down

0 comments on commit 56c824d

Please sign in to comment.