Skip to content
Closed
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
The table of contents is too big for display.
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": "108d2d7", "specHash": "c2c76f3", "version": "1.7.0" }
{ "engineHash": "4a6ba02", "specHash": "9d452cf", "version": "1.7.0" }
2 changes: 1 addition & 1 deletion docs/avatars.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ See the endpoint docs at
```ts
await client.avatars.createUserAvatar(user.id, {
pic: decodeBase64ByteStream(
'iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAAA1BMVEW10NBjBBbqAAAAH0lEQVRoge3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAvg0hAAABmmDh1QAAAABJRU5ErkJggg=='
'iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAAA1BMVEW10NBjBBbqAAAAH0lEQVRoge3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAvg0hAAABmmDh1QAAAABJRU5ErkJggg==',
),
picContentType: 'image/png',
picFileName: 'avatar.png',
Expand Down
10 changes: 5 additions & 5 deletions docs/chunkedUploads.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ await client.chunkedUploads.uploadFilePartByUrl(
{
digest: digest,
contentRange: contentRange,
} satisfies UploadFilePartByUrlHeadersInput
} satisfies UploadFilePartByUrlHeadersInput,
);
```

Expand Down Expand Up @@ -197,7 +197,7 @@ await client.chunkedUploads.uploadFilePart(
{
digest: digest,
contentRange: contentRange,
} satisfies UploadFilePartHeadersInput
} satisfies UploadFilePartHeadersInput,
);
```

Expand Down Expand Up @@ -366,7 +366,7 @@ See the endpoint docs at
await client.chunkedUploads.createFileUploadSessionCommitByUrl(
commitUrl,
{ parts: parts } satisfies CreateFileUploadSessionCommitByUrlRequestBody,
{ digest: digest } satisfies CreateFileUploadSessionCommitByUrlHeadersInput
{ digest: digest } satisfies CreateFileUploadSessionCommitByUrlHeadersInput,
);
```

Expand Down Expand Up @@ -409,7 +409,7 @@ See the endpoint docs at
await client.chunkedUploads.createFileUploadSessionCommit(
uploadSessionId,
{ parts: parts } satisfies CreateFileUploadSessionCommitRequestBody,
{ digest: digest } satisfies CreateFileUploadSessionCommitHeadersInput
{ digest: digest } satisfies CreateFileUploadSessionCommitHeadersInput,
);
```

Expand Down Expand Up @@ -445,7 +445,7 @@ await client.chunkedUploads.uploadBigFile(
fileByteStream,
fileName,
fileSize,
parentFolderId
parentFolderId,
);
```

Expand Down
4 changes: 2 additions & 2 deletions docs/collaborationAllowlistEntries.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ See the endpoint docs at

```ts
await client.collaborationAllowlistEntries.getCollaborationWhitelistEntryById(
entry.id!
entry.id!,
);
```

Expand Down Expand Up @@ -114,7 +114,7 @@ See the endpoint docs at

```ts
await client.collaborationAllowlistEntries.deleteCollaborationWhitelistEntryById(
entry.id!
entry.id!,
);
```

Expand Down
6 changes: 3 additions & 3 deletions docs/collaborationAllowlistExemptTargets.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExe
user: {
id: user.id,
} satisfies CreateCollaborationWhitelistExemptTargetRequestBodyUserField,
} satisfies CreateCollaborationWhitelistExemptTargetRequestBody
} satisfies CreateCollaborationWhitelistExemptTargetRequestBody,
);
```

Expand Down Expand Up @@ -85,7 +85,7 @@ See the endpoint docs at

```ts
await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargetById(
exemptTarget.id!
exemptTarget.id!,
);
```

Expand Down Expand Up @@ -116,7 +116,7 @@ See the endpoint docs at

```ts
await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExemptTargetById(
exemptTarget.id!
exemptTarget.id!,
);
```

Expand Down
29 changes: 0 additions & 29 deletions docs/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

- [List all collections](#list-all-collections)
- [List collection items](#list-collection-items)
- [Get collection by ID](#get-collection-by-id)

## List all collections

Expand Down Expand Up @@ -65,31 +64,3 @@ await client.collections.getCollectionItems(favouriteCollection.id!);
This function returns a value of type `Items`.

Returns an array of items in the collection.

## Get collection by ID

Retrieves a collection by its ID.

This operation is performed by calling function `getCollectionById`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-collections-id/).

<!-- sample get_collections_id -->

```ts
await client.collections.getCollectionById(collections.entries![0].id!);
```

### Arguments

- collectionId `string`
- The ID of the collection. Example: "926489"
- optionalsInput `GetCollectionByIdOptionalsInput`
-

### Returns

This function returns a value of type `Collection`.

Returns an array of items in the collection.
8 changes: 4 additions & 4 deletions docs/fileMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ See the endpoint docs at
await client.fileMetadata.getFileMetadataById(
file.id,
'global' as GetFileMetadataByIdScope,
'properties'
'properties',
);
```

Expand Down Expand Up @@ -102,7 +102,7 @@ await client.fileMetadata.createFileMetadataById(
['birthDate']: '2001-01-03T02:20:50.520Z',
['countryCode']: 'US',
['sports']: ['basketball', 'tennis'],
}
},
);
```

Expand Down Expand Up @@ -155,7 +155,7 @@ await client.fileMetadata.updateFileMetadataById(
path: '/abc',
value: newValue,
} satisfies UpdateFileMetadataByIdRequestBody,
]
],
);
```

Expand Down Expand Up @@ -194,7 +194,7 @@ See the endpoint docs at
await client.fileMetadata.deleteFileMetadataById(
file.id,
'enterprise' as DeleteFileMetadataByIdScope,
templateKey
templateKey,
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/fileVersionLegalHolds.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ See the endpoint docs at

```ts
await client.fileVersionLegalHolds.getFileVersionLegalHoldById(
fileVersionLegalHoldId
fileVersionLegalHoldId,
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/fileVersionRetentions.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ See the endpoint docs at

```ts
await client.fileVersionRetentions.getFileVersionRetentionById(
fileVersionRetention.id!
fileVersionRetention.id!,
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/fileVersions.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ See the endpoint docs at
```ts
await client.fileVersions.getFileVersionById(
file.id,
fileVersions.entries![0].id
fileVersions.entries![0].id,
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ See the endpoint docs at
```ts
await client.files.getFileThumbnailById(
thumbnailFile.id,
'png' as GetFileThumbnailByIdExtension
'png' as GetFileThumbnailByIdExtension,
);
```

Expand Down
8 changes: 4 additions & 4 deletions docs/folderMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ See the endpoint docs at
await client.folderMetadata.getFolderMetadataById(
folder.id,
'global' as GetFolderMetadataByIdScope,
'properties'
'properties',
);
```

Expand Down Expand Up @@ -107,7 +107,7 @@ await client.folderMetadata.createFolderMetadataById(
['birthDate']: '2001-01-03T02:20:50.520Z',
['countryCode']: 'US',
['sports']: ['basketball', 'tennis'],
}
},
);
```

Expand Down Expand Up @@ -160,7 +160,7 @@ await client.folderMetadata.updateFolderMetadataById(
path: '/abc',
value: newValue,
} satisfies UpdateFolderMetadataByIdRequestBody,
]
],
);
```

Expand Down Expand Up @@ -199,7 +199,7 @@ See the endpoint docs at
await client.folderMetadata.deleteFolderMetadataById(
folder.id,
'enterprise' as DeleteFolderMetadataByIdScope,
templateKey
templateKey,
);
```

Expand Down
6 changes: 3 additions & 3 deletions docs/legalHoldPolicyAssignments.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ See the endpoint docs at

```ts
await client.legalHoldPolicyAssignments.getLegalHoldPolicyAssignmentById(
legalHoldPolicyAssignmentId
legalHoldPolicyAssignmentId,
);
```

Expand Down Expand Up @@ -116,7 +116,7 @@ See the endpoint docs at

```ts
await client.legalHoldPolicyAssignments.deleteLegalHoldPolicyAssignmentById(
legalHoldPolicyAssignmentId
legalHoldPolicyAssignmentId,
);
```

Expand Down Expand Up @@ -165,7 +165,7 @@ See the endpoint docs at

```ts
await client.legalHoldPolicyAssignments.getLegalHoldPolicyAssignmentFileOnHold(
legalHoldPolicyAssignmentId
legalHoldPolicyAssignmentId,
);
```

Expand Down
6 changes: 3 additions & 3 deletions docs/metadataCascadePolicies.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ See the endpoint docs at

```ts
await client.metadataCascadePolicies.getMetadataCascadePolicyById(
cascadePolicyId
cascadePolicyId,
);
```

Expand Down Expand Up @@ -118,7 +118,7 @@ See the endpoint docs at

```ts
await client.metadataCascadePolicies.deleteMetadataCascadePolicyById(
cascadePolicyId
cascadePolicyId,
);
```

Expand Down Expand Up @@ -156,7 +156,7 @@ await client.metadataCascadePolicies.applyMetadataCascadePolicy(
{
conflictResolution:
'overwrite' as ApplyMetadataCascadePolicyRequestBodyConflictResolutionField,
} satisfies ApplyMetadataCascadePolicyRequestBody
} satisfies ApplyMetadataCascadePolicyRequestBody,
);
```

Expand Down
6 changes: 3 additions & 3 deletions docs/metadataTemplates.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ See the endpoint docs at
```ts
await client.metadataTemplates.getMetadataTemplate(
'enterprise' as GetMetadataTemplateScope,
template.templateKey!
template.templateKey!,
);
```

Expand Down Expand Up @@ -105,7 +105,7 @@ await client.metadataTemplates.updateMetadataTemplate(
fieldKey: 'newfieldname',
data: { ['type']: 'string', ['displayName']: 'newFieldName' },
} satisfies UpdateMetadataTemplateRequestBody,
]
],
);
```

Expand Down Expand Up @@ -142,7 +142,7 @@ See the endpoint docs at
```ts
await client.metadataTemplates.deleteMetadataTemplate(
'enterprise' as DeleteMetadataTemplateScope,
template.templateKey!
template.templateKey!,
);
```

Expand Down
8 changes: 4 additions & 4 deletions docs/retentionPolicyAssignments.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ See the endpoint docs at

```ts
await client.retentionPolicyAssignments.getRetentionPolicyAssignments(
retentionPolicy.id
retentionPolicy.id,
);
```

Expand Down Expand Up @@ -85,7 +85,7 @@ See the endpoint docs at

```ts
await client.retentionPolicyAssignments.getRetentionPolicyAssignmentById(
retentionPolicyAssignment.id
retentionPolicyAssignment.id,
);
```

Expand Down Expand Up @@ -116,7 +116,7 @@ See the endpoint docs at

```ts
await client.retentionPolicyAssignments.deleteRetentionPolicyAssignmentById(
retentionPolicyAssignment.id
retentionPolicyAssignment.id,
);
```

Expand Down Expand Up @@ -147,7 +147,7 @@ See the endpoint docs at

```ts
await client.retentionPolicyAssignments.getFilesUnderRetentionPolicyAssignment(
retentionPolicyAssignment.id
retentionPolicyAssignment.id,
);
```

Expand Down
8 changes: 4 additions & 4 deletions docs/sharedLinksFiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ await userClient.sharedLinksFiles.findFileForSharedLink(
boxapi: ''.concat(
'shared_link=',
fileFromApi.sharedLink!.url,
'&shared_link_password=incorrectPassword'
'&shared_link_password=incorrectPassword',
) as string,
} satisfies FindFileForSharedLinkHeadersInput
} satisfies FindFileForSharedLinkHeadersInput,
);
```

Expand Down Expand Up @@ -108,7 +108,7 @@ await client.sharedLinksFiles.addShareLinkToFile(
password: 'Secret123@',
} satisfies AddShareLinkToFileRequestBodySharedLinkField,
} satisfies AddShareLinkToFileRequestBody,
{ fields: 'shared_link' } satisfies AddShareLinkToFileQueryParams
{ fields: 'shared_link' } satisfies AddShareLinkToFileQueryParams,
);
```

Expand Down Expand Up @@ -150,7 +150,7 @@ await client.sharedLinksFiles.updateSharedLinkOnFile(
'collaborators' as UpdateSharedLinkOnFileRequestBodySharedLinkAccessField,
} satisfies UpdateSharedLinkOnFileRequestBodySharedLinkField,
} satisfies UpdateSharedLinkOnFileRequestBody,
{ fields: 'shared_link' } satisfies UpdateSharedLinkOnFileQueryParams
{ fields: 'shared_link' } satisfies UpdateSharedLinkOnFileQueryParams,
);
```

Expand Down
Loading
Loading