@digital8/lighting-illusions-ts-sdk 0.0.2111 → 0.0.2112
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +18 -20
- package/README.md +12 -13
- package/dist/apis/OrdersApi.d.ts +17 -15
- package/dist/apis/OrdersApi.js +60 -59
- package/dist/models/AdminOrderLineItemResource.d.ts +93 -0
- package/dist/models/AdminOrderLineItemResource.js +90 -0
- package/dist/models/AdminOrderLineItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminOrderLineItemResourceArrayResponse.js +50 -0
- package/dist/models/AdminOrderResource.d.ts +16 -3
- package/dist/models/AdminOrderResource.js +12 -3
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +1 -3
- package/dist/models/OrderFulfillmentLineItemResource.d.ts +45 -0
- package/dist/models/OrderFulfillmentLineItemResource.js +60 -0
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.js +50 -0
- package/dist/models/OrderFulfillmentResource.d.ts +86 -0
- package/dist/models/OrderFulfillmentResource.js +83 -0
- package/dist/models/OrderFulfillmentResourceArrayResponse.d.ts +33 -0
- package/dist/models/OrderFulfillmentResourceArrayResponse.js +50 -0
- package/dist/models/OrderStatusId.d.ts +34 -0
- package/dist/models/OrderStatusId.js +60 -0
- package/dist/models/PaginatedOrderFulfillmentResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedOrderFulfillmentResourceResponse.js +57 -0
- package/dist/models/PaymentSource.d.ts +0 -1
- package/dist/models/PaymentSource.js +1 -2
- package/dist/models/ProductChildFrontendResource.d.ts +2 -3
- package/dist/models/ProductChildFrontendResource.js +2 -3
- package/dist/models/ProductChildLineItemLiteResource.d.ts +0 -18
- package/dist/models/ProductChildLineItemLiteResource.js +0 -12
- package/dist/models/SearchOrderFulfillmentsRequest.d.ts +120 -0
- package/dist/models/SearchOrderFulfillmentsRequest.js +88 -0
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +1 -3
- package/dist/models/StoreListResource.d.ts +2 -2
- package/dist/models/StoreListResource.js +2 -6
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +1 -3
- package/dist/models/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +1 -3
- package/dist/models/index.d.ts +9 -10
- package/dist/models/index.js +9 -10
- package/docs/{FrontendLineItemResource.md → AdminOrderLineItemResource.md} +18 -14
- package/docs/{FrontendOrderResourceArrayResponse.md → AdminOrderLineItemResourceArrayResponse.md} +5 -5
- package/docs/AdminOrderResource.md +5 -1
- package/docs/{FrontendCartResourceCouponsInner.md → OrderFulfillmentLineItemResource.md} +8 -12
- package/docs/{CartCouponLiteResourceArrayResponse.md → OrderFulfillmentLineItemResourceArrayResponse.md} +5 -5
- package/docs/OrderFulfillmentResource.md +52 -0
- package/docs/{FrontendLineItemResourceArrayResponse.md → OrderFulfillmentResourceArrayResponse.md} +5 -5
- package/docs/{OrderOmnisendEvent.md → OrderStatusId.md} +4 -4
- package/docs/OrdersApi.md +66 -66
- package/docs/{FrontendCartResourceArrayResponse.md → PaginatedOrderFulfillmentResourceResponse.md} +7 -5
- package/docs/ProductChildFrontendResource.md +1 -1
- package/docs/ProductChildLineItemLiteResource.md +0 -6
- package/docs/SearchOrderFulfillmentsRequest.md +58 -0
- package/docs/StoreSpecialDateResource.md +1 -1
- package/package.json +1 -1
- package/src/apis/OrdersApi.ts +54 -49
- package/src/models/AdminOrderLineItemResource.ts +163 -0
- package/src/models/AdminOrderLineItemResourceArrayResponse.ts +73 -0
- package/src/models/AdminOrderResource.ts +36 -11
- package/src/models/ExternalApiLogResource.ts +2 -3
- package/src/models/OrderFulfillmentLineItemResource.ts +92 -0
- package/src/models/OrderFulfillmentLineItemResourceArrayResponse.ts +73 -0
- package/src/models/OrderFulfillmentResource.ts +145 -0
- package/src/models/OrderFulfillmentResourceArrayResponse.ts +73 -0
- package/src/models/OrderStatusId.ts +62 -0
- package/src/models/PaginatedOrderFulfillmentResourceResponse.ts +90 -0
- package/src/models/PaymentSource.ts +1 -2
- package/src/models/ProductChildFrontendResource.ts +4 -11
- package/src/models/ProductChildLineItemLiteResource.ts +0 -27
- package/src/models/SearchOrderFulfillmentsRequest.ts +181 -0
- package/src/models/StoreFrontendResource.ts +2 -3
- package/src/models/StoreListResource.ts +4 -6
- package/src/models/StoreResource.ts +2 -3
- package/src/models/StoreSpecialDateResource.ts +3 -4
- package/src/models/index.ts +9 -10
- package/dist/models/CartCouponLiteResource.d.ts +0 -56
- package/dist/models/CartCouponLiteResource.js +0 -67
- package/dist/models/CartCouponLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/CartCouponLiteResourceArrayResponse.js +0 -50
- package/dist/models/FrontendCartResource.d.ts +0 -144
- package/dist/models/FrontendCartResource.js +0 -121
- package/dist/models/FrontendCartResourceArrayResponse.d.ts +0 -33
- package/dist/models/FrontendCartResourceArrayResponse.js +0 -50
- package/dist/models/FrontendCartResourceCouponsInner.d.ts +0 -56
- package/dist/models/FrontendCartResourceCouponsInner.js +0 -57
- package/dist/models/FrontendLineItemResource.d.ts +0 -81
- package/dist/models/FrontendLineItemResource.js +0 -82
- package/dist/models/FrontendLineItemResourceArrayResponse.d.ts +0 -33
- package/dist/models/FrontendLineItemResourceArrayResponse.js +0 -50
- package/dist/models/FrontendOrderResource.d.ts +0 -174
- package/dist/models/FrontendOrderResource.js +0 -141
- package/dist/models/FrontendOrderResourceArrayResponse.d.ts +0 -33
- package/dist/models/FrontendOrderResourceArrayResponse.js +0 -50
- package/dist/models/OrderOmnisendEvent.d.ts +0 -25
- package/dist/models/OrderOmnisendEvent.js +0 -51
- package/docs/CartCouponLiteResource.md +0 -42
- package/docs/FrontendCartResource.md +0 -70
- package/docs/FrontendOrderResource.md +0 -80
- package/src/models/CartCouponLiteResource.ts +0 -102
- package/src/models/CartCouponLiteResourceArrayResponse.ts +0 -73
- package/src/models/FrontendCartResource.ts +0 -254
- package/src/models/FrontendCartResourceArrayResponse.ts +0 -73
- package/src/models/FrontendCartResourceCouponsInner.ts +0 -97
- package/src/models/FrontendLineItemResource.ts +0 -145
- package/src/models/FrontendLineItemResourceArrayResponse.ts +0 -73
- package/src/models/FrontendOrderResource.ts +0 -299
- package/src/models/FrontendOrderResourceArrayResponse.ts +0 -73
- package/src/models/OrderOmnisendEvent.ts +0 -53
package/dist/models/index.d.ts
CHANGED
|
@@ -5,6 +5,8 @@ export * from './AddressResourceArrayResponse';
|
|
|
5
5
|
export * from './AddressType';
|
|
6
6
|
export * from './AdminNoteResource';
|
|
7
7
|
export * from './AdminNoteResourceArrayResponse';
|
|
8
|
+
export * from './AdminOrderLineItemResource';
|
|
9
|
+
export * from './AdminOrderLineItemResourceArrayResponse';
|
|
8
10
|
export * from './AdminOrderResource';
|
|
9
11
|
export * from './AdminOrderResourceArrayResponse';
|
|
10
12
|
export * from './AdminUserLiteResource';
|
|
@@ -57,8 +59,6 @@ export * from './BlogFrontendResource';
|
|
|
57
59
|
export * from './BlogFrontendResourceArrayResponse';
|
|
58
60
|
export * from './BlogResource';
|
|
59
61
|
export * from './BlogResourceArrayResponse';
|
|
60
|
-
export * from './CartCouponLiteResource';
|
|
61
|
-
export * from './CartCouponLiteResourceArrayResponse';
|
|
62
62
|
export * from './CartCouponResource';
|
|
63
63
|
export * from './CartCouponResourceArrayResponse';
|
|
64
64
|
export * from './CartListResource';
|
|
@@ -164,17 +164,10 @@ export * from './ExternalApiLogResource';
|
|
|
164
164
|
export * from './ExternalApiLogResourceArrayResponse';
|
|
165
165
|
export * from './ExternalApiProvider';
|
|
166
166
|
export * from './ExternalApiSyncStatus';
|
|
167
|
-
export * from './FrontendCartResource';
|
|
168
|
-
export * from './FrontendCartResourceArrayResponse';
|
|
169
|
-
export * from './FrontendCartResourceCouponsInner';
|
|
170
167
|
export * from './FrontendComponentLiteResource';
|
|
171
168
|
export * from './FrontendComponentLiteResourceArrayResponse';
|
|
172
169
|
export * from './FrontendComponentResource';
|
|
173
170
|
export * from './FrontendComponentResourceArrayResponse';
|
|
174
|
-
export * from './FrontendLineItemResource';
|
|
175
|
-
export * from './FrontendLineItemResourceArrayResponse';
|
|
176
|
-
export * from './FrontendOrderResource';
|
|
177
|
-
export * from './FrontendOrderResourceArrayResponse';
|
|
178
171
|
export * from './GenericResponse';
|
|
179
172
|
export * from './GetUniqueEndpointsRequest';
|
|
180
173
|
export * from './GlobalSearchCategoryResource';
|
|
@@ -226,11 +219,15 @@ export * from './ModelAttributeResource';
|
|
|
226
219
|
export * from './ModelAttributeResourceArrayResponse';
|
|
227
220
|
export * from './OmnisendSyncLiteResource';
|
|
228
221
|
export * from './OmnisendSyncLiteResourceArrayResponse';
|
|
222
|
+
export * from './OrderFulfillmentLineItemResource';
|
|
223
|
+
export * from './OrderFulfillmentLineItemResourceArrayResponse';
|
|
224
|
+
export * from './OrderFulfillmentResource';
|
|
225
|
+
export * from './OrderFulfillmentResourceArrayResponse';
|
|
229
226
|
export * from './OrderListResource';
|
|
230
227
|
export * from './OrderListResourceArrayResponse';
|
|
231
228
|
export * from './OrderLiteResource';
|
|
232
229
|
export * from './OrderLiteResourceArrayResponse';
|
|
233
|
-
export * from './
|
|
230
|
+
export * from './OrderStatusId';
|
|
234
231
|
export * from './OrderStatusLiteResource';
|
|
235
232
|
export * from './OrderStatusLiteResourceArrayResponse';
|
|
236
233
|
export * from './OrderStatusWithCountResource';
|
|
@@ -286,6 +283,7 @@ export * from './PaginatedGoogleCategoryResourceResponse';
|
|
|
286
283
|
export * from './PaginatedLabelListResourceResponse';
|
|
287
284
|
export * from './PaginatedMenuListResourceResponse';
|
|
288
285
|
export * from './PaginatedModelAttributeListResourceResponse';
|
|
286
|
+
export * from './PaginatedOrderFulfillmentResourceResponse';
|
|
289
287
|
export * from './PaginatedOrderListResourceResponse';
|
|
290
288
|
export * from './PaginatedOverlayTemplateListResourceResponse';
|
|
291
289
|
export * from './PaginatedOverlayTemplateLiteResourceResponse';
|
|
@@ -500,6 +498,7 @@ export * from './SearchLabelsRequest';
|
|
|
500
498
|
export * from './SearchLinkablesRequest';
|
|
501
499
|
export * from './SearchMenusRequest';
|
|
502
500
|
export * from './SearchModelAttributesRequest';
|
|
501
|
+
export * from './SearchOrderFulfillmentsRequest';
|
|
503
502
|
export * from './SearchOrdersRequest';
|
|
504
503
|
export * from './SearchOverlayTemplatesRequest';
|
|
505
504
|
export * from './SearchPagesRequest';
|
package/dist/models/index.js
CHANGED
|
@@ -23,6 +23,8 @@ __exportStar(require("./AddressResourceArrayResponse"), exports);
|
|
|
23
23
|
__exportStar(require("./AddressType"), exports);
|
|
24
24
|
__exportStar(require("./AdminNoteResource"), exports);
|
|
25
25
|
__exportStar(require("./AdminNoteResourceArrayResponse"), exports);
|
|
26
|
+
__exportStar(require("./AdminOrderLineItemResource"), exports);
|
|
27
|
+
__exportStar(require("./AdminOrderLineItemResourceArrayResponse"), exports);
|
|
26
28
|
__exportStar(require("./AdminOrderResource"), exports);
|
|
27
29
|
__exportStar(require("./AdminOrderResourceArrayResponse"), exports);
|
|
28
30
|
__exportStar(require("./AdminUserLiteResource"), exports);
|
|
@@ -75,8 +77,6 @@ __exportStar(require("./BlogFrontendResource"), exports);
|
|
|
75
77
|
__exportStar(require("./BlogFrontendResourceArrayResponse"), exports);
|
|
76
78
|
__exportStar(require("./BlogResource"), exports);
|
|
77
79
|
__exportStar(require("./BlogResourceArrayResponse"), exports);
|
|
78
|
-
__exportStar(require("./CartCouponLiteResource"), exports);
|
|
79
|
-
__exportStar(require("./CartCouponLiteResourceArrayResponse"), exports);
|
|
80
80
|
__exportStar(require("./CartCouponResource"), exports);
|
|
81
81
|
__exportStar(require("./CartCouponResourceArrayResponse"), exports);
|
|
82
82
|
__exportStar(require("./CartListResource"), exports);
|
|
@@ -182,17 +182,10 @@ __exportStar(require("./ExternalApiLogResource"), exports);
|
|
|
182
182
|
__exportStar(require("./ExternalApiLogResourceArrayResponse"), exports);
|
|
183
183
|
__exportStar(require("./ExternalApiProvider"), exports);
|
|
184
184
|
__exportStar(require("./ExternalApiSyncStatus"), exports);
|
|
185
|
-
__exportStar(require("./FrontendCartResource"), exports);
|
|
186
|
-
__exportStar(require("./FrontendCartResourceArrayResponse"), exports);
|
|
187
|
-
__exportStar(require("./FrontendCartResourceCouponsInner"), exports);
|
|
188
185
|
__exportStar(require("./FrontendComponentLiteResource"), exports);
|
|
189
186
|
__exportStar(require("./FrontendComponentLiteResourceArrayResponse"), exports);
|
|
190
187
|
__exportStar(require("./FrontendComponentResource"), exports);
|
|
191
188
|
__exportStar(require("./FrontendComponentResourceArrayResponse"), exports);
|
|
192
|
-
__exportStar(require("./FrontendLineItemResource"), exports);
|
|
193
|
-
__exportStar(require("./FrontendLineItemResourceArrayResponse"), exports);
|
|
194
|
-
__exportStar(require("./FrontendOrderResource"), exports);
|
|
195
|
-
__exportStar(require("./FrontendOrderResourceArrayResponse"), exports);
|
|
196
189
|
__exportStar(require("./GenericResponse"), exports);
|
|
197
190
|
__exportStar(require("./GetUniqueEndpointsRequest"), exports);
|
|
198
191
|
__exportStar(require("./GlobalSearchCategoryResource"), exports);
|
|
@@ -244,11 +237,15 @@ __exportStar(require("./ModelAttributeResource"), exports);
|
|
|
244
237
|
__exportStar(require("./ModelAttributeResourceArrayResponse"), exports);
|
|
245
238
|
__exportStar(require("./OmnisendSyncLiteResource"), exports);
|
|
246
239
|
__exportStar(require("./OmnisendSyncLiteResourceArrayResponse"), exports);
|
|
240
|
+
__exportStar(require("./OrderFulfillmentLineItemResource"), exports);
|
|
241
|
+
__exportStar(require("./OrderFulfillmentLineItemResourceArrayResponse"), exports);
|
|
242
|
+
__exportStar(require("./OrderFulfillmentResource"), exports);
|
|
243
|
+
__exportStar(require("./OrderFulfillmentResourceArrayResponse"), exports);
|
|
247
244
|
__exportStar(require("./OrderListResource"), exports);
|
|
248
245
|
__exportStar(require("./OrderListResourceArrayResponse"), exports);
|
|
249
246
|
__exportStar(require("./OrderLiteResource"), exports);
|
|
250
247
|
__exportStar(require("./OrderLiteResourceArrayResponse"), exports);
|
|
251
|
-
__exportStar(require("./
|
|
248
|
+
__exportStar(require("./OrderStatusId"), exports);
|
|
252
249
|
__exportStar(require("./OrderStatusLiteResource"), exports);
|
|
253
250
|
__exportStar(require("./OrderStatusLiteResourceArrayResponse"), exports);
|
|
254
251
|
__exportStar(require("./OrderStatusWithCountResource"), exports);
|
|
@@ -304,6 +301,7 @@ __exportStar(require("./PaginatedGoogleCategoryResourceResponse"), exports);
|
|
|
304
301
|
__exportStar(require("./PaginatedLabelListResourceResponse"), exports);
|
|
305
302
|
__exportStar(require("./PaginatedMenuListResourceResponse"), exports);
|
|
306
303
|
__exportStar(require("./PaginatedModelAttributeListResourceResponse"), exports);
|
|
304
|
+
__exportStar(require("./PaginatedOrderFulfillmentResourceResponse"), exports);
|
|
307
305
|
__exportStar(require("./PaginatedOrderListResourceResponse"), exports);
|
|
308
306
|
__exportStar(require("./PaginatedOverlayTemplateListResourceResponse"), exports);
|
|
309
307
|
__exportStar(require("./PaginatedOverlayTemplateLiteResourceResponse"), exports);
|
|
@@ -518,6 +516,7 @@ __exportStar(require("./SearchLabelsRequest"), exports);
|
|
|
518
516
|
__exportStar(require("./SearchLinkablesRequest"), exports);
|
|
519
517
|
__exportStar(require("./SearchMenusRequest"), exports);
|
|
520
518
|
__exportStar(require("./SearchModelAttributesRequest"), exports);
|
|
519
|
+
__exportStar(require("./SearchOrderFulfillmentsRequest"), exports);
|
|
521
520
|
__exportStar(require("./SearchOrdersRequest"), exports);
|
|
522
521
|
__exportStar(require("./SearchOverlayTemplatesRequest"), exports);
|
|
523
522
|
__exportStar(require("./SearchPagesRequest"), exports);
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AdminOrderLineItemResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -9,30 +9,34 @@ Name | Type
|
|
|
9
9
|
`id` | number
|
|
10
10
|
`quantity` | number
|
|
11
11
|
`productPrice` | number
|
|
12
|
-
`
|
|
13
|
-
`
|
|
14
|
-
`
|
|
15
|
-
`
|
|
16
|
-
`
|
|
12
|
+
`labelId` | number
|
|
13
|
+
`productDiscount` | number
|
|
14
|
+
`totalDiscount` | number
|
|
15
|
+
`lineSubtotal` | number
|
|
16
|
+
`discounts` | object
|
|
17
17
|
`productChild` | [ProductChildLineItemLiteResource](ProductChildLineItemLiteResource.md)
|
|
18
|
+
`quantityFulfilled` | number
|
|
19
|
+
`returnsQuantity` | number
|
|
18
20
|
|
|
19
21
|
## Example
|
|
20
22
|
|
|
21
23
|
```typescript
|
|
22
|
-
import type {
|
|
24
|
+
import type { AdminOrderLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
23
25
|
|
|
24
26
|
// TODO: Update the object below with actual values
|
|
25
27
|
const example = {
|
|
26
28
|
"id": null,
|
|
27
29
|
"quantity": null,
|
|
28
30
|
"productPrice": null,
|
|
29
|
-
"
|
|
30
|
-
"
|
|
31
|
-
"
|
|
32
|
-
"
|
|
33
|
-
"
|
|
31
|
+
"labelId": null,
|
|
32
|
+
"productDiscount": null,
|
|
33
|
+
"totalDiscount": null,
|
|
34
|
+
"lineSubtotal": null,
|
|
35
|
+
"discounts": null,
|
|
34
36
|
"productChild": null,
|
|
35
|
-
|
|
37
|
+
"quantityFulfilled": null,
|
|
38
|
+
"returnsQuantity": null,
|
|
39
|
+
} satisfies AdminOrderLineItemResource
|
|
36
40
|
|
|
37
41
|
console.log(example)
|
|
38
42
|
|
|
@@ -41,7 +45,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
41
45
|
console.log(exampleJSON)
|
|
42
46
|
|
|
43
47
|
// Parse the JSON string back to an object
|
|
44
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
48
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminOrderLineItemResource
|
|
45
49
|
console.log(exampleParsed)
|
|
46
50
|
```
|
|
47
51
|
|
package/docs/{FrontendOrderResourceArrayResponse.md → AdminOrderLineItemResourceArrayResponse.md}
RENAMED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AdminOrderLineItemResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<AdminOrderLineItemResource>](AdminOrderLineItemResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { AdminOrderLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
18
|
"data": null,
|
|
19
|
-
} satisfies
|
|
19
|
+
} satisfies AdminOrderLineItemResourceArrayResponse
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminOrderLineItemResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -37,10 +37,12 @@ Name | Type
|
|
|
37
37
|
`totalOutstanding` | number
|
|
38
38
|
`insuranceEstimate` | number
|
|
39
39
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
40
|
+
`fulfillmentsCount` | object
|
|
41
|
+
`latestFulfillment` | [OrderFulfillmentResource](OrderFulfillmentResource.md)
|
|
40
42
|
`customer` | [CustomerResource](CustomerResource.md)
|
|
41
43
|
`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
|
|
42
44
|
`status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
|
|
43
|
-
`lineItems` | [Array<
|
|
45
|
+
`lineItems` | [Array<AdminOrderLineItemResource>](AdminOrderLineItemResource.md)
|
|
44
46
|
`coupons` | [Array<CartCouponResource>](CartCouponResource.md)
|
|
45
47
|
`discounts` | [Array<DiscountResource>](DiscountResource.md)
|
|
46
48
|
`transactions` | [Array<TransactionLiteResource>](TransactionLiteResource.md)
|
|
@@ -86,6 +88,8 @@ const example = {
|
|
|
86
88
|
"totalOutstanding": null,
|
|
87
89
|
"insuranceEstimate": null,
|
|
88
90
|
"site": null,
|
|
91
|
+
"fulfillmentsCount": null,
|
|
92
|
+
"latestFulfillment": null,
|
|
89
93
|
"customer": null,
|
|
90
94
|
"admin": null,
|
|
91
95
|
"status": null,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderFulfillmentLineItemResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -7,24 +7,20 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
11
|
-
`
|
|
12
|
-
`discount` | number
|
|
13
|
-
`appliesTo` | string
|
|
10
|
+
`quantity` | number
|
|
11
|
+
`lineItem` | [AdminOrderLineItemResource](AdminOrderLineItemResource.md)
|
|
14
12
|
|
|
15
13
|
## Example
|
|
16
14
|
|
|
17
15
|
```typescript
|
|
18
|
-
import type {
|
|
16
|
+
import type { OrderFulfillmentLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
17
|
|
|
20
18
|
// TODO: Update the object below with actual values
|
|
21
19
|
const example = {
|
|
22
20
|
"id": null,
|
|
23
|
-
"
|
|
24
|
-
"
|
|
25
|
-
|
|
26
|
-
"appliesTo": null,
|
|
27
|
-
} satisfies FrontendCartResourceCouponsInner
|
|
21
|
+
"quantity": null,
|
|
22
|
+
"lineItem": null,
|
|
23
|
+
} satisfies OrderFulfillmentLineItemResource
|
|
28
24
|
|
|
29
25
|
console.log(example)
|
|
30
26
|
|
|
@@ -33,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
33
29
|
console.log(exampleJSON)
|
|
34
30
|
|
|
35
31
|
// Parse the JSON string back to an object
|
|
36
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderFulfillmentLineItemResource
|
|
37
33
|
console.log(exampleParsed)
|
|
38
34
|
```
|
|
39
35
|
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderFulfillmentLineItemResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<OrderFulfillmentLineItemResource>](OrderFulfillmentLineItemResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { OrderFulfillmentLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
18
|
"data": null,
|
|
19
|
-
} satisfies
|
|
19
|
+
} satisfies OrderFulfillmentLineItemResourceArrayResponse
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderFulfillmentLineItemResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
|
|
2
|
+
# OrderFulfillmentResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`orderId` | number
|
|
11
|
+
`dateShipped` | Date
|
|
12
|
+
`trackingNumber` | string
|
|
13
|
+
`trackingUrl` | string
|
|
14
|
+
`trackingCompany` | string
|
|
15
|
+
`docnum` | string
|
|
16
|
+
`createdAt` | Date
|
|
17
|
+
`updatedAt` | Date
|
|
18
|
+
`orderFulfillmentLineItems` | object
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { OrderFulfillmentResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"id": null,
|
|
28
|
+
"orderId": null,
|
|
29
|
+
"dateShipped": null,
|
|
30
|
+
"trackingNumber": null,
|
|
31
|
+
"trackingUrl": null,
|
|
32
|
+
"trackingCompany": null,
|
|
33
|
+
"docnum": null,
|
|
34
|
+
"createdAt": null,
|
|
35
|
+
"updatedAt": null,
|
|
36
|
+
"orderFulfillmentLineItems": null,
|
|
37
|
+
} satisfies OrderFulfillmentResource
|
|
38
|
+
|
|
39
|
+
console.log(example)
|
|
40
|
+
|
|
41
|
+
// Convert the instance to a JSON string
|
|
42
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
43
|
+
console.log(exampleJSON)
|
|
44
|
+
|
|
45
|
+
// Parse the JSON string back to an object
|
|
46
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderFulfillmentResource
|
|
47
|
+
console.log(exampleParsed)
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
51
|
+
|
|
52
|
+
|
package/docs/{FrontendLineItemResourceArrayResponse.md → OrderFulfillmentResourceArrayResponse.md}
RENAMED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderFulfillmentResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<OrderFulfillmentResource>](OrderFulfillmentResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { OrderFulfillmentResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
18
|
"data": null,
|
|
19
|
-
} satisfies
|
|
19
|
+
} satisfies OrderFulfillmentResourceArrayResponse
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderFulfillmentResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderStatusId
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -10,11 +10,11 @@ Name | Type
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import type {
|
|
13
|
+
import type { OrderStatusId } from '@digital8/lighting-illusions-ts-sdk'
|
|
14
14
|
|
|
15
15
|
// TODO: Update the object below with actual values
|
|
16
16
|
const example = {
|
|
17
|
-
} satisfies
|
|
17
|
+
} satisfies OrderStatusId
|
|
18
18
|
|
|
19
19
|
console.log(example)
|
|
20
20
|
|
|
@@ -23,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
23
23
|
console.log(exampleJSON)
|
|
24
24
|
|
|
25
25
|
// Parse the JSON string back to an object
|
|
26
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
26
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderStatusId
|
|
27
27
|
console.log(exampleParsed)
|
|
28
28
|
```
|
|
29
29
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**allOrderFulfillment**](OrdersApi.md#allorderfulfillment) | **POST** /admin-api/orders/fulfillments/all | Auto-generated: allOrderFulfillment |
|
|
7
8
|
| [**attachCouponOrder**](OrdersApi.md#attachcouponorder) | **POST** /admin-api/orders/{order}/coupons/attach | Auto-generated: attachCouponOrder |
|
|
8
9
|
| [**attachItemOrder**](OrdersApi.md#attachitemorder) | **POST** /admin-api/orders/{order}/line-items/attach | Auto-generated: attachItemOrder |
|
|
9
10
|
| [**destroyOrder**](OrdersApi.md#destroyorder) | **DELETE** /admin-api/orders/{order}/delete | Auto-generated: destroyOrder |
|
|
@@ -11,7 +12,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
11
12
|
| [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
|
|
12
13
|
| [**getAllOrder**](OrdersApi.md#getallorder) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
|
|
13
14
|
| [**indexOrder**](OrdersApi.md#indexorder) | **POST** /admin-api/orders/list | Auto-generated: indexOrder |
|
|
14
|
-
| [**pdfOrder**](OrdersApi.md#pdforder) | **POST** /admin-api/orders/{order}/pdf | Auto-generated: pdfOrder |
|
|
15
15
|
| [**sendPaymentLinkOrder**](OrdersApi.md#sendpaymentlinkorder) | **POST** /admin-api/orders/{order}/send-payment-link | Auto-generated: sendPaymentLinkOrder |
|
|
16
16
|
| [**showOrder**](OrdersApi.md#showorder) | **GET** /admin-api/orders/{order} | Auto-generated: showOrder |
|
|
17
17
|
| [**statusesAllOrder**](OrdersApi.md#statusesallorder) | **POST** /admin-api/orders/statuses/all | Auto-generated: statusesAllOrder |
|
|
@@ -20,6 +20,71 @@ All URIs are relative to *http://localhost/api*
|
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
## allOrderFulfillment
|
|
24
|
+
|
|
25
|
+
> PaginatedOrderFulfillmentResourceResponse allOrderFulfillment(searchOrderFulfillmentsRequest)
|
|
26
|
+
|
|
27
|
+
Auto-generated: allOrderFulfillment
|
|
28
|
+
|
|
29
|
+
### Example
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import {
|
|
33
|
+
Configuration,
|
|
34
|
+
OrdersApi,
|
|
35
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
36
|
+
import type { AllOrderFulfillmentRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
37
|
+
|
|
38
|
+
async function example() {
|
|
39
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
40
|
+
const api = new OrdersApi();
|
|
41
|
+
|
|
42
|
+
const body = {
|
|
43
|
+
// SearchOrderFulfillmentsRequest (optional)
|
|
44
|
+
searchOrderFulfillmentsRequest: ...,
|
|
45
|
+
} satisfies AllOrderFulfillmentRequest;
|
|
46
|
+
|
|
47
|
+
try {
|
|
48
|
+
const data = await api.allOrderFulfillment(body);
|
|
49
|
+
console.log(data);
|
|
50
|
+
} catch (error) {
|
|
51
|
+
console.error(error);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
// Run the test
|
|
56
|
+
example().catch(console.error);
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Parameters
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
| Name | Type | Description | Notes |
|
|
63
|
+
|------------- | ------------- | ------------- | -------------|
|
|
64
|
+
| **searchOrderFulfillmentsRequest** | [SearchOrderFulfillmentsRequest](SearchOrderFulfillmentsRequest.md) | | [Optional] |
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
[**PaginatedOrderFulfillmentResourceResponse**](PaginatedOrderFulfillmentResourceResponse.md)
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
No authorization required
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: `application/json`
|
|
77
|
+
- **Accept**: `application/json`
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
### HTTP response details
|
|
81
|
+
| Status code | Description | Response headers |
|
|
82
|
+
|-------------|-------------|------------------|
|
|
83
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\OrderFulfillmentResource[]>> | - |
|
|
84
|
+
|
|
85
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
86
|
+
|
|
87
|
+
|
|
23
88
|
## attachCouponOrder
|
|
24
89
|
|
|
25
90
|
> AdminOrderResource attachCouponOrder(order, attachCouponRequest)
|
|
@@ -487,71 +552,6 @@ No authorization required
|
|
|
487
552
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
488
553
|
|
|
489
554
|
|
|
490
|
-
## pdfOrder
|
|
491
|
-
|
|
492
|
-
> GenericResponse pdfOrder(order)
|
|
493
|
-
|
|
494
|
-
Auto-generated: pdfOrder
|
|
495
|
-
|
|
496
|
-
### Example
|
|
497
|
-
|
|
498
|
-
```ts
|
|
499
|
-
import {
|
|
500
|
-
Configuration,
|
|
501
|
-
OrdersApi,
|
|
502
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
503
|
-
import type { PdfOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
504
|
-
|
|
505
|
-
async function example() {
|
|
506
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
507
|
-
const api = new OrdersApi();
|
|
508
|
-
|
|
509
|
-
const body = {
|
|
510
|
-
// number | The id of the order
|
|
511
|
-
order: 56,
|
|
512
|
-
} satisfies PdfOrderRequest;
|
|
513
|
-
|
|
514
|
-
try {
|
|
515
|
-
const data = await api.pdfOrder(body);
|
|
516
|
-
console.log(data);
|
|
517
|
-
} catch (error) {
|
|
518
|
-
console.error(error);
|
|
519
|
-
}
|
|
520
|
-
}
|
|
521
|
-
|
|
522
|
-
// Run the test
|
|
523
|
-
example().catch(console.error);
|
|
524
|
-
```
|
|
525
|
-
|
|
526
|
-
### Parameters
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
| Name | Type | Description | Notes |
|
|
530
|
-
|------------- | ------------- | ------------- | -------------|
|
|
531
|
-
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
532
|
-
|
|
533
|
-
### Return type
|
|
534
|
-
|
|
535
|
-
[**GenericResponse**](GenericResponse.md)
|
|
536
|
-
|
|
537
|
-
### Authorization
|
|
538
|
-
|
|
539
|
-
No authorization required
|
|
540
|
-
|
|
541
|
-
### HTTP request headers
|
|
542
|
-
|
|
543
|
-
- **Content-Type**: Not defined
|
|
544
|
-
- **Accept**: `application/json`
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
### HTTP response details
|
|
548
|
-
| Status code | Description | Response headers |
|
|
549
|
-
|-------------|-------------|------------------|
|
|
550
|
-
| **200** | \\Response | - |
|
|
551
|
-
|
|
552
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
553
|
-
|
|
554
|
-
|
|
555
555
|
## sendPaymentLinkOrder
|
|
556
556
|
|
|
557
557
|
> AdminOrderResource sendPaymentLinkOrder(order)
|
package/docs/{FrontendCartResourceArrayResponse.md → PaginatedOrderFulfillmentResourceResponse.md}
RENAMED
|
@@ -1,22 +1,24 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# PaginatedOrderFulfillmentResourceResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<OrderFulfillmentResource>](OrderFulfillmentResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
13
14
|
```typescript
|
|
14
|
-
import type {
|
|
15
|
+
import type { PaginatedOrderFulfillmentResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
16
|
|
|
16
17
|
// TODO: Update the object below with actual values
|
|
17
18
|
const example = {
|
|
18
19
|
"data": null,
|
|
19
|
-
|
|
20
|
+
"meta": null,
|
|
21
|
+
} satisfies PaginatedOrderFulfillmentResourceResponse
|
|
20
22
|
|
|
21
23
|
console.log(example)
|
|
22
24
|
|
|
@@ -25,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
27
|
console.log(exampleJSON)
|
|
26
28
|
|
|
27
29
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedOrderFulfillmentResourceResponse
|
|
29
31
|
console.log(exampleParsed)
|
|
30
32
|
```
|
|
31
33
|
|
|
@@ -13,7 +13,7 @@ Name | Type
|
|
|
13
13
|
`variations` | number
|
|
14
14
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
15
15
|
`supplier` | [SupplierFrontendResource](SupplierFrontendResource.md)
|
|
16
|
-
`siteDetails` |
|
|
16
|
+
`siteDetails` | object
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|