Skip to content

Commit bdb9d0c

Browse files
feat: Include raw JSON in Typescript (box/box-codegen#576) (#375)
1 parent 6b162c9 commit bdb9d0c

File tree

269 files changed

+2150
-473
lines changed

Some content is hidden

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

269 files changed

+2150
-473
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "244ba36", "specHash": "6b64d06", "version": "1.6.0" }
1+
{ "engineHash": "83d735e", "specHash": "f0c2ce4", "version": "1.6.0" }

docs/ai.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,17 @@ This operation is performed by calling function `createAiExtractStructured`.
181181
See the endpoint docs at
182182
[API Reference](https://developer.box.com/reference/post-ai-extract-structured/).
183183

184-
_Currently we don't have an example for calling `createAiExtractStructured` in integration tests_
184+
<!-- sample post_ai_extract_structured -->
185+
186+
```ts
187+
await client.ai.createAiExtractStructured({
188+
metadataTemplate: {
189+
templateKey: templateKey,
190+
scope: 'enterprise',
191+
} satisfies AiExtractStructuredMetadataTemplateField,
192+
items: [new AiItemBase({ id: file.id })],
193+
} satisfies AiExtractStructured);
194+
```
185195

186196
### Arguments
187197

docs/metadataTemplates.md

Lines changed: 18 additions & 32 deletions
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-
templateKey
145+
template.templateKey!
146146
);
147147
```
148148

@@ -273,48 +273,34 @@ await client.metadataTemplates.createMetadataTemplate({
273273
templateKey: templateKey,
274274
fields: [
275275
{
276+
key: 'firstName',
277+
displayName: 'First name',
278+
description: 'Person first name',
276279
type: 'string' as CreateMetadataTemplateRequestBodyFieldsTypeField,
277-
key: 'name',
278-
displayName: 'name',
279280
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
280281
{
281-
type: 'float' as CreateMetadataTemplateRequestBodyFieldsTypeField,
282-
key: 'age',
283-
displayName: 'age',
282+
key: 'lastName',
283+
displayName: 'Last name',
284+
description: 'Person last name',
285+
type: 'string' as CreateMetadataTemplateRequestBodyFieldsTypeField,
284286
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
285287
{
288+
key: 'dateOfBirth',
289+
displayName: 'Birth date',
290+
description: 'Person date of birth',
286291
type: 'date' as CreateMetadataTemplateRequestBodyFieldsTypeField,
287-
key: 'birthDate',
288-
displayName: 'birthDate',
289292
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
290293
{
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-
],
294+
key: 'age',
295+
displayName: 'Age',
296+
description: 'Person age',
297+
type: 'float' as CreateMetadataTemplateRequestBodyFieldsTypeField,
302298
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
303299
{
300+
key: 'hobby',
301+
displayName: 'Hobby',
302+
description: 'Person hobby',
304303
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-
],
318304
} satisfies CreateMetadataTemplateRequestBodyFieldsField,
319305
],
320306
} satisfies CreateMetadataTemplateRequestBody);

0 commit comments

Comments
 (0)