@digital8/lighting-illusions-ts-sdk 0.0.2105 → 0.0.2106
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 -14
- package/README.md +12 -9
- package/dist/apis/OrdersApi.d.ts +17 -0
- package/dist/apis/OrdersApi.js +60 -0
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +3 -1
- package/dist/models/AddressResource.d.ts +2 -2
- package/dist/models/AddressResource.js +2 -6
- package/dist/models/AdminOrderLineItemResource.d.ts +117 -0
- package/dist/models/AdminOrderLineItemResource.js +106 -0
- package/dist/models/AdminOrderLineItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminOrderLineItemResourceArrayResponse.js +50 -0
- package/dist/models/AdminOrderResource.d.ts +22 -3
- package/dist/models/AdminOrderResource.js +16 -3
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +3 -1
- 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 +93 -0
- package/dist/models/OrderFulfillmentResource.js +84 -0
- package/dist/models/OrderFulfillmentResourceArrayResponse.d.ts +33 -0
- package/dist/models/OrderFulfillmentResourceArrayResponse.js +50 -0
- package/dist/models/OrderStatusId.d.ts +37 -0
- package/dist/models/OrderStatusId.js +63 -0
- package/dist/models/PaginatedOrderFulfillmentResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedOrderFulfillmentResourceResponse.js +57 -0
- 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 +6 -2
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +1 -3
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
- package/dist/models/index.d.ts +9 -7
- package/dist/models/index.js +9 -7
- package/docs/AdminOrderLineItemResource.md +62 -0
- package/docs/{CartCouponLiteResource.md → AdminOrderLineItemResourceArrayResponse.md} +6 -14
- package/docs/AdminOrderResource.md +7 -1
- package/docs/{FrontendCartResourceCouponsInner.md → OrderFulfillmentLineItemResource.md} +8 -12
- package/docs/{CartCouponLiteResourceArrayResponse.md → OrderFulfillmentLineItemResourceArrayResponse.md} +5 -5
- package/docs/OrderFulfillmentResource.md +54 -0
- package/docs/{FrontendLineItemResourceArrayResponse.md → OrderFulfillmentResourceArrayResponse.md} +5 -5
- package/docs/{FrontendCartResourceArrayResponse.md → OrderStatusId.md} +4 -6
- package/docs/OrdersApi.md +66 -0
- package/docs/PaginatedOrderFulfillmentResourceResponse.md +36 -0
- package/docs/ProductChildLineItemLiteResource.md +0 -6
- package/docs/SearchOrderFulfillmentsRequest.md +58 -0
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/package.json +1 -1
- package/src/apis/OrdersApi.ts +54 -0
- package/src/models/AddressFrontendResource.ts +3 -2
- package/src/models/AddressResource.ts +4 -6
- package/src/models/AdminOrderLineItemResource.ts +199 -0
- package/src/models/AdminOrderLineItemResourceArrayResponse.ts +73 -0
- package/src/models/AdminOrderResource.ts +45 -11
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/OrderFulfillmentLineItemResource.ts +92 -0
- package/src/models/OrderFulfillmentLineItemResourceArrayResponse.ts +73 -0
- package/src/models/OrderFulfillmentResource.ts +160 -0
- package/src/models/OrderFulfillmentResourceArrayResponse.ts +73 -0
- package/src/models/OrderStatusId.ts +65 -0
- package/src/models/PaginatedOrderFulfillmentResourceResponse.ts +90 -0
- 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 +6 -4
- package/src/models/StoreResource.ts +2 -3
- package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
- package/src/models/index.ts +9 -7
- 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 -138
- package/dist/models/FrontendCartResource.js +0 -119
- 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/docs/FrontendCartResource.md +0 -68
- package/docs/FrontendLineItemResource.md +0 -50
- package/src/models/CartCouponLiteResource.ts +0 -102
- package/src/models/CartCouponLiteResourceArrayResponse.ts +0 -73
- package/src/models/FrontendCartResource.ts +0 -246
- 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/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,15 +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
189
|
__exportStar(require("./GenericResponse"), exports);
|
|
195
190
|
__exportStar(require("./GetUniqueEndpointsRequest"), exports);
|
|
196
191
|
__exportStar(require("./GlobalSearchCategoryResource"), exports);
|
|
@@ -242,11 +237,16 @@ __exportStar(require("./ModelAttributeResource"), exports);
|
|
|
242
237
|
__exportStar(require("./ModelAttributeResourceArrayResponse"), exports);
|
|
243
238
|
__exportStar(require("./OmnisendSyncLiteResource"), exports);
|
|
244
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);
|
|
245
244
|
__exportStar(require("./OrderListResource"), exports);
|
|
246
245
|
__exportStar(require("./OrderListResourceArrayResponse"), exports);
|
|
247
246
|
__exportStar(require("./OrderLiteResource"), exports);
|
|
248
247
|
__exportStar(require("./OrderLiteResourceArrayResponse"), exports);
|
|
249
248
|
__exportStar(require("./OrderOmnisendEvent"), exports);
|
|
249
|
+
__exportStar(require("./OrderStatusId"), exports);
|
|
250
250
|
__exportStar(require("./OrderStatusLiteResource"), exports);
|
|
251
251
|
__exportStar(require("./OrderStatusLiteResourceArrayResponse"), exports);
|
|
252
252
|
__exportStar(require("./OrderStatusWithCountResource"), exports);
|
|
@@ -302,6 +302,7 @@ __exportStar(require("./PaginatedGoogleCategoryResourceResponse"), exports);
|
|
|
302
302
|
__exportStar(require("./PaginatedLabelListResourceResponse"), exports);
|
|
303
303
|
__exportStar(require("./PaginatedMenuListResourceResponse"), exports);
|
|
304
304
|
__exportStar(require("./PaginatedModelAttributeListResourceResponse"), exports);
|
|
305
|
+
__exportStar(require("./PaginatedOrderFulfillmentResourceResponse"), exports);
|
|
305
306
|
__exportStar(require("./PaginatedOrderListResourceResponse"), exports);
|
|
306
307
|
__exportStar(require("./PaginatedOverlayTemplateListResourceResponse"), exports);
|
|
307
308
|
__exportStar(require("./PaginatedOverlayTemplateLiteResourceResponse"), exports);
|
|
@@ -516,6 +517,7 @@ __exportStar(require("./SearchLabelsRequest"), exports);
|
|
|
516
517
|
__exportStar(require("./SearchLinkablesRequest"), exports);
|
|
517
518
|
__exportStar(require("./SearchMenusRequest"), exports);
|
|
518
519
|
__exportStar(require("./SearchModelAttributesRequest"), exports);
|
|
520
|
+
__exportStar(require("./SearchOrderFulfillmentsRequest"), exports);
|
|
519
521
|
__exportStar(require("./SearchOrdersRequest"), exports);
|
|
520
522
|
__exportStar(require("./SearchOverlayTemplatesRequest"), exports);
|
|
521
523
|
__exportStar(require("./SearchPagesRequest"), exports);
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
|
|
2
|
+
# AdminOrderLineItemResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`quantity` | number
|
|
11
|
+
`productPrice` | number
|
|
12
|
+
`labelId` | number
|
|
13
|
+
`productDiscount` | number
|
|
14
|
+
`totalDiscount` | number
|
|
15
|
+
`lineSubtotal` | number
|
|
16
|
+
`discounts` | object
|
|
17
|
+
`productChild` | [ProductChildLineItemLiteResource](ProductChildLineItemLiteResource.md)
|
|
18
|
+
`quantityFulfilled` | number
|
|
19
|
+
`returnsQuantity` | number
|
|
20
|
+
`lastDateShipped` | string
|
|
21
|
+
`lastTrackingNumber` | string
|
|
22
|
+
`lastTrackingUrl` | string
|
|
23
|
+
`totalShipments` | number
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import type { AdminOrderLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
29
|
+
|
|
30
|
+
// TODO: Update the object below with actual values
|
|
31
|
+
const example = {
|
|
32
|
+
"id": null,
|
|
33
|
+
"quantity": null,
|
|
34
|
+
"productPrice": null,
|
|
35
|
+
"labelId": null,
|
|
36
|
+
"productDiscount": null,
|
|
37
|
+
"totalDiscount": null,
|
|
38
|
+
"lineSubtotal": null,
|
|
39
|
+
"discounts": null,
|
|
40
|
+
"productChild": null,
|
|
41
|
+
"quantityFulfilled": null,
|
|
42
|
+
"returnsQuantity": null,
|
|
43
|
+
"lastDateShipped": null,
|
|
44
|
+
"lastTrackingNumber": null,
|
|
45
|
+
"lastTrackingUrl": null,
|
|
46
|
+
"totalShipments": null,
|
|
47
|
+
} satisfies AdminOrderLineItemResource
|
|
48
|
+
|
|
49
|
+
console.log(example)
|
|
50
|
+
|
|
51
|
+
// Convert the instance to a JSON string
|
|
52
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
53
|
+
console.log(exampleJSON)
|
|
54
|
+
|
|
55
|
+
// Parse the JSON string back to an object
|
|
56
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminOrderLineItemResource
|
|
57
|
+
console.log(exampleParsed)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
61
|
+
|
|
62
|
+
|
|
@@ -1,30 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AdminOrderLineItemResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
10
|
-
`code` | string
|
|
11
|
-
`name` | string
|
|
12
|
-
`discount` | number
|
|
13
|
-
`appliesTo` | string
|
|
9
|
+
`data` | [Array<AdminOrderLineItemResource>](AdminOrderLineItemResource.md)
|
|
14
10
|
|
|
15
11
|
## Example
|
|
16
12
|
|
|
17
13
|
```typescript
|
|
18
|
-
import type {
|
|
14
|
+
import type { AdminOrderLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
15
|
|
|
20
16
|
// TODO: Update the object below with actual values
|
|
21
17
|
const example = {
|
|
22
|
-
"
|
|
23
|
-
|
|
24
|
-
"name": null,
|
|
25
|
-
"discount": null,
|
|
26
|
-
"appliesTo": null,
|
|
27
|
-
} satisfies CartCouponLiteResource
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies AdminOrderLineItemResourceArrayResponse
|
|
28
20
|
|
|
29
21
|
console.log(example)
|
|
30
22
|
|
|
@@ -33,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
33
25
|
console.log(exampleJSON)
|
|
34
26
|
|
|
35
27
|
// Parse the JSON string back to an object
|
|
36
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminOrderLineItemResourceArrayResponse
|
|
37
29
|
console.log(exampleParsed)
|
|
38
30
|
```
|
|
39
31
|
|
|
@@ -37,10 +37,13 @@ Name | Type
|
|
|
37
37
|
`totalOutstanding` | number
|
|
38
38
|
`insuranceEstimate` | number
|
|
39
39
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
40
|
+
`fulfillmentStatus` | string
|
|
41
|
+
`fulfillmentsCount` | object
|
|
42
|
+
`latestFulfillment` | [OrderFulfillmentResource](OrderFulfillmentResource.md)
|
|
40
43
|
`customer` | [CustomerResource](CustomerResource.md)
|
|
41
44
|
`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
|
|
42
45
|
`status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
|
|
43
|
-
`lineItems` | [Array<
|
|
46
|
+
`lineItems` | [Array<AdminOrderLineItemResource>](AdminOrderLineItemResource.md)
|
|
44
47
|
`coupons` | [Array<CartCouponResource>](CartCouponResource.md)
|
|
45
48
|
`discounts` | [Array<DiscountResource>](DiscountResource.md)
|
|
46
49
|
`transactions` | [Array<TransactionLiteResource>](TransactionLiteResource.md)
|
|
@@ -86,6 +89,9 @@ const example = {
|
|
|
86
89
|
"totalOutstanding": null,
|
|
87
90
|
"insuranceEstimate": null,
|
|
88
91
|
"site": null,
|
|
92
|
+
"fulfillmentStatus": null,
|
|
93
|
+
"fulfillmentsCount": null,
|
|
94
|
+
"latestFulfillment": null,
|
|
89
95
|
"customer": null,
|
|
90
96
|
"admin": null,
|
|
91
97
|
"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,54 @@
|
|
|
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
|
+
`netsuiteId` | string
|
|
17
|
+
`createdAt` | Date
|
|
18
|
+
`updatedAt` | Date
|
|
19
|
+
`orderFulfillmentLineItems` | [Array<OrderFulfillmentLineItemResource>](OrderFulfillmentLineItemResource.md)
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import type { OrderFulfillmentResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
25
|
+
|
|
26
|
+
// TODO: Update the object below with actual values
|
|
27
|
+
const example = {
|
|
28
|
+
"id": null,
|
|
29
|
+
"orderId": null,
|
|
30
|
+
"dateShipped": null,
|
|
31
|
+
"trackingNumber": null,
|
|
32
|
+
"trackingUrl": null,
|
|
33
|
+
"trackingCompany": null,
|
|
34
|
+
"docnum": null,
|
|
35
|
+
"netsuiteId": null,
|
|
36
|
+
"createdAt": null,
|
|
37
|
+
"updatedAt": null,
|
|
38
|
+
"orderFulfillmentLineItems": null,
|
|
39
|
+
} satisfies OrderFulfillmentResource
|
|
40
|
+
|
|
41
|
+
console.log(example)
|
|
42
|
+
|
|
43
|
+
// Convert the instance to a JSON string
|
|
44
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
45
|
+
console.log(exampleJSON)
|
|
46
|
+
|
|
47
|
+
// Parse the JSON string back to an object
|
|
48
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderFulfillmentResource
|
|
49
|
+
console.log(exampleParsed)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
53
|
+
|
|
54
|
+
|
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,22 +1,20 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderStatusId
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<FrontendCartResource>](FrontendCartResource.md)
|
|
10
9
|
|
|
11
10
|
## Example
|
|
12
11
|
|
|
13
12
|
```typescript
|
|
14
|
-
import type {
|
|
13
|
+
import type { OrderStatusId } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
14
|
|
|
16
15
|
// TODO: Update the object below with actual values
|
|
17
16
|
const example = {
|
|
18
|
-
|
|
19
|
-
} satisfies FrontendCartResourceArrayResponse
|
|
17
|
+
} satisfies OrderStatusId
|
|
20
18
|
|
|
21
19
|
console.log(example)
|
|
22
20
|
|
|
@@ -25,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
23
|
console.log(exampleJSON)
|
|
26
24
|
|
|
27
25
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
26
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderStatusId
|
|
29
27
|
console.log(exampleParsed)
|
|
30
28
|
```
|
|
31
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 |
|
|
@@ -19,6 +20,71 @@ All URIs are relative to *http://localhost/api*
|
|
|
19
20
|
|
|
20
21
|
|
|
21
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
|
+
|
|
22
88
|
## attachCouponOrder
|
|
23
89
|
|
|
24
90
|
> AdminOrderResource attachCouponOrder(order, attachCouponRequest)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedOrderFulfillmentResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<OrderFulfillmentResource>](OrderFulfillmentResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedOrderFulfillmentResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"meta": null,
|
|
21
|
+
} satisfies PaginatedOrderFulfillmentResourceResponse
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedOrderFulfillmentResourceResponse
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -12,9 +12,6 @@ Name | Type
|
|
|
12
12
|
`model` | string
|
|
13
13
|
`modelNumber` | string
|
|
14
14
|
`name` | string
|
|
15
|
-
`parentName` | string
|
|
16
|
-
`variantName` | string
|
|
17
|
-
`slug` | string
|
|
18
15
|
`stock` | number
|
|
19
16
|
`salePrice` | number
|
|
20
17
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
@@ -33,9 +30,6 @@ const example = {
|
|
|
33
30
|
"model": null,
|
|
34
31
|
"modelNumber": null,
|
|
35
32
|
"name": null,
|
|
36
|
-
"parentName": null,
|
|
37
|
-
"variantName": null,
|
|
38
|
-
"slug": null,
|
|
39
33
|
"stock": null,
|
|
40
34
|
"salePrice": null,
|
|
41
35
|
"thumbnail": null,
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
|
|
2
|
+
# SearchOrderFulfillmentsRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`search` | string
|
|
10
|
+
`sortBy` | string
|
|
11
|
+
`sortDirection` | string
|
|
12
|
+
`perPage` | number
|
|
13
|
+
`page` | number
|
|
14
|
+
`orderId` | Array<string>
|
|
15
|
+
`beforeDateShipped` | Date
|
|
16
|
+
`afterDateShipped` | Date
|
|
17
|
+
`beforeCreatedAt` | Date
|
|
18
|
+
`afterCreatedAt` | Date
|
|
19
|
+
`relatedId` | number
|
|
20
|
+
`relatedType` | string
|
|
21
|
+
`includesRelations` | boolean
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import type { SearchOrderFulfillmentsRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
27
|
+
|
|
28
|
+
// TODO: Update the object below with actual values
|
|
29
|
+
const example = {
|
|
30
|
+
"search": null,
|
|
31
|
+
"sortBy": null,
|
|
32
|
+
"sortDirection": null,
|
|
33
|
+
"perPage": null,
|
|
34
|
+
"page": null,
|
|
35
|
+
"orderId": null,
|
|
36
|
+
"beforeDateShipped": null,
|
|
37
|
+
"afterDateShipped": null,
|
|
38
|
+
"beforeCreatedAt": null,
|
|
39
|
+
"afterCreatedAt": null,
|
|
40
|
+
"relatedId": null,
|
|
41
|
+
"relatedType": null,
|
|
42
|
+
"includesRelations": null,
|
|
43
|
+
} satisfies SearchOrderFulfillmentsRequest
|
|
44
|
+
|
|
45
|
+
console.log(example)
|
|
46
|
+
|
|
47
|
+
// Convert the instance to a JSON string
|
|
48
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
49
|
+
console.log(exampleJSON)
|
|
50
|
+
|
|
51
|
+
// Parse the JSON string back to an object
|
|
52
|
+
const exampleParsed = JSON.parse(exampleJSON) as SearchOrderFulfillmentsRequest
|
|
53
|
+
console.log(exampleParsed)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
57
|
+
|
|
58
|
+
|