Skip to content

Commit 05e804b

Browse files
test: reorder function calls to fix test samples (box/box-codegen#666) (#533)
1 parent 3a85453 commit 05e804b

File tree

7 files changed

+232
-92
lines changed

7 files changed

+232
-92
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "89ce9ce", "specHash": "06fc5f7", "version": "1.13.0" }
1+
{ "engineHash": "ef00939", "specHash": "06fc5f7", "version": "1.13.0" }

docs/legalHoldPolicies.md

Lines changed: 4 additions & 2 deletions
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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,45 @@ await client.metadataTemplates.createMetadataTemplate({
277277
key: 'testName',
278278
displayName: 'testName',
279279
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
280+
{
281+
type: 'float' as CreateMetadataTemplateRequestBodyFieldsTypeField,
282+
key: 'age',
283+
displayName: 'age',
284+
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
285+
{
286+
type: 'date' as CreateMetadataTemplateRequestBodyFieldsTypeField,
287+
key: 'birthDate',
288+
displayName: 'birthDate',
289+
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
290+
{
291+
type: 'enum' as CreateMetadataTemplateRequestBodyFieldsTypeField,
292+
key: 'countryCode',
293+
displayName: 'countryCode',
294+
options: [
295+
{
296+
key: 'US',
297+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
298+
{
299+
key: 'CA',
300+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
301+
],
302+
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
303+
{
304+
type: 'multiSelect' as CreateMetadataTemplateRequestBodyFieldsTypeField,
305+
key: 'sports',
306+
displayName: 'sports',
307+
options: [
308+
{
309+
key: 'basketball',
310+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
311+
{
312+
key: 'football',
313+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
314+
{
315+
key: 'tennis',
316+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
317+
],
318+
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
280319
],
281320
} satisfies CreateMetadataTemplateRequestBody);
282321
```

docs/search.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,25 @@ See the endpoint docs at
6363
```ts
6464
await client.search.searchForContent({
6565
ancestorFolderIds: ['0' as string],
66-
query: keyword,
67-
trashContent:
68-
'non_trashed_only' as SearchForContentQueryParamsTrashContentField,
66+
mdfilters: [
67+
{
68+
filters: {
69+
['stringField']: 'stringValue',
70+
['dateField']: {
71+
lt: dateTimeFromString('2035-01-01T00:00:00Z'),
72+
gt: dateTimeFromString('2035-01-03T00:00:00Z'),
73+
} satisfies MetadataFieldFilterDateRange,
74+
['floatField']: {
75+
lt: 9.5,
76+
gt: 10.5,
77+
} satisfies MetadataFieldFilterFloatRange,
78+
['enumField']: 'enumValue2',
79+
['multiSelectField']: ['multiSelectValue1', 'multiSelectValue2'],
80+
},
81+
scope: 'enterprise' as MetadataFilterScopeField,
82+
templateKey: templateKey,
83+
} satisfies MetadataFilter,
84+
],
6985
} satisfies SearchForContentQueryParams);
7086
```
7187

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { serializeDateTime } from '../internal/utils.js';
2+
import { deserializeDateTime } from '../internal/utils.js';
13
import { serializeLegalHoldPolicy } from '../schemas/legalHoldPolicy.generated.js';
24
import { deserializeLegalHoldPolicy } from '../schemas/legalHoldPolicy.generated.js';
35
import { serializeCreateLegalHoldPolicyRequestBody } from '../managers/legalHoldPolicies.generated.js';
@@ -6,15 +8,13 @@ import { serializeLegalHoldPolicies } from '../schemas/legalHoldPolicies.generat
68
import { deserializeLegalHoldPolicies } from '../schemas/legalHoldPolicies.generated.js';
79
import { serializeUpdateLegalHoldPolicyByIdRequestBody } from '../managers/legalHoldPolicies.generated.js';
810
import { deserializeUpdateLegalHoldPolicyByIdRequestBody } from '../managers/legalHoldPolicies.generated.js';
9-
import { serializeDateTime } from '../internal/utils.js';
10-
import { deserializeDateTime } from '../internal/utils.js';
1111
import { UpdateLegalHoldPolicyByIdOptionalsInput } from '../managers/legalHoldPolicies.generated.js';
1212
import { UpdateLegalHoldPolicyByIdOptionals } from '../managers/legalHoldPolicies.generated.js';
13+
import { DateTime } from '../internal/utils.js';
1314
import { LegalHoldPolicy } from '../schemas/legalHoldPolicy.generated.js';
1415
import { CreateLegalHoldPolicyRequestBody } from '../managers/legalHoldPolicies.generated.js';
1516
import { LegalHoldPolicies } from '../schemas/legalHoldPolicies.generated.js';
1617
import { UpdateLegalHoldPolicyByIdRequestBody } from '../managers/legalHoldPolicies.generated.js';
17-
import { DateTime } from '../internal/utils.js';
1818
import { getUuid } from '../internal/utils.js';
1919
import { dateTimeFromString } from '../internal/utils.js';
2020
import { dateTimeToString } from '../internal/utils.js';
@@ -28,47 +28,6 @@ import { sdIsString } from '../serialization/json.js';
2828
import { sdIsList } from '../serialization/json.js';
2929
import { sdIsMap } from '../serialization/json.js';
3030
export const client: BoxClient = getDefaultClient();
31-
test('testCreateUpdateGetDeleteLegalHoldPolicy', async function testCreateUpdateGetDeleteLegalHoldPolicy(): Promise<any> {
32-
const legalHoldPolicyName: string = getUuid();
33-
const legalHoldDescription: string = 'test description';
34-
const legalHoldPolicy: LegalHoldPolicy =
35-
await client.legalHoldPolicies.createLegalHoldPolicy({
36-
policyName: legalHoldPolicyName,
37-
description: legalHoldDescription,
38-
isOngoing: true,
39-
} satisfies CreateLegalHoldPolicyRequestBody);
40-
if (!(legalHoldPolicy.policyName == legalHoldPolicyName)) {
41-
throw new Error('Assertion failed');
42-
}
43-
if (!(legalHoldPolicy.description == legalHoldDescription)) {
44-
throw new Error('Assertion failed');
45-
}
46-
const legalHoldPolicyId: string = legalHoldPolicy.id;
47-
const legalHoldPolicyById: LegalHoldPolicy =
48-
await client.legalHoldPolicies.getLegalHoldPolicyById(legalHoldPolicyId);
49-
if (!(legalHoldPolicyById.id == legalHoldPolicyId)) {
50-
throw new Error('Assertion failed');
51-
}
52-
const legalHoldPolicies: LegalHoldPolicies =
53-
await client.legalHoldPolicies.getLegalHoldPolicies();
54-
if (!(legalHoldPolicies.entries!.length > 0)) {
55-
throw new Error('Assertion failed');
56-
}
57-
const updatedLegalHoldPolicyName: string = getUuid();
58-
const updatedLegalHoldPolicy: LegalHoldPolicy =
59-
await client.legalHoldPolicies.updateLegalHoldPolicyById(
60-
legalHoldPolicyId,
61-
{
62-
requestBody: {
63-
policyName: updatedLegalHoldPolicyName,
64-
} satisfies UpdateLegalHoldPolicyByIdRequestBody,
65-
} satisfies UpdateLegalHoldPolicyByIdOptionalsInput,
66-
);
67-
if (!(updatedLegalHoldPolicy.policyName == updatedLegalHoldPolicyName)) {
68-
throw new Error('Assertion failed');
69-
}
70-
await client.legalHoldPolicies.deleteLegalHoldPolicyById(legalHoldPolicyId);
71-
});
7231
test('testCreateNotOngoingLegalHoldPolicy', async function testCreateNotOngoingLegalHoldPolicy(): Promise<any> {
7332
const legalHoldPolicyName: string = getUuid();
7433
const legalHoldDescription: string = 'test description';
@@ -110,4 +69,45 @@ test('testCreateNotOngoingLegalHoldPolicy', async function testCreateNotOngoingL
11069
}
11170
await client.legalHoldPolicies.deleteLegalHoldPolicyById(legalHoldPolicy.id);
11271
});
72+
test('testCreateUpdateGetDeleteLegalHoldPolicy', async function testCreateUpdateGetDeleteLegalHoldPolicy(): Promise<any> {
73+
const legalHoldPolicyName: string = getUuid();
74+
const legalHoldDescription: string = 'test description';
75+
const legalHoldPolicy: LegalHoldPolicy =
76+
await client.legalHoldPolicies.createLegalHoldPolicy({
77+
policyName: legalHoldPolicyName,
78+
description: legalHoldDescription,
79+
isOngoing: true,
80+
} satisfies CreateLegalHoldPolicyRequestBody);
81+
if (!(legalHoldPolicy.policyName == legalHoldPolicyName)) {
82+
throw new Error('Assertion failed');
83+
}
84+
if (!(legalHoldPolicy.description == legalHoldDescription)) {
85+
throw new Error('Assertion failed');
86+
}
87+
const legalHoldPolicyId: string = legalHoldPolicy.id;
88+
const legalHoldPolicyById: LegalHoldPolicy =
89+
await client.legalHoldPolicies.getLegalHoldPolicyById(legalHoldPolicyId);
90+
if (!(legalHoldPolicyById.id == legalHoldPolicyId)) {
91+
throw new Error('Assertion failed');
92+
}
93+
const legalHoldPolicies: LegalHoldPolicies =
94+
await client.legalHoldPolicies.getLegalHoldPolicies();
95+
if (!(legalHoldPolicies.entries!.length > 0)) {
96+
throw new Error('Assertion failed');
97+
}
98+
const updatedLegalHoldPolicyName: string = getUuid();
99+
const updatedLegalHoldPolicy: LegalHoldPolicy =
100+
await client.legalHoldPolicies.updateLegalHoldPolicyById(
101+
legalHoldPolicyId,
102+
{
103+
requestBody: {
104+
policyName: updatedLegalHoldPolicyName,
105+
} satisfies UpdateLegalHoldPolicyByIdRequestBody,
106+
} satisfies UpdateLegalHoldPolicyByIdOptionalsInput,
107+
);
108+
if (!(updatedLegalHoldPolicy.policyName == updatedLegalHoldPolicyName)) {
109+
throw new Error('Assertion failed');
110+
}
111+
await client.legalHoldPolicies.deleteLegalHoldPolicyById(legalHoldPolicyId);
112+
});
113113
export {};

src/test/metadataTemplates.generated.test.ts

Lines changed: 87 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import { serializeCreateMetadataTemplateRequestBodyFieldsField } from '../manage
66
import { deserializeCreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js';
77
import { serializeCreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js';
88
import { deserializeCreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js';
9+
import { serializeCreateMetadataTemplateRequestBodyFieldsOptionsField } from '../managers/metadataTemplates.generated.js';
10+
import { deserializeCreateMetadataTemplateRequestBodyFieldsOptionsField } from '../managers/metadataTemplates.generated.js';
911
import { serializeUpdateMetadataTemplateScope } from '../managers/metadataTemplates.generated.js';
1012
import { deserializeUpdateMetadataTemplateScope } from '../managers/metadataTemplates.generated.js';
1113
import { serializeUpdateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js';
@@ -31,6 +33,7 @@ import { MetadataTemplate } from '../schemas/metadataTemplate.generated.js';
3133
import { CreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js';
3234
import { CreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js';
3335
import { CreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js';
36+
import { CreateMetadataTemplateRequestBodyFieldsOptionsField } from '../managers/metadataTemplates.generated.js';
3437
import { UpdateMetadataTemplateScope } from '../managers/metadataTemplates.generated.js';
3538
import { UpdateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js';
3639
import { UpdateMetadataTemplateRequestBodyOpField } from '../managers/metadataTemplates.generated.js';
@@ -45,6 +48,8 @@ import { DeleteFileMetadataByIdScope } from '../managers/fileMetadata.generated.
4548
import { getUuid } from '../internal/utils.js';
4649
import { getDefaultClient } from './commons.generated.js';
4750
import { uploadNewFile } from './commons.generated.js';
51+
import { toString } from '../internal/utils.js';
52+
import { sdToJson } from '../serialization/json.js';
4853
import { SerializedData } from '../serialization/json.js';
4954
import { sdIsEmpty } from '../serialization/json.js';
5055
import { sdIsBoolean } from '../serialization/json.js';
@@ -66,6 +71,45 @@ test('testMetadataTemplates', async function testMetadataTemplates(): Promise<an
6671
key: 'testName',
6772
displayName: 'testName',
6873
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
74+
{
75+
type: 'float' as CreateMetadataTemplateRequestBodyFieldsTypeField,
76+
key: 'age',
77+
displayName: 'age',
78+
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
79+
{
80+
type: 'date' as CreateMetadataTemplateRequestBodyFieldsTypeField,
81+
key: 'birthDate',
82+
displayName: 'birthDate',
83+
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
84+
{
85+
type: 'enum' as CreateMetadataTemplateRequestBodyFieldsTypeField,
86+
key: 'countryCode',
87+
displayName: 'countryCode',
88+
options: [
89+
{
90+
key: 'US',
91+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
92+
{
93+
key: 'CA',
94+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
95+
],
96+
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
97+
{
98+
type: 'multiSelect' as CreateMetadataTemplateRequestBodyFieldsTypeField,
99+
key: 'sports',
100+
displayName: 'sports',
101+
options: [
102+
{
103+
key: 'basketball',
104+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
105+
{
106+
key: 'football',
107+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
108+
{
109+
key: 'tennis',
110+
} satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
111+
],
112+
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
69113
],
70114
} satisfies CreateMetadataTemplateRequestBody);
71115
if (!(template.templateKey == templateKey)) {
@@ -74,7 +118,7 @@ test('testMetadataTemplates', async function testMetadataTemplates(): Promise<an
74118
if (!(template.displayName == templateKey)) {
75119
throw new Error('Assertion failed');
76120
}
77-
if (!(template.fields!.length == 1)) {
121+
if (!(template.fields!.length == 5)) {
78122
throw new Error('Assertion failed');
79123
}
80124
if (!(template.fields![0].key == 'testName')) {
@@ -83,6 +127,45 @@ test('testMetadataTemplates', async function testMetadataTemplates(): Promise<an
83127
if (!(template.fields![0].displayName == 'testName')) {
84128
throw new Error('Assertion failed');
85129
}
130+
if (!((toString(template.fields![0].type) as string) == 'string')) {
131+
throw new Error('Assertion failed');
132+
}
133+
if (!(template.fields![1].key == 'age')) {
134+
throw new Error('Assertion failed');
135+
}
136+
if (!(template.fields![1].displayName == 'age')) {
137+
throw new Error('Assertion failed');
138+
}
139+
if (!((toString(template.fields![1].type) as string) == 'float')) {
140+
throw new Error('Assertion failed');
141+
}
142+
if (!(template.fields![2].key == 'birthDate')) {
143+
throw new Error('Assertion failed');
144+
}
145+
if (!(template.fields![2].displayName == 'birthDate')) {
146+
throw new Error('Assertion failed');
147+
}
148+
if (!((toString(template.fields![2].type) as string) == 'date')) {
149+
throw new Error('Assertion failed');
150+
}
151+
if (!(template.fields![3].key == 'countryCode')) {
152+
throw new Error('Assertion failed');
153+
}
154+
if (!(template.fields![3].displayName == 'countryCode')) {
155+
throw new Error('Assertion failed');
156+
}
157+
if (!((toString(template.fields![3].type) as string) == 'enum')) {
158+
throw new Error('Assertion failed');
159+
}
160+
if (!(template.fields![4].key == 'sports')) {
161+
throw new Error('Assertion failed');
162+
}
163+
if (!(template.fields![4].displayName == 'sports')) {
164+
throw new Error('Assertion failed');
165+
}
166+
if (!((toString(template.fields![4].type) as string) == 'multiSelect')) {
167+
throw new Error('Assertion failed');
168+
}
86169
const updatedTemplate: MetadataTemplate =
87170
await client.metadataTemplates.updateMetadataTemplate(
88171
'enterprise' as UpdateMetadataTemplateScope,
@@ -95,13 +178,13 @@ test('testMetadataTemplates', async function testMetadataTemplates(): Promise<an
95178
} satisfies UpdateMetadataTemplateRequestBody,
96179
],
97180
);
98-
if (!(updatedTemplate.fields!.length == 2)) {
181+
if (!(updatedTemplate.fields!.length == 6)) {
99182
throw new Error('Assertion failed');
100183
}
101-
if (!(updatedTemplate.fields![1].key == 'newfieldname')) {
184+
if (!(updatedTemplate.fields![5].key == 'newfieldname')) {
102185
throw new Error('Assertion failed');
103186
}
104-
if (!(updatedTemplate.fields![1].displayName == 'newFieldName')) {
187+
if (!(updatedTemplate.fields![5].displayName == 'newFieldName')) {
105188
throw new Error('Assertion failed');
106189
}
107190
const getMetadataTemplate: MetadataTemplate =

0 commit comments

Comments
 (0)