Skip to content
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
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "7b699f4", "specHash": "1698c95", "version": "0.5.3" }
{ "engineHash": "f3d7de8", "specHash": "1698c95", "version": "0.5.3" }
10 changes: 5 additions & 5 deletions docs/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ _Currently we don't have an example for calling `authorizeUser` in integration t

- queryParams `AuthorizeUserQueryParams`
- Query parameters of authorizeUser method
- headers `AuthorizeUserHeaders`
- headersInput `AuthorizeUserHeadersInput`
- Headers of authorizeUser method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -63,7 +63,7 @@ _Currently we don't have an example for calling `requestAccessToken` in integrat

- requestBody `PostOAuth2Token`
- Request body of requestAccessToken method
- headers `RequestAccessTokenHeaders`
- headersInput `RequestAccessTokenHeadersInput`
- Headers of requestAccessToken method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand All @@ -89,9 +89,9 @@ _Currently we don't have an example for calling `refreshAccessToken` in integrat

### Arguments

- requestBody `PostOAuth2TokenRefreshAccessToken`
- requestBodyInput `PostOAuth2TokenRefreshAccessTokenInput`
- Request body of refreshAccessToken method
- headers `RefreshAccessTokenHeaders`
- headersInput `RefreshAccessTokenHeadersInput`
- Headers of refreshAccessToken method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -120,7 +120,7 @@ _Currently we don't have an example for calling `revokeAccessToken` in integrati

- requestBody `PostOAuth2Revoke`
- Request body of revokeAccessToken method
- headers `RevokeAccessTokenHeaders`
- headersInput `RevokeAccessTokenHeadersInput`
- Headers of revokeAccessToken method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down
6 changes: 3 additions & 3 deletions docs/avatars.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ await client.avatars.getUserAvatar(user.id);

- userId `string`
- The ID of the user. Example: "12345"
- headers `GetUserAvatarHeaders`
- headersInput `GetUserAvatarHeadersInput`
- Headers of getUserAvatar method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -63,7 +63,7 @@ await client.avatars.createUserAvatar(user.id, {
- The ID of the user. Example: "12345"
- requestBody `CreateUserAvatarRequestBody`
- Request body of createUserAvatar method
- headers `CreateUserAvatarHeaders`
- headersInput `CreateUserAvatarHeadersInput`
- Headers of createUserAvatar method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -96,7 +96,7 @@ await client.avatars.deleteUserAvatar(user.id);

- userId `string`
- The ID of the user. Example: "12345"
- headers `DeleteUserAvatarHeaders`
- headersInput `DeleteUserAvatarHeadersInput`
- Headers of deleteUserAvatar method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down
27 changes: 15 additions & 12 deletions docs/chunkedUploads.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ await this.createFileUploadSession(
fileSize: fileSize,
folderId: parentFolderId,
} satisfies CreateFileUploadSessionRequestBody,
new CreateFileUploadSessionHeaders({}),
{} satisfies CreateFileUploadSessionHeadersInput,
cancellationToken
);
```
Expand All @@ -38,7 +38,7 @@ await this.createFileUploadSession(

- requestBody `CreateFileUploadSessionRequestBody`
- Request body of createFileUploadSession method
- headers `CreateFileUploadSessionHeaders`
- headersInput `CreateFileUploadSessionHeadersInput`
- Headers of createFileUploadSession method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -66,7 +66,7 @@ _Currently we don't have an example for calling `createFileUploadSessionForExist
- The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
- requestBody `CreateFileUploadSessionForExistingFileRequestBody`
- Request body of createFileUploadSessionForExistingFile method
- headers `CreateFileUploadSessionForExistingFileHeaders`
- headersInput `CreateFileUploadSessionForExistingFileHeadersInput`
- Headers of createFileUploadSessionForExistingFile method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand All @@ -91,7 +91,7 @@ See the endpoint docs at
```ts
await this.getFileUploadSessionById(
uploadSessionId,
new GetFileUploadSessionByIdHeaders({}),
{} satisfies GetFileUploadSessionByIdHeadersInput,
cancellationToken
);
```
Expand All @@ -100,7 +100,7 @@ await this.getFileUploadSessionById(

- uploadSessionId `string`
- The ID of the upload session. Example: "D5E3F7A"
- headers `GetFileUploadSessionByIdHeaders`
- headersInput `GetFileUploadSessionByIdHeadersInput`
- Headers of getFileUploadSessionById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand All @@ -126,7 +126,10 @@ See the endpoint docs at
await this.uploadFilePart(
acc.uploadSessionId,
generateByteStreamFromBuffer(chunkBuffer),
new UploadFilePartHeaders({ digest: digest, contentRange: contentRange })
{
digest: digest,
contentRange: contentRange,
} satisfies UploadFilePartHeadersInput
);
```

Expand All @@ -136,7 +139,7 @@ await this.uploadFilePart(
- The ID of the upload session. Example: "D5E3F7A"
- requestBody `ByteStream`
- Request body of uploadFilePart method
- headers `UploadFilePartHeaders`
- headersInput `UploadFilePartHeadersInput`
- Headers of uploadFilePart method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -164,7 +167,7 @@ _Currently we don't have an example for calling `deleteFileUploadSessionById` in

- uploadSessionId `string`
- The ID of the upload session. Example: "D5E3F7A"
- headers `DeleteFileUploadSessionByIdHeaders`
- headersInput `DeleteFileUploadSessionByIdHeadersInput`
- Headers of deleteFileUploadSessionById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -192,7 +195,7 @@ See the endpoint docs at
await this.getFileUploadSessionParts(
uploadSessionId,
{} satisfies GetFileUploadSessionPartsQueryParams,
new GetFileUploadSessionPartsHeaders({}),
{} satisfies GetFileUploadSessionPartsHeadersInput,
cancellationToken
);
```
Expand All @@ -203,7 +206,7 @@ await this.getFileUploadSessionParts(
- The ID of the upload session. Example: "D5E3F7A"
- queryParams `GetFileUploadSessionPartsQueryParams`
- Query parameters of getFileUploadSessionParts method
- headers `GetFileUploadSessionPartsHeaders`
- headersInput `GetFileUploadSessionPartsHeadersInput`
- Headers of getFileUploadSessionParts method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand All @@ -230,7 +233,7 @@ See the endpoint docs at
await this.createFileUploadSessionCommit(
uploadSessionId,
{ parts: parts } satisfies CreateFileUploadSessionCommitRequestBody,
new CreateFileUploadSessionCommitHeaders({ digest: digest }),
{ digest: digest } satisfies CreateFileUploadSessionCommitHeadersInput,
cancellationToken
);
```
Expand All @@ -241,7 +244,7 @@ await this.createFileUploadSessionCommit(
- The ID of the upload session. Example: "D5E3F7A"
- requestBody `CreateFileUploadSessionCommitRequestBody`
- Request body of createFileUploadSessionCommit method
- headers `CreateFileUploadSessionCommitHeaders`
- headersInput `CreateFileUploadSessionCommitHeadersInput`
- Headers of createFileUploadSessionCommit method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down
10 changes: 5 additions & 5 deletions docs/classifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ await client.classifications.getClassificationTemplate();

### Arguments

- headers `GetClassificationTemplateHeaders`
- headersInput `GetClassificationTemplateHeadersInput`
- Headers of getClassificationTemplate method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -76,7 +76,7 @@ await client.classifications.addClassification([

- requestBody `readonly AddClassificationRequestBody[]`
- Request body of addClassification method
- headers `AddClassificationHeaders`
- headersInput `AddClassificationHeadersInput`
- Headers of addClassification method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -126,7 +126,7 @@ await client.classifications.updateClassification([

- requestBody `readonly UpdateClassificationRequestBody[]`
- Request body of updateClassification method
- headers `UpdateClassificationHeaders`
- headersInput `UpdateClassificationHeadersInput`
- Headers of updateClassification method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -158,9 +158,9 @@ _Currently we don't have an example for calling `createClassificationTemplate` i

### Arguments

- requestBody `CreateClassificationTemplateRequestBody`
- requestBodyInput `CreateClassificationTemplateRequestBodyInput`
- Request body of createClassificationTemplate method
- headers `CreateClassificationTemplateHeaders`
- headersInput `CreateClassificationTemplateHeadersInput`
- Headers of createClassificationTemplate method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down
8 changes: 4 additions & 4 deletions docs/collaborationAllowlistEntries.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ await client.collaborationAllowlistEntries.getCollaborationWhitelistEntries();

- queryParams `GetCollaborationWhitelistEntriesQueryParams`
- Query parameters of getCollaborationWhitelistEntries method
- headers `GetCollaborationWhitelistEntriesHeaders`
- headersInput `GetCollaborationWhitelistEntriesHeadersInput`
- Headers of getCollaborationWhitelistEntries method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -59,7 +59,7 @@ await client.collaborationAllowlistEntries.createCollaborationWhitelistEntry({

- requestBody `CreateCollaborationWhitelistEntryRequestBody`
- Request body of createCollaborationWhitelistEntry method
- headers `CreateCollaborationWhitelistEntryHeaders`
- headersInput `CreateCollaborationWhitelistEntryHeadersInput`
- Headers of createCollaborationWhitelistEntry method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -92,7 +92,7 @@ await client.collaborationAllowlistEntries.getCollaborationWhitelistEntryById(

- collaborationWhitelistEntryId `string`
- The ID of the entry in the list. Example: "213123"
- headers `GetCollaborationWhitelistEntryByIdHeaders`
- headersInput `GetCollaborationWhitelistEntryByIdHeadersInput`
- Headers of getCollaborationWhitelistEntryById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -125,7 +125,7 @@ await client.collaborationAllowlistEntries.deleteCollaborationWhitelistEntryById

- collaborationWhitelistEntryId `string`
- The ID of the entry in the list. Example: "213123"
- headers `DeleteCollaborationWhitelistEntryByIdHeaders`
- headersInput `DeleteCollaborationWhitelistEntryByIdHeadersInput`
- Headers of deleteCollaborationWhitelistEntryById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down
8 changes: 4 additions & 4 deletions docs/collaborationAllowlistExemptTargets.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExempt

- queryParams `GetCollaborationWhitelistExemptTargetsQueryParams`
- Query parameters of getCollaborationWhitelistExemptTargets method
- headers `GetCollaborationWhitelistExemptTargetsHeaders`
- headersInput `GetCollaborationWhitelistExemptTargetsHeadersInput`
- Headers of getCollaborationWhitelistExemptTargets method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -62,7 +62,7 @@ await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExe

- requestBody `CreateCollaborationWhitelistExemptTargetRequestBody`
- Request body of createCollaborationWhitelistExemptTarget method
- headers `CreateCollaborationWhitelistExemptTargetHeaders`
- headersInput `CreateCollaborationWhitelistExemptTargetHeadersInput`
- Headers of createCollaborationWhitelistExemptTarget method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -95,7 +95,7 @@ await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExempt

- collaborationWhitelistExemptTargetId `string`
- The ID of the exemption to the list. Example: "984923"
- headers `GetCollaborationWhitelistExemptTargetByIdHeaders`
- headersInput `GetCollaborationWhitelistExemptTargetByIdHeadersInput`
- Headers of getCollaborationWhitelistExemptTargetById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -128,7 +128,7 @@ await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExe

- collaborationWhitelistExemptTargetId `string`
- The ID of the exemption to the list. Example: "984923"
- headers `DeleteCollaborationWhitelistExemptTargetByIdHeaders`
- headersInput `DeleteCollaborationWhitelistExemptTargetByIdHeadersInput`
- Headers of deleteCollaborationWhitelistExemptTargetById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down
4 changes: 2 additions & 2 deletions docs/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ await client.collections.getCollections();

- queryParams `GetCollectionsQueryParams`
- Query parameters of getCollections method
- headers `GetCollectionsHeaders`
- headersInput `GetCollectionsHeadersInput`
- Headers of getCollections method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -58,7 +58,7 @@ await client.collections.getCollectionItems(favouriteCollection.id!);
- The ID of the collection. Example: "926489"
- queryParams `GetCollectionItemsQueryParams`
- Query parameters of getCollectionItems method
- headers `GetCollectionItemsHeaders`
- headersInput `GetCollectionItemsHeadersInput`
- Headers of getCollectionItems method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down
10 changes: 5 additions & 5 deletions docs/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ await client.comments.getFileComments(fileId);
- The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
- queryParams `GetFileCommentsQueryParams`
- Query parameters of getFileComments method
- headers `GetFileCommentsHeaders`
- headersInput `GetFileCommentsHeadersInput`
- Headers of getFileComments method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -61,7 +61,7 @@ await client.comments.getCommentById(newComment.id!);
- The ID of the comment. Example: "12345"
- queryParams `GetCommentByIdQueryParams`
- Query parameters of getCommentById method
- headers `GetCommentByIdHeaders`
- headersInput `GetCommentByIdHeadersInput`
- Headers of getCommentById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -97,7 +97,7 @@ await client.comments.updateCommentById(newReplyComment.id!, {
- Request body of updateCommentById method
- queryParams `UpdateCommentByIdQueryParams`
- Query parameters of updateCommentById method
- headers `UpdateCommentByIdHeaders`
- headersInput `UpdateCommentByIdHeadersInput`
- Headers of updateCommentById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -127,7 +127,7 @@ await client.comments.deleteCommentById(newComment.id!);

- commentId `string`
- The ID of the comment. Example: "12345"
- headers `DeleteCommentByIdHeaders`
- headersInput `DeleteCommentByIdHeadersInput`
- Headers of deleteCommentById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -166,7 +166,7 @@ await client.comments.createComment({
- Request body of createComment method
- queryParams `CreateCommentQueryParams`
- Query parameters of createComment method
- headers `CreateCommentHeaders`
- headersInput `CreateCommentHeadersInput`
- Headers of createComment method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down
6 changes: 3 additions & 3 deletions docs/devicePinners.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ _Currently we don't have an example for calling `getDevicePinnerById` in integra

- devicePinnerId `string`
- The ID of the device pin Example: "2324234"
- headers `GetDevicePinnerByIdHeaders`
- headersInput `GetDevicePinnerByIdHeadersInput`
- Headers of getDevicePinnerById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand All @@ -45,7 +45,7 @@ _Currently we don't have an example for calling `deleteDevicePinnerById` in inte

- devicePinnerId `string`
- The ID of the device pin Example: "2324234"
- headers `DeleteDevicePinnerByIdHeaders`
- headersInput `DeleteDevicePinnerByIdHeadersInput`
- Headers of deleteDevicePinnerById method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down Expand Up @@ -76,7 +76,7 @@ _Currently we don't have an example for calling `getEnterpriseDevicePinners` in
- The ID of the enterprise Example: "3442311"
- queryParams `GetEnterpriseDevicePinnersQueryParams`
- Query parameters of getEnterpriseDevicePinners method
- headers `GetEnterpriseDevicePinnersHeaders`
- headersInput `GetEnterpriseDevicePinnersHeadersInput`
- Headers of getEnterpriseDevicePinners method
- cancellationToken `undefined | CancellationToken`
- Token used for request cancellation.
Expand Down
Loading