box-typescript-sdk-gen
v1.7.0
Published
Official Box TypeScript Generated SDK
Downloads
41,288
Readme
Box TypeScript SDK GENERATED
We are excited to introduce the stable release of the latest generation of Box TypeScript SDK, designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
With this SDK, you’ll have access to:
- Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications.
- Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.
- Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process.
- Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more.
- Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic.
Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.
Table of contents
- Installing
- Getting Started
- Documentation
- Upgrades
- Integration Tests
- Questions, Bugs, and Feature Requests?
- Copyright and License
Installing
npm install box-typescript-sdk-gen
If you use yarn, please do this instead:
yarn add box-typescript-sdk-gen
This is autogenerated Box SDK version.
Getting Started
To get started with the SDK, get a Developer Token from the Configuration page of your app in the Box Developer Console. You can use this token to make test calls for your own Box account.
The SDK provides an DeveloperTokenAuth
class, which allows you to authenticate using your Developer Token.
Use instance of DeveloperTokenAuth
to initialize Client
object.
Using Client
object you can access managers, which allow you to perform some operations on your Box account.
The example below demonstrates how to authenticate with Developer Token and print names of all items inside a root folder.
const { BoxClient, BoxDeveloperTokenAuth } = require('box-typescript-sdk-gen');
async function main(token) {
let auth = new BoxDeveloperTokenAuth({ token });
let client = new BoxClient({ auth });
let entries = (await client.folders.getFolderItems('0')).entries;
entries.forEach((entry) => console.log(entry));
}
main('INSERT YOUR DEVELOPER TOKEN HERE');
In order to use in browser make sure you include the lib/bundle.js
file and then you can access the classes like so:
const { BoxClient, BoxDeveloperTokenAuth } = window['box-typescript-sdk-gen'];
See example.html for an example website using this SDK.
To run the example locally:
- Start the local server by running
npx serve -p 3000
in the project directory. - Make sure
http://localhost:3000
is allowlisted in CORS Domains of your application. - Head over to
http://localhost:3000/example.html
. - Provide a fresh Developer Token to the dialog window that shows up upon running the example.
- Make sure that you get an alert message that includes your user name.
Documentation
Browse the docs or see API Reference for more information.
Upgrades
Upgrading from our legacy SDKs to the new generation SDKs is a straightforward process. See our migration guide and changelog for more information.
Integration Tests
Running integration tests locally
Create Custom Application
To run integration tests locally you will need a Custom App
created in the Box Developer
Console with Server Authentication (with JWT)
selected as authentication method.
Once created you can edit properties of the application:
- In section
App Access Level
selectApp + Enterprise Access
. You can enable allApplication Scopes
. - In section
Advanced Features
enableMake API calls using the as-user header
andGenerate user access tokens
.
Now select Authorization
and submit application to be reviewed by account admin.
Export configuration
- Select
Configuration
tab and in the bottom in the sectionApp Settings
download your app configuration settings as JSON. - Encode configuration file to Base64, e.g. using command:
base64 -i path_to_json_file
- Set environment variable:
JWT_CONFIG_BASE_64
with base64 encoded jwt configuration file - Set environment variable:
BOX_FILE_REQUEST_ID
with ID of file request already created in the user account,BOX_EXTERNAL_USER_EMAIL
with email of free external user which not belongs to any enterprise. - Set environment variable:
WORKFLOW_FOLDER_ID
with the ID of the Relay workflow that deletes the file that triggered the workflow. The workflow should have a manual start to be able to start it from the API. - Set environment variable:
APP_ITEM_ASSOCIATION_FILE_ID
to the ID of the file with associated app item andAPP_ITEM_ASSOCIATION_FOLDER_ID
to the ID of the folder with associated app item.
Questions, Bugs, and Feature Requests?
Need to contact us directly? Browse the issues tickets! Or, if that doesn't work, file a new one and we will get back to you. If you have general questions about the Box API, you can post to the Box Developer Forum.
Copyright and License
Copyright 2023 Box, Inc. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.