Skip to content

Commit bcaf202

Browse files
authored
chore(docs): Generated API Reference (automated)
1 parent 7c5e5e3 commit bcaf202

32 files changed

Lines changed: 891 additions & 31 deletions

www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_translations_settings_batch/post.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,5 @@ sdk.admin.translation.batchSettings({
2727
})
2828
.then(({ created, updated, deleted }) => {
2929
console.log(created, updated, deleted)
30-
})
30+
})
31+
```

www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ required:
1414
- shipping_option_id
1515
- metadata
1616
- created_at
17+
- created_by
18+
- marked_shipped_by
1719
- updated_at
1820
properties:
1921
id:
@@ -80,3 +82,11 @@ properties:
8082
type: boolean
8183
title: requires_shipping
8284
description: Whether the fulfillment requires shipping.
85+
created_by:
86+
type: string
87+
title: created_by
88+
description: The fulfillment's created by.
89+
marked_shipped_by:
90+
type: string
91+
title: marked_shipped_by
92+
description: The fulfillment's marked shipped by.

www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ required:
99
- display_id
1010
- received_at
1111
- created_at
12+
- created_by
1213
- canceled_at
1314
properties:
1415
id:
@@ -76,3 +77,7 @@ properties:
7677
type: string
7778
title: received_at
7879
description: The date the return was received.
80+
created_by:
81+
type: string
82+
title: created_by
83+
description: The return's created by.

www/apps/api-reference/specs/admin/components/schemas/AdminTranslationEntitiesResponse.yaml

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,68 @@ properties:
1313
items:
1414
allOf:
1515
- type: object
16-
description: The entity's data.
16+
description: The datum's data.
17+
- type: object
18+
description: The datum's data.
1719
required:
1820
- id
1921
- translations
2022
properties:
2123
id:
2224
type: string
2325
title: id
24-
description: The entity's ID.
26+
description: The datum's ID.
2527
translations:
2628
type: array
27-
description: The entity's translations.
29+
description: The datum's translations.
2830
items:
29-
$ref: ./AdminTranslation.yaml
31+
type: object
32+
description: The translation's translations.
33+
x-schemaName: AdminTranslation
34+
required:
35+
- id
36+
- reference_id
37+
- reference
38+
- locale_code
39+
- translations
40+
- created_at
41+
- updated_at
42+
- deleted_at
43+
properties:
44+
id:
45+
type: string
46+
title: id
47+
description: The translation's ID.
48+
reference_id:
49+
type: string
50+
title: reference_id
51+
description: The translation's reference id.
52+
reference:
53+
type: string
54+
title: reference
55+
description: The translation's reference.
56+
locale_code:
57+
type: string
58+
title: locale_code
59+
description: The translation's locale code.
60+
translations:
61+
type: object
62+
description: The translation's translations.
63+
created_at:
64+
type: string
65+
format: date-time
66+
title: created_at
67+
description: The translation's created at.
68+
updated_at:
69+
type: string
70+
format: date-time
71+
title: updated_at
72+
description: The translation's updated at.
73+
deleted_at:
74+
type: string
75+
format: date-time
76+
title: deleted_at
77+
description: The translation's deleted at.
3078
count:
3179
type: number
3280
title: count

www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ required:
1414
- shipping_option_id
1515
- metadata
1616
- created_at
17+
- created_by
18+
- marked_shipped_by
1719
- updated_at
1820
properties:
1921
id:
@@ -80,3 +82,11 @@ properties:
8082
type: boolean
8183
title: requires_shipping
8284
description: Whether the fulfillment requires shipping.
85+
created_by:
86+
type: string
87+
title: created_by
88+
description: The fulfillment's created by.
89+
marked_shipped_by:
90+
type: string
91+
title: marked_shipped_by
92+
description: The fulfillment's marked shipped by.

www/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ required:
1414
- shipping_option_id
1515
- metadata
1616
- created_at
17+
- created_by
18+
- marked_shipped_by
1719
- updated_at
1820
properties:
1921
id:
@@ -80,3 +82,11 @@ properties:
8082
type: boolean
8183
title: requires_shipping
8284
description: The fulfillment's requires shipping.
85+
created_by:
86+
type: string
87+
title: created_by
88+
description: The fulfillment's created by.
89+
marked_shipped_by:
90+
type: string
91+
title: marked_shipped_by
92+
description: The fulfillment's marked shipped by.

www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ required:
88
- created_at
99
- order_id
1010
- canceled_at
11+
- created_by
1112
- received_at
1213
properties:
1314
items:
@@ -65,3 +66,7 @@ properties:
6566
type: string
6667
title: received_at
6768
description: The date the return items were received.
69+
created_by:
70+
type: string
71+
title: created_by
72+
description: The return's created by.

0 commit comments

Comments
 (0)