Skip to content

Commit cf55214

Browse files
box-sdk-buildbox-sdk-build
authored
feat: Move schemas to separate modules (box/box-codegen#483) (#182)
1 parent d4142ec commit cf55214

File tree

374 files changed

+30001
-27186
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

374 files changed

+30001
-27186
lines changed

‎.codegen.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "c2589f6", "specHash": "f7e92ba", "version": "0.5.4" }
1+
{ "engineHash": "2fccaa2", "specHash": "d5769a1", "version": "0.5.4" }

‎docs/fileMetadata.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,11 @@ await client.fileMetadata.createFileMetadataById(
9797
'enterprise' as CreateFileMetadataByIdScope,
9898
templateKey,
9999
{
100-
['floatField']: 10,
101-
['stringField']: 'stringValue',
102-
['dateField']: '2035-01-02T00:00:00Z',
103-
['enumField']: 'enumValue2',
104-
['multiSelectField']: ['multiSelectValue1', 'multiSelectValue2'],
100+
['name']: 'John',
101+
['age']: 23,
102+
['birthDate']: '2001-01-03T02:20:50.520Z',
103+
['countryCode']: 'US',
104+
['sports']: ['basketball', 'tennis'],
105105
}
106106
);
107107
```

‎docs/files.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,8 @@ See the endpoint docs at
5151
<!-- sample put_files_id -->
5252

5353
```ts
54-
await client.files.updateFileById(fileToUpdate.id, {
55-
requestBody: {
56-
name: updatedName,
57-
description: 'Updated description',
58-
} satisfies UpdateFileByIdRequestBody,
54+
await downscopedClient.files.updateFileById(file.id, {
55+
requestBody: { name: getUuid() } satisfies UpdateFileByIdRequestBody,
5956
} satisfies UpdateFileByIdOptionalsInput);
6057
```
6158

@@ -92,7 +89,7 @@ See the endpoint docs at
9289
<!-- sample delete_files_id -->
9390

9491
```ts
95-
await client.files.deleteFileById(file2.id);
92+
await parentClient.files.deleteFileById(file.id);
9693
```
9794

9895
### Arguments

‎docs/folderMetadata.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,13 @@ await client.folderMetadata.createFolderMetadataById(
101101
folder.id,
102102
'enterprise' as CreateFolderMetadataByIdScope,
103103
templateKey,
104-
data
104+
{
105+
['name']: 'John',
106+
['age']: 23,
107+
['birthDate']: '2001-01-03T02:20:50.520Z',
108+
['countryCode']: 'US',
109+
['sports']: ['basketball', 'tennis'],
110+
}
105111
);
106112
```
107113

‎docs/folders.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ See the endpoint docs at
2828
<!-- sample get_folders_id -->
2929

3030
```ts
31-
await client.folders.getFolderById('0');
31+
await client.folders.getFolderById(newFolder.id);
3232
```
3333

3434
### Arguments
@@ -67,13 +67,8 @@ See the endpoint docs at
6767
<!-- sample put_folders_id -->
6868

6969
```ts
70-
await client.folders.updateFolderById(copiedFolder.id, {
71-
requestBody: {
72-
parent: {
73-
id: folderOrigin.id,
74-
} satisfies UpdateFolderByIdRequestBodyParentField,
75-
name: movedFolderName,
76-
} satisfies UpdateFolderByIdRequestBody,
70+
await downscopedClient.folders.updateFolderById(folder.id, {
71+
requestBody: { name: getUuid() } satisfies UpdateFolderByIdRequestBody,
7772
} satisfies UpdateFolderByIdOptionalsInput);
7873
```
7974

@@ -112,7 +107,7 @@ See the endpoint docs at
112107
<!-- sample delete_folders_id -->
113108

114109
```ts
115-
await client.folders.deleteFolderById(folder1.id);
110+
await parentClient.folders.deleteFolderById(folder.id);
116111
```
117112

118113
### Arguments
@@ -173,7 +168,7 @@ See the endpoint docs at
173168
<!-- sample post_folders -->
174169

175170
```ts
176-
await client.folders.createFolder({
171+
await parentClient.folders.createFolder({
177172
name: getUuid(),
178173
parent: { id: '0' } satisfies CreateFolderRequestBodyParentField,
179174
} satisfies CreateFolderRequestBody);

‎docs/groups.md

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ See the endpoint docs at
5353
```ts
5454
await client.groups.createGroup({
5555
name: groupName,
56+
description: groupDescription,
5657
} satisfies CreateGroupRequestBody);
5758
```
5859

‎docs/legalHoldPolicies.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,9 @@ See the endpoint docs at
5252
await client.legalHoldPolicies.createLegalHoldPolicy({
5353
policyName: legalHoldPolicyName,
5454
description: legalHoldDescription,
55-
isOngoing: true,
55+
isOngoing: false,
56+
filterStartedAt: filterStartedAt,
57+
filterEndedAt: filterEndedAt,
5658
} satisfies CreateLegalHoldPolicyRequestBody);
5759
```
5860

@@ -144,7 +146,7 @@ See the endpoint docs at
144146
<!-- sample delete_legal_hold_policies_id -->
145147

146148
```ts
147-
await client.legalHoldPolicies.deleteLegalHoldPolicyById(legalHoldPolicyId);
149+
await client.legalHoldPolicies.deleteLegalHoldPolicyById(legalHoldPolicy.id);
148150
```
149151

150152
### Arguments

‎docs/metadataTemplates.md

+20-17
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ See the endpoint docs at
142142
```ts
143143
await client.metadataTemplates.deleteMetadataTemplate(
144144
'enterprise' as DeleteMetadataTemplateScope,
145-
template.templateKey!
145+
templateKey
146146
);
147147
```
148148

@@ -273,43 +273,46 @@ await client.metadataTemplates.createMetadataTemplate({
273273
templateKey: templateKey,
274274
fields: [
275275
{
276-
type: 'float' as CreateMetadataTemplateRequestBodyFieldsTypeField,
277-
key: 'floatField',
278-
displayName: 'floatField',
276+
type: 'string' as CreateMetadataTemplateRequestBodyFieldsTypeField,
277+
key: 'name',
278+
displayName: 'name',
279279
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
280280
{
281-
type: 'string' as CreateMetadataTemplateRequestBodyFieldsTypeField,
282-
key: 'stringField',
283-
displayName: 'stringField',
281+
type: 'float' as CreateMetadataTemplateRequestBodyFieldsTypeField,
282+
key: 'age',
283+
displayName: 'age',
284284
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
285285
{
286286
type: 'date' as CreateMetadataTemplateRequestBodyFieldsTypeField,
287-
key: 'dateField',
288-
displayName: 'dateField',
287+
key: 'birthDate',
288+
displayName: 'birthDate',
289289
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
290290
{
291291
type: 'enum' as CreateMetadataTemplateRequestBodyFieldsTypeField,
292-
key: 'enumField',
293-
displayName: 'enumField',
292+
key: 'countryCode',
293+
displayName: 'countryCode',
294294
options: [
295295
{
296-
key: 'enumValue1',
296+
key: 'US',
297297
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
298298
{
299-
key: 'enumValue2',
299+
key: 'CA',
300300
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
301301
],
302302
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
303303
{
304304
type: 'multiSelect' as CreateMetadataTemplateRequestBodyFieldsTypeField,
305-
key: 'multiSelectField',
306-
displayName: 'multiSelectField',
305+
key: 'sports',
306+
displayName: 'sports',
307307
options: [
308308
{
309-
key: 'multiSelectValue1',
309+
key: 'basketball',
310+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
311+
{
312+
key: 'football',
310313
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
311314
{
312-
key: 'multiSelectValue2',
315+
key: 'tennis',
313316
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
314317
],
315318
} satisfies CreateMetadataTemplateRequestBodyFieldsField,

‎docs/retentionPolicies.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,13 @@ See the endpoint docs at
4949

5050
```ts
5151
await client.retentionPolicies.createRetentionPolicy({
52-
policyName: retentionPolicyName,
52+
policyName: getUuid(),
5353
policyType: 'finite' as CreateRetentionPolicyRequestBodyPolicyTypeField,
54-
areOwnersNotified: true,
55-
canOwnerExtendRetention: true,
56-
description: retentionDescription,
5754
dispositionAction:
5855
'remove_retention' as CreateRetentionPolicyRequestBodyDispositionActionField,
5956
retentionLength: '1',
57+
description: description,
58+
canOwnerExtendRetention: false,
6059
retentionType:
6160
'modifiable' as CreateRetentionPolicyRequestBodyRetentionTypeField,
6261
} satisfies CreateRetentionPolicyRequestBody);

‎docs/retentionPolicyAssignments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ See the endpoint docs at
5454
await client.retentionPolicyAssignments.createRetentionPolicyAssignment({
5555
policyId: retentionPolicy.id,
5656
assignTo: {
57-
type: 'folder' as CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField,
5857
id: folder.id,
58+
type: 'folder' as CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField,
5959
} satisfies CreateRetentionPolicyAssignmentRequestBodyAssignToField,
6060
} satisfies CreateRetentionPolicyAssignmentRequestBody);
6161
```

‎docs/shieldInformationBarrierSegments.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ See the endpoint docs at
8585

8686
```ts
8787
await client.shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentById(
88-
segmentId
88+
segment.id!
8989
);
9090
```
9191

@@ -154,7 +154,6 @@ await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegm
154154
type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField,
155155
} satisfies ShieldInformationBarrierBase,
156156
name: segmentName,
157-
description: segmentDescription,
158157
} satisfies CreateShieldInformationBarrierSegmentRequestBody
159158
);
160159
```

‎docs/tasks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ await client.tasks.createTask({
5757
id: file.id,
5858
} satisfies CreateTaskRequestBodyItemField,
5959
message: 'test message',
60-
dueAt: dateTime,
60+
dueAt: date,
6161
action: 'review' as CreateTaskRequestBodyActionField,
6262
completionRule: 'all_assignees' as CreateTaskRequestBodyCompletionRuleField,
6363
} satisfies CreateTaskRequestBody);

‎docs/trashedFiles.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ See the endpoint docs at
5757
<!-- sample get_files_id_trash -->
5858

5959
```ts
60-
await client.trashedFiles.getTrashedFileById(file.id);
60+
await client.trashedFiles.getTrashedFileById(uploadedFile.id);
6161
```
6262

6363
### Arguments

‎docs/userCollaborations.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ See the endpoint docs at
8181
<!-- sample delete_collaborations_id -->
8282

8383
```ts
84-
await client.userCollaborations.deleteCollaborationById(collaborationId);
84+
await client.userCollaborations.deleteCollaborationById(groupCollaboration.id);
8585
```
8686

8787
### Arguments
@@ -126,12 +126,12 @@ See the endpoint docs at
126126
```ts
127127
await client.userCollaborations.createCollaboration({
128128
item: {
129-
type: 'folder' as CreateCollaborationRequestBodyItemTypeField,
130-
id: folder.id,
129+
type: 'file' as CreateCollaborationRequestBodyItemTypeField,
130+
id: file.id,
131131
} satisfies CreateCollaborationRequestBodyItemField,
132132
accessibleBy: {
133133
type: 'user' as CreateCollaborationRequestBodyAccessibleByTypeField,
134-
login: userLogin,
134+
id: getEnvVar('USER_ID'),
135135
} satisfies CreateCollaborationRequestBodyAccessibleByField,
136136
role: 'editor' as CreateCollaborationRequestBodyRoleField,
137137
} satisfies CreateCollaborationRequestBody);

‎docs/users.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ See the endpoint docs at
5858
```ts
5959
await client.users.createUser({
6060
name: userName,
61-
login: userLogin,
6261
isPlatformAccessOnly: true,
6362
} satisfies CreateUserRequestBody);
6463
```
@@ -205,7 +204,7 @@ See the endpoint docs at
205204
<!-- sample delete_users_id -->
206205

207206
```ts
208-
await client.users.deleteUserById(user.id);
207+
await client.users.deleteUserById(createdUser.id);
209208
```
210209

211210
### Arguments

‎docs/webLinks.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ See the endpoint docs at
1818

1919
```ts
2020
await client.webLinks.createWebLink({
21-
url: url,
21+
url: 'https://www.box.com',
2222
parent: { id: parent.id } satisfies CreateWebLinkRequestBodyParentField,
23-
name: name,
24-
description: description,
23+
name: getUuid(),
24+
description: 'Weblink description',
2525
} satisfies CreateWebLinkRequestBody);
2626
```
2727

@@ -114,7 +114,7 @@ See the endpoint docs at
114114
<!-- sample delete_web_links_id -->
115115

116116
```ts
117-
await client.webLinks.deleteWebLinkById(weblink.id);
117+
await client.webLinks.deleteWebLinkById(webLinkId);
118118
```
119119

120120
### Arguments

0 commit comments

Comments
 (0)