@digital8/lighting-illusions-ts-sdk 0.0.1934 → 0.0.1936
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 +16 -16
- package/README.md +10 -13
- package/dist/apis/AdminApi.d.ts +0 -17
- package/dist/apis/AdminApi.js +0 -60
- package/dist/apis/OrdersApi.d.ts +2 -37
- package/dist/apis/OrdersApi.js +1 -126
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +1 -3
- package/dist/models/AddressResource.d.ts +2 -2
- package/dist/models/AddressResource.js +4 -4
- package/dist/models/AdminOrderResource.d.ts +0 -12
- package/dist/models/AdminOrderResource.js +0 -8
- package/dist/models/CartCouponLiteResource.d.ts +44 -0
- package/dist/models/CartCouponLiteResource.js +59 -0
- package/dist/models/CartCouponLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/CartCouponLiteResourceArrayResponse.js +50 -0
- package/dist/models/CartListResource.d.ts +0 -6
- package/dist/models/CartListResource.js +0 -4
- package/dist/models/CartResource.d.ts +0 -6
- package/dist/models/CartResource.js +0 -4
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +3 -1
- package/dist/models/FrontendCartResource.d.ts +144 -0
- package/dist/models/FrontendCartResource.js +121 -0
- package/dist/models/FrontendCartResourceArrayResponse.d.ts +33 -0
- package/dist/models/FrontendCartResourceArrayResponse.js +50 -0
- package/dist/models/FrontendLineItemResource.d.ts +63 -0
- package/dist/models/FrontendLineItemResource.js +70 -0
- package/dist/models/FrontendLineItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/FrontendLineItemResourceArrayResponse.js +50 -0
- package/dist/models/FrontendOrderResource.d.ts +168 -0
- package/dist/models/FrontendOrderResource.js +137 -0
- package/dist/models/FrontendOrderResourceArrayResponse.d.ts +33 -0
- package/dist/models/FrontendOrderResourceArrayResponse.js +50 -0
- package/dist/models/GetAllOrderRequest.d.ts +0 -1
- package/dist/models/GetAllOrderRequest.js +1 -2
- package/dist/models/IndexOrderRequest.d.ts +0 -1
- package/dist/models/IndexOrderRequest.js +1 -2
- package/dist/models/OrderListResource.d.ts +0 -18
- package/dist/models/OrderListResource.js +0 -10
- package/dist/models/ProductChildCartLiteResource.d.ts +6 -0
- package/dist/models/ProductChildCartLiteResource.js +4 -0
- package/dist/models/StoreCartRequest.d.ts +0 -6
- package/dist/models/StoreCartRequest.js +0 -2
- package/dist/models/StoreFrontendResource.d.ts +2 -2
- package/dist/models/StoreFrontendResource.js +2 -6
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +3 -1
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +3 -1
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +1 -3
- package/dist/models/UpdateCartRequest.d.ts +0 -6
- package/dist/models/UpdateCartRequest.js +0 -2
- package/dist/models/UpdateOrderRequest.d.ts +0 -6
- package/dist/models/UpdateOrderRequest.js +0 -2
- package/dist/models/UpdateOrderRequestBillingAddress.d.ts +7 -1
- package/dist/models/UpdateOrderRequestBillingAddress.js +5 -3
- package/dist/models/UpdateOrderRequestShippingAddress.d.ts +7 -1
- package/dist/models/UpdateOrderRequestShippingAddress.js +6 -2
- package/dist/models/index.d.ts +8 -8
- package/dist/models/index.js +8 -8
- package/docs/AdminApi.md +0 -66
- package/docs/AdminOrderResource.md +0 -4
- package/docs/{DetachCouponOrderRequest.md → CartCouponLiteResource.md} +10 -6
- package/docs/{AttachCouponOrderRequest.md → CartCouponLiteResourceArrayResponse.md} +6 -6
- package/docs/CartListResource.md +0 -2
- package/docs/CartResource.md +0 -2
- package/docs/FrontendCartResource.md +70 -0
- package/docs/{AdminNoteResourceArrayResponse.md → FrontendCartResourceArrayResponse.md} +5 -5
- package/docs/{AdminNoteResource.md → FrontendLineItemResource.md} +14 -16
- package/docs/{OrderStatusWithCountResourceArrayResponse.md → FrontendLineItemResourceArrayResponse.md} +5 -5
- package/docs/FrontendOrderResource.md +78 -0
- package/docs/{PaginatedAdminNoteResourceResponse.md → FrontendOrderResourceArrayResponse.md} +5 -7
- package/docs/OrderListResource.md +0 -6
- package/docs/OrdersApi.md +3 -141
- package/docs/ProductChildCartLiteResource.md +2 -0
- package/docs/StoreCartRequest.md +0 -2
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/UpdateCartRequest.md +0 -2
- package/docs/UpdateOrderRequest.md +0 -2
- package/docs/UpdateOrderRequestBillingAddress.md +4 -2
- package/docs/UpdateOrderRequestShippingAddress.md +4 -2
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +0 -54
- package/src/apis/OrdersApi.ts +3 -124
- package/src/models/AddressFrontendResource.ts +2 -3
- package/src/models/AddressResource.ts +5 -5
- package/src/models/AdminOrderResource.ts +0 -18
- package/src/models/CartCouponLiteResource.ts +84 -0
- package/src/models/CartCouponLiteResourceArrayResponse.ts +73 -0
- package/src/models/CartListResource.ts +0 -9
- package/src/models/CartResource.ts +0 -9
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/FrontendCartResource.ts +254 -0
- package/src/models/FrontendCartResourceArrayResponse.ts +73 -0
- package/src/models/FrontendLineItemResource.ts +118 -0
- package/src/models/FrontendLineItemResourceArrayResponse.ts +73 -0
- package/src/models/FrontendOrderResource.ts +290 -0
- package/src/models/FrontendOrderResourceArrayResponse.ts +73 -0
- package/src/models/GetAllOrderRequest.ts +1 -2
- package/src/models/IndexOrderRequest.ts +1 -2
- package/src/models/OrderListResource.ts +0 -26
- package/src/models/ProductChildCartLiteResource.ts +9 -0
- package/src/models/StoreCartRequest.ts +0 -8
- package/src/models/StoreFrontendResource.ts +4 -6
- package/src/models/StoreListResource.ts +3 -2
- package/src/models/StoreResource.ts +3 -2
- package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
- package/src/models/UpdateCartRequest.ts +0 -8
- package/src/models/UpdateOrderRequest.ts +0 -8
- package/src/models/UpdateOrderRequestBillingAddress.ts +12 -4
- package/src/models/UpdateOrderRequestShippingAddress.ts +12 -3
- package/src/models/index.ts +8 -8
- package/dist/models/AdminNoteResource.d.ts +0 -68
- package/dist/models/AdminNoteResource.js +0 -71
- package/dist/models/AdminNoteResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminNoteResourceArrayResponse.js +0 -50
- package/dist/models/AttachCouponOrderRequest.d.ts +0 -32
- package/dist/models/AttachCouponOrderRequest.js +0 -51
- package/dist/models/DetachCouponOrderRequest.d.ts +0 -32
- package/dist/models/DetachCouponOrderRequest.js +0 -51
- package/dist/models/GetAllAdminNoteRequest.d.ts +0 -102
- package/dist/models/GetAllAdminNoteRequest.js +0 -82
- package/dist/models/OrderStatusWithCountResource.d.ts +0 -50
- package/dist/models/OrderStatusWithCountResource.js +0 -63
- package/dist/models/OrderStatusWithCountResourceArrayResponse.d.ts +0 -33
- package/dist/models/OrderStatusWithCountResourceArrayResponse.js +0 -50
- package/dist/models/PaginatedAdminNoteResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedAdminNoteResourceResponse.js +0 -57
- package/docs/GetAllAdminNoteRequest.md +0 -52
- package/docs/OrderStatusWithCountResource.md +0 -40
- package/src/models/AdminNoteResource.ts +0 -118
- package/src/models/AdminNoteResourceArrayResponse.ts +0 -73
- package/src/models/AttachCouponOrderRequest.ts +0 -66
- package/src/models/DetachCouponOrderRequest.ts +0 -66
- package/src/models/GetAllAdminNoteRequest.ts +0 -157
- package/src/models/OrderStatusWithCountResource.ts +0 -93
- package/src/models/OrderStatusWithCountResourceArrayResponse.ts +0 -73
- package/src/models/PaginatedAdminNoteResourceResponse.ts +0 -90
package/docs/AdminApi.md
CHANGED
|
@@ -7,7 +7,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
7
7
|
| [**generateGoogleFeedAdmin**](AdminApi.md#generategooglefeedadmin) | **POST** /admin-api/admin/feeds/google/generate | Auto-generated: generateGoogleFeedAdmin |
|
|
8
8
|
| [**generateSocialFeedAdmin**](AdminApi.md#generatesocialfeedadmin) | **POST** /admin-api/admin/feeds/social/generate | Auto-generated: generateSocialFeedAdmin |
|
|
9
9
|
| [**generateTGNDataFeedAdmin**](AdminApi.md#generatetgndatafeedadmin) | **POST** /admin-api/admin/feeds/tgn-data/generate | Auto-generated: generateTGNDataFeedAdmin |
|
|
10
|
-
| [**getAllAdminNote**](AdminApi.md#getalladminnoteoperation) | **POST** /admin-api/admin/notes/all | Auto-generated: getAllAdminNote |
|
|
11
10
|
|
|
12
11
|
|
|
13
12
|
|
|
@@ -205,68 +204,3 @@ No authorization required
|
|
|
205
204
|
|
|
206
205
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
207
206
|
|
|
208
|
-
|
|
209
|
-
## getAllAdminNote
|
|
210
|
-
|
|
211
|
-
> AdminNoteResourceArrayResponse getAllAdminNote(getAllAdminNoteRequest)
|
|
212
|
-
|
|
213
|
-
Auto-generated: getAllAdminNote
|
|
214
|
-
|
|
215
|
-
### Example
|
|
216
|
-
|
|
217
|
-
```ts
|
|
218
|
-
import {
|
|
219
|
-
Configuration,
|
|
220
|
-
AdminApi,
|
|
221
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
222
|
-
import type { GetAllAdminNoteOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
223
|
-
|
|
224
|
-
async function example() {
|
|
225
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
226
|
-
const api = new AdminApi();
|
|
227
|
-
|
|
228
|
-
const body = {
|
|
229
|
-
// GetAllAdminNoteRequest (optional)
|
|
230
|
-
getAllAdminNoteRequest: ...,
|
|
231
|
-
} satisfies GetAllAdminNoteOperationRequest;
|
|
232
|
-
|
|
233
|
-
try {
|
|
234
|
-
const data = await api.getAllAdminNote(body);
|
|
235
|
-
console.log(data);
|
|
236
|
-
} catch (error) {
|
|
237
|
-
console.error(error);
|
|
238
|
-
}
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
// Run the test
|
|
242
|
-
example().catch(console.error);
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
### Parameters
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
| Name | Type | Description | Notes |
|
|
249
|
-
|------------- | ------------- | ------------- | -------------|
|
|
250
|
-
| **getAllAdminNoteRequest** | [GetAllAdminNoteRequest](GetAllAdminNoteRequest.md) | | [Optional] |
|
|
251
|
-
|
|
252
|
-
### Return type
|
|
253
|
-
|
|
254
|
-
[**AdminNoteResourceArrayResponse**](AdminNoteResourceArrayResponse.md)
|
|
255
|
-
|
|
256
|
-
### Authorization
|
|
257
|
-
|
|
258
|
-
No authorization required
|
|
259
|
-
|
|
260
|
-
### HTTP request headers
|
|
261
|
-
|
|
262
|
-
- **Content-Type**: `application/json`
|
|
263
|
-
- **Accept**: `application/json`
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
### HTTP response details
|
|
267
|
-
| Status code | Description | Response headers |
|
|
268
|
-
|-------------|-------------|------------------|
|
|
269
|
-
| **200** | Successful resource response | - |
|
|
270
|
-
|
|
271
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
272
|
-
|
|
@@ -17,12 +17,10 @@ Name | Type
|
|
|
17
17
|
`shippingSubtotal` | number
|
|
18
18
|
`overrideShipping` | boolean
|
|
19
19
|
`insuranceAmount` | number
|
|
20
|
-
`includeInsurance` | boolean
|
|
21
20
|
`overrideInsurance` | boolean
|
|
22
21
|
`useAsBillingAddress` | boolean
|
|
23
22
|
`netsuiteId` | string
|
|
24
23
|
`isNetsuiteLocked` | boolean
|
|
25
|
-
`isDisabled` | boolean
|
|
26
24
|
`omnisendId` | string
|
|
27
25
|
`subtotal` | number
|
|
28
26
|
`productDiscountAmount` | number
|
|
@@ -66,12 +64,10 @@ const example = {
|
|
|
66
64
|
"shippingSubtotal": null,
|
|
67
65
|
"overrideShipping": null,
|
|
68
66
|
"insuranceAmount": null,
|
|
69
|
-
"includeInsurance": null,
|
|
70
67
|
"overrideInsurance": null,
|
|
71
68
|
"useAsBillingAddress": null,
|
|
72
69
|
"netsuiteId": null,
|
|
73
70
|
"isNetsuiteLocked": null,
|
|
74
|
-
"isDisabled": null,
|
|
75
71
|
"omnisendId": null,
|
|
76
72
|
"subtotal": null,
|
|
77
73
|
"productDiscountAmount": null,
|
|
@@ -1,22 +1,26 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# CartCouponLiteResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
9
|
+
`id` | number
|
|
10
|
+
`code` | string
|
|
11
|
+
`name` | string
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
13
15
|
```typescript
|
|
14
|
-
import type {
|
|
16
|
+
import type { CartCouponLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
17
|
|
|
16
18
|
// TODO: Update the object below with actual values
|
|
17
19
|
const example = {
|
|
18
|
-
"
|
|
19
|
-
|
|
20
|
+
"id": null,
|
|
21
|
+
"code": null,
|
|
22
|
+
"name": null,
|
|
23
|
+
} satisfies CartCouponLiteResource
|
|
20
24
|
|
|
21
25
|
console.log(example)
|
|
22
26
|
|
|
@@ -25,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
29
|
console.log(exampleJSON)
|
|
26
30
|
|
|
27
31
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as CartCouponLiteResource
|
|
29
33
|
console.log(exampleParsed)
|
|
30
34
|
```
|
|
31
35
|
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# CartCouponLiteResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
9
|
+
`data` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { CartCouponLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
|
-
"
|
|
19
|
-
} satisfies
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies CartCouponLiteResourceArrayResponse
|
|
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 CartCouponLiteResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
package/docs/CartListResource.md
CHANGED
|
@@ -13,7 +13,6 @@ Name | Type
|
|
|
13
13
|
`shippingSubtotal` | number
|
|
14
14
|
`overrideShipping` | boolean
|
|
15
15
|
`insuranceAmount` | number
|
|
16
|
-
`includeInsurance` | boolean
|
|
17
16
|
`overrideInsurance` | boolean
|
|
18
17
|
`useAsBillingAddress` | boolean
|
|
19
18
|
`expiryDate` | Date
|
|
@@ -39,7 +38,6 @@ const example = {
|
|
|
39
38
|
"shippingSubtotal": null,
|
|
40
39
|
"overrideShipping": null,
|
|
41
40
|
"insuranceAmount": null,
|
|
42
|
-
"includeInsurance": null,
|
|
43
41
|
"overrideInsurance": null,
|
|
44
42
|
"useAsBillingAddress": null,
|
|
45
43
|
"expiryDate": null,
|
package/docs/CartResource.md
CHANGED
|
@@ -19,7 +19,6 @@ Name | Type
|
|
|
19
19
|
`shippingSubtotal` | number
|
|
20
20
|
`overrideShipping` | boolean
|
|
21
21
|
`insuranceSubtotal` | string
|
|
22
|
-
`includeInsurance` | boolean
|
|
23
22
|
`overrideInsurance` | boolean
|
|
24
23
|
`useAsBillingAddress` | boolean
|
|
25
24
|
`admin` | object
|
|
@@ -61,7 +60,6 @@ const example = {
|
|
|
61
60
|
"shippingSubtotal": null,
|
|
62
61
|
"overrideShipping": null,
|
|
63
62
|
"insuranceSubtotal": null,
|
|
64
|
-
"includeInsurance": null,
|
|
65
63
|
"overrideInsurance": null,
|
|
66
64
|
"useAsBillingAddress": null,
|
|
67
65
|
"admin": null,
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
|
|
2
|
+
# FrontendCartResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`lifecycleStatus` | string
|
|
11
|
+
`siteId` | number
|
|
12
|
+
`sessionToken` | string
|
|
13
|
+
`guestEmail` | string
|
|
14
|
+
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
15
|
+
`shippingType` | string
|
|
16
|
+
`shippingAddress` | [AddressResource](AddressResource.md)
|
|
17
|
+
`billingAddress` | [AddressResource](AddressResource.md)
|
|
18
|
+
`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
19
|
+
`coupons` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
|
|
20
|
+
`subtotal` | number
|
|
21
|
+
`promotionalDiscount` | number
|
|
22
|
+
`couponSubtotalDiscount` | number
|
|
23
|
+
`couponShippingDiscount` | number
|
|
24
|
+
`shipping` | number
|
|
25
|
+
`transitInsurance` | number
|
|
26
|
+
`gst` | number
|
|
27
|
+
`grandTotal` | number
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import type { FrontendCartResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
33
|
+
|
|
34
|
+
// TODO: Update the object below with actual values
|
|
35
|
+
const example = {
|
|
36
|
+
"id": null,
|
|
37
|
+
"lifecycleStatus": null,
|
|
38
|
+
"siteId": null,
|
|
39
|
+
"sessionToken": null,
|
|
40
|
+
"guestEmail": null,
|
|
41
|
+
"customer": null,
|
|
42
|
+
"shippingType": null,
|
|
43
|
+
"shippingAddress": null,
|
|
44
|
+
"billingAddress": null,
|
|
45
|
+
"lineItems": null,
|
|
46
|
+
"coupons": null,
|
|
47
|
+
"subtotal": null,
|
|
48
|
+
"promotionalDiscount": null,
|
|
49
|
+
"couponSubtotalDiscount": null,
|
|
50
|
+
"couponShippingDiscount": null,
|
|
51
|
+
"shipping": null,
|
|
52
|
+
"transitInsurance": null,
|
|
53
|
+
"gst": null,
|
|
54
|
+
"grandTotal": null,
|
|
55
|
+
} satisfies FrontendCartResource
|
|
56
|
+
|
|
57
|
+
console.log(example)
|
|
58
|
+
|
|
59
|
+
// Convert the instance to a JSON string
|
|
60
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
61
|
+
console.log(exampleJSON)
|
|
62
|
+
|
|
63
|
+
// Parse the JSON string back to an object
|
|
64
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendCartResource
|
|
65
|
+
console.log(exampleParsed)
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
69
|
+
|
|
70
|
+
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FrontendCartResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<FrontendCartResource>](FrontendCartResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { FrontendCartResourceArrayResponse } 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 FrontendCartResourceArrayResponse
|
|
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 FrontendCartResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FrontendLineItemResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -7,28 +7,26 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
11
|
-
`
|
|
12
|
-
`
|
|
13
|
-
`
|
|
14
|
-
`
|
|
15
|
-
`admin` | Array<number>
|
|
10
|
+
`quantity` | number
|
|
11
|
+
`productPrice` | number
|
|
12
|
+
`subtotalAmount` | number
|
|
13
|
+
`totalAmount` | number
|
|
14
|
+
`productChild` | [ProductChildCartLiteResource](ProductChildCartLiteResource.md)
|
|
16
15
|
|
|
17
16
|
## Example
|
|
18
17
|
|
|
19
18
|
```typescript
|
|
20
|
-
import type {
|
|
19
|
+
import type { FrontendLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
21
20
|
|
|
22
21
|
// TODO: Update the object below with actual values
|
|
23
22
|
const example = {
|
|
24
23
|
"id": null,
|
|
25
|
-
"
|
|
26
|
-
"
|
|
27
|
-
"
|
|
28
|
-
"
|
|
29
|
-
"
|
|
30
|
-
|
|
31
|
-
} satisfies AdminNoteResource
|
|
24
|
+
"quantity": null,
|
|
25
|
+
"productPrice": null,
|
|
26
|
+
"subtotalAmount": null,
|
|
27
|
+
"totalAmount": null,
|
|
28
|
+
"productChild": null,
|
|
29
|
+
} satisfies FrontendLineItemResource
|
|
32
30
|
|
|
33
31
|
console.log(example)
|
|
34
32
|
|
|
@@ -37,7 +35,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
37
35
|
console.log(exampleJSON)
|
|
38
36
|
|
|
39
37
|
// Parse the JSON string back to an object
|
|
40
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendLineItemResource
|
|
41
39
|
console.log(exampleParsed)
|
|
42
40
|
```
|
|
43
41
|
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FrontendLineItemResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { FrontendLineItemResourceArrayResponse } 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 FrontendLineItemResourceArrayResponse
|
|
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 FrontendLineItemResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
|
|
2
|
+
# FrontendOrderResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`cartId` | number
|
|
11
|
+
`siteId` | number
|
|
12
|
+
`placedAt` | Date
|
|
13
|
+
`source` | string
|
|
14
|
+
`paymentToken` | string
|
|
15
|
+
`shippingType` | string
|
|
16
|
+
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
17
|
+
`status` | Array<number>
|
|
18
|
+
`shippingAddress` | [AddressResource](AddressResource.md)
|
|
19
|
+
`billingAddress` | [AddressResource](AddressResource.md)
|
|
20
|
+
`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
21
|
+
`coupons` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
|
|
22
|
+
`subtotal` | number
|
|
23
|
+
`promotionalDiscount` | number
|
|
24
|
+
`couponSubtotalDiscount` | number
|
|
25
|
+
`couponShippingDiscount` | number
|
|
26
|
+
`shipping` | number
|
|
27
|
+
`transitInsurance` | number
|
|
28
|
+
`gst` | number
|
|
29
|
+
`grandTotal` | number
|
|
30
|
+
`amountPaid` | number
|
|
31
|
+
`amountDue` | number
|
|
32
|
+
|
|
33
|
+
## Example
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import type { FrontendOrderResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
37
|
+
|
|
38
|
+
// TODO: Update the object below with actual values
|
|
39
|
+
const example = {
|
|
40
|
+
"id": null,
|
|
41
|
+
"cartId": null,
|
|
42
|
+
"siteId": null,
|
|
43
|
+
"placedAt": null,
|
|
44
|
+
"source": null,
|
|
45
|
+
"paymentToken": null,
|
|
46
|
+
"shippingType": null,
|
|
47
|
+
"customer": null,
|
|
48
|
+
"status": null,
|
|
49
|
+
"shippingAddress": null,
|
|
50
|
+
"billingAddress": null,
|
|
51
|
+
"lineItems": null,
|
|
52
|
+
"coupons": null,
|
|
53
|
+
"subtotal": null,
|
|
54
|
+
"promotionalDiscount": null,
|
|
55
|
+
"couponSubtotalDiscount": null,
|
|
56
|
+
"couponShippingDiscount": null,
|
|
57
|
+
"shipping": null,
|
|
58
|
+
"transitInsurance": null,
|
|
59
|
+
"gst": null,
|
|
60
|
+
"grandTotal": null,
|
|
61
|
+
"amountPaid": null,
|
|
62
|
+
"amountDue": null,
|
|
63
|
+
} satisfies FrontendOrderResource
|
|
64
|
+
|
|
65
|
+
console.log(example)
|
|
66
|
+
|
|
67
|
+
// Convert the instance to a JSON string
|
|
68
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
69
|
+
console.log(exampleJSON)
|
|
70
|
+
|
|
71
|
+
// Parse the JSON string back to an object
|
|
72
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendOrderResource
|
|
73
|
+
console.log(exampleParsed)
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
77
|
+
|
|
78
|
+
|
package/docs/{PaginatedAdminNoteResourceResponse.md → FrontendOrderResourceArrayResponse.md}
RENAMED
|
@@ -1,24 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FrontendOrderResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
10
|
-
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
9
|
+
`data` | [Array<FrontendOrderResource>](FrontendOrderResource.md)
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
14
13
|
```typescript
|
|
15
|
-
import type {
|
|
14
|
+
import type { FrontendOrderResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
15
|
|
|
17
16
|
// TODO: Update the object below with actual values
|
|
18
17
|
const example = {
|
|
19
18
|
"data": null,
|
|
20
|
-
|
|
21
|
-
} satisfies PaginatedAdminNoteResourceResponse
|
|
19
|
+
} satisfies FrontendOrderResourceArrayResponse
|
|
22
20
|
|
|
23
21
|
console.log(example)
|
|
24
22
|
|
|
@@ -27,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
27
25
|
console.log(exampleJSON)
|
|
28
26
|
|
|
29
27
|
// Parse the JSON string back to an object
|
|
30
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendOrderResourceArrayResponse
|
|
31
29
|
console.log(exampleParsed)
|
|
32
30
|
```
|
|
33
31
|
|
|
@@ -11,9 +11,6 @@ Name | Type
|
|
|
11
11
|
`placedAt` | Date
|
|
12
12
|
`createdAt` | Date
|
|
13
13
|
`updatedAt` | Date
|
|
14
|
-
`source` | string
|
|
15
|
-
`netsuiteId` | string
|
|
16
|
-
`isNetsuiteLocked` | boolean
|
|
17
14
|
`subtotal` | number
|
|
18
15
|
`finalTotalAmount` | number
|
|
19
16
|
`cartStatusContext` | object
|
|
@@ -34,9 +31,6 @@ const example = {
|
|
|
34
31
|
"placedAt": null,
|
|
35
32
|
"createdAt": null,
|
|
36
33
|
"updatedAt": null,
|
|
37
|
-
"source": null,
|
|
38
|
-
"netsuiteId": null,
|
|
39
|
-
"isNetsuiteLocked": null,
|
|
40
34
|
"subtotal": null,
|
|
41
35
|
"finalTotalAmount": null,
|
|
42
36
|
"cartStatusContext": null,
|