Skip to content

Commit 0a607da

Browse files
docs: Add React example to TypeScript SDK (box/box-codegen#689) (#564)
1 parent 21eb211 commit 0a607da

File tree

5 files changed

+235
-137
lines changed

5 files changed

+235
-137
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "3ff590c", "specHash": "c303afc", "version": "1.14.0" }
1+
{ "engineHash": "d98deb7", "specHash": "c303afc", "version": "1.14.0" }

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Embrace the new generation of Box SDKs and unlock the full potential of the Box
3333
- [Installing](#installing)
3434
- [Getting Started](#getting-started)
3535
- [Documentation](#documentation)
36+
- [Browser Support](#browser-support)
3637
- [Upgrades](#upgrades)
3738
- [Integration Tests](#integration-tests)
3839
- [Running integration tests locally](#running-integration-tests-locally)
@@ -101,6 +102,12 @@ To run the example locally:
101102

102103
Browse the [docs](docs/README.md) or see [API Reference](https://developer.box.com/reference/) for more information.
103104

105+
# Browser Support
106+
107+
This SDK works in modern browsers that support ES6+ features. It seamlessly integrates with frontend frameworks like ReactJS, Angular, and NextJS. Check out our example below:
108+
109+
- [React Sample App](https://github.com/box-community/box-ts-sdk-react)
110+
104111
# Upgrades
105112

106113
Upgrading from our legacy SDKs to the new generation SDKs is a straightforward process. See our [migration guide](migration-guide.md) and [changelog](CHANGELOG.md) for more information.

docs/devicePinners.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ This operation is performed by calling function `getDevicePinnerById`.
1313
See the endpoint docs at
1414
[API Reference](https://developer.box.com/reference/get-device-pinners-id/).
1515

16-
_Currently we don't have an example for calling `getDevicePinnerById` in integration tests_
16+
<!-- sample get_device_pinners_id -->
17+
18+
```ts
19+
await client.devicePinners.getDevicePinnerById(devicePinnerId);
20+
```
1721

1822
### Arguments
1923

@@ -37,7 +41,11 @@ This operation is performed by calling function `deleteDevicePinnerById`.
3741
See the endpoint docs at
3842
[API Reference](https://developer.box.com/reference/delete-device-pinners-id/).
3943

40-
_Currently we don't have an example for calling `deleteDevicePinnerById` in integration tests_
44+
<!-- sample delete_device_pinners_id -->
45+
46+
```ts
47+
await client.devicePinners.deleteDevicePinnerById(devicePinnerId);
48+
```
4149

4250
### Arguments
4351

@@ -64,7 +72,11 @@ This operation is performed by calling function `getEnterpriseDevicePinners`.
6472
See the endpoint docs at
6573
[API Reference](https://developer.box.com/reference/get-enterprises-id-device-pinners/).
6674

67-
_Currently we don't have an example for calling `getEnterpriseDevicePinners` in integration tests_
75+
<!-- sample get_enterprises_id_device_pinners -->
76+
77+
```ts
78+
await client.devicePinners.getEnterpriseDevicePinners(enterpriseId);
79+
```
6880

6981
### Arguments
7082

0 commit comments

Comments
 (0)