@digital8/lighting-illusions-ts-sdk 0.0.1933 → 0.0.1935
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 -8
- package/README.md +10 -7
- package/dist/apis/AdminApi.d.ts +0 -17
- package/dist/apis/AdminApi.js +0 -60
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +1 -3
- package/dist/models/AddressResource.d.ts +7 -1
- package/dist/models/AddressResource.js +7 -1
- package/dist/models/AdminOrderResource.d.ts +4 -4
- package/dist/models/AdminOrderResource.js +7 -7
- 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/CartResource.d.ts +9 -3
- package/dist/models/CartResource.js +9 -7
- 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/ProductChildCartLiteResource.d.ts +6 -0
- package/dist/models/ProductChildCartLiteResource.js +4 -0
- package/dist/models/StoreCartRequestShippingAddress.d.ts +6 -0
- package/dist/models/StoreCartRequestShippingAddress.js +2 -0
- package/dist/models/StoreFrontendResource.d.ts +2 -2
- package/dist/models/StoreFrontendResource.js +6 -2
- 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 +1 -3
- package/dist/models/StoreStoreRequestAddress.d.ts +6 -0
- package/dist/models/StoreStoreRequestAddress.js +2 -0
- package/dist/models/index.d.ts +8 -4
- package/dist/models/index.js +8 -4
- package/docs/AddressResource.md +2 -0
- package/docs/AdminApi.md +0 -66
- package/docs/AdminOrderResource.md +3 -3
- package/docs/{AdminNoteResource.md → CartCouponLiteResource.md} +8 -16
- package/docs/CartCouponLiteResourceArrayResponse.md +34 -0
- package/docs/CartResource.md +6 -4
- package/docs/FrontendCartResource.md +70 -0
- package/docs/{AdminNoteResourceArrayResponse.md → FrontendCartResourceArrayResponse.md} +5 -5
- package/docs/FrontendLineItemResource.md +44 -0
- package/docs/FrontendLineItemResourceArrayResponse.md +34 -0
- package/docs/FrontendOrderResource.md +78 -0
- package/docs/{PaginatedAdminNoteResourceResponse.md → FrontendOrderResourceArrayResponse.md} +5 -7
- package/docs/ProductChildCartLiteResource.md +2 -0
- package/docs/StoreCartRequestShippingAddress.md +2 -0
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/StoreStoreRequestAddress.md +2 -0
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +0 -54
- package/src/models/AddressFrontendResource.ts +2 -3
- package/src/models/AddressResource.ts +12 -2
- package/src/models/AdminOrderResource.ts +10 -10
- package/src/models/CartCouponLiteResource.ts +84 -0
- package/src/models/CartCouponLiteResourceArrayResponse.ts +73 -0
- package/src/models/CartResource.ts +17 -9
- 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/ProductChildCartLiteResource.ts +9 -0
- package/src/models/StoreCartRequestShippingAddress.ts +8 -0
- package/src/models/StoreFrontendResource.ts +6 -4
- package/src/models/StoreListResource.ts +6 -4
- package/src/models/StoreResource.ts +2 -3
- package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
- package/src/models/StoreStoreRequestAddress.ts +8 -0
- package/src/models/index.ts +8 -4
- 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/GetAllAdminNoteRequest.d.ts +0 -102
- package/dist/models/GetAllAdminNoteRequest.js +0 -82
- package/dist/models/PaginatedAdminNoteResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedAdminNoteResourceResponse.js +0 -57
- package/docs/GetAllAdminNoteRequest.md +0 -52
- package/src/models/AdminNoteResource.ts +0 -118
- package/src/models/AdminNoteResourceArrayResponse.ts +0 -73
- package/src/models/GetAllAdminNoteRequest.ts +0 -157
- package/src/models/PaginatedAdminNoteResourceResponse.ts +0 -90
package/dist/models/index.d.ts
CHANGED
|
@@ -3,8 +3,6 @@ export * from './AddressFrontendResourceArrayResponse';
|
|
|
3
3
|
export * from './AddressResource';
|
|
4
4
|
export * from './AddressResourceArrayResponse';
|
|
5
5
|
export * from './AddressType';
|
|
6
|
-
export * from './AdminNoteResource';
|
|
7
|
-
export * from './AdminNoteResourceArrayResponse';
|
|
8
6
|
export * from './AdminOrderResource';
|
|
9
7
|
export * from './AdminOrderResourceArrayResponse';
|
|
10
8
|
export * from './AssetFileForUploadResource';
|
|
@@ -47,6 +45,8 @@ export * from './AttributeResourceArrayResponse';
|
|
|
47
45
|
export * from './AttributeType';
|
|
48
46
|
export * from './AttributeValueResource';
|
|
49
47
|
export * from './AttributeValueResourceArrayResponse';
|
|
48
|
+
export * from './CartCouponLiteResource';
|
|
49
|
+
export * from './CartCouponLiteResourceArrayResponse';
|
|
50
50
|
export * from './CartCouponResource';
|
|
51
51
|
export * from './CartCouponResourceArrayResponse';
|
|
52
52
|
export * from './CartListResource';
|
|
@@ -103,8 +103,13 @@ export * from './ExternalApiLogResource';
|
|
|
103
103
|
export * from './ExternalApiLogResourceArrayResponse';
|
|
104
104
|
export * from './ExternalApiProvider';
|
|
105
105
|
export * from './ExternalApiSyncStatus';
|
|
106
|
+
export * from './FrontendCartResource';
|
|
107
|
+
export * from './FrontendCartResourceArrayResponse';
|
|
108
|
+
export * from './FrontendLineItemResource';
|
|
109
|
+
export * from './FrontendLineItemResourceArrayResponse';
|
|
110
|
+
export * from './FrontendOrderResource';
|
|
111
|
+
export * from './FrontendOrderResourceArrayResponse';
|
|
106
112
|
export * from './GenericResponse';
|
|
107
|
-
export * from './GetAllAdminNoteRequest';
|
|
108
113
|
export * from './GetAllAttributeRequest';
|
|
109
114
|
export * from './GetAllAttributeValueRequest';
|
|
110
115
|
export * from './GetAllDefinitionRequest';
|
|
@@ -207,7 +212,6 @@ export * from './OverlayTemplateLiteResource';
|
|
|
207
212
|
export * from './OverlayTemplateLiteResourceArrayResponse';
|
|
208
213
|
export * from './OverlayTemplateResource';
|
|
209
214
|
export * from './OverlayTemplateResourceArrayResponse';
|
|
210
|
-
export * from './PaginatedAdminNoteResourceResponse';
|
|
211
215
|
export * from './PaginatedAttributeListResourceResponse';
|
|
212
216
|
export * from './PaginatedAttributeLiteResourceResponse';
|
|
213
217
|
export * from './PaginatedAttributeProductTypeRelationResourceResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -21,8 +21,6 @@ __exportStar(require("./AddressFrontendResourceArrayResponse"), exports);
|
|
|
21
21
|
__exportStar(require("./AddressResource"), exports);
|
|
22
22
|
__exportStar(require("./AddressResourceArrayResponse"), exports);
|
|
23
23
|
__exportStar(require("./AddressType"), exports);
|
|
24
|
-
__exportStar(require("./AdminNoteResource"), exports);
|
|
25
|
-
__exportStar(require("./AdminNoteResourceArrayResponse"), exports);
|
|
26
24
|
__exportStar(require("./AdminOrderResource"), exports);
|
|
27
25
|
__exportStar(require("./AdminOrderResourceArrayResponse"), exports);
|
|
28
26
|
__exportStar(require("./AssetFileForUploadResource"), exports);
|
|
@@ -65,6 +63,8 @@ __exportStar(require("./AttributeResourceArrayResponse"), exports);
|
|
|
65
63
|
__exportStar(require("./AttributeType"), exports);
|
|
66
64
|
__exportStar(require("./AttributeValueResource"), exports);
|
|
67
65
|
__exportStar(require("./AttributeValueResourceArrayResponse"), exports);
|
|
66
|
+
__exportStar(require("./CartCouponLiteResource"), exports);
|
|
67
|
+
__exportStar(require("./CartCouponLiteResourceArrayResponse"), exports);
|
|
68
68
|
__exportStar(require("./CartCouponResource"), exports);
|
|
69
69
|
__exportStar(require("./CartCouponResourceArrayResponse"), exports);
|
|
70
70
|
__exportStar(require("./CartListResource"), exports);
|
|
@@ -121,8 +121,13 @@ __exportStar(require("./ExternalApiLogResource"), exports);
|
|
|
121
121
|
__exportStar(require("./ExternalApiLogResourceArrayResponse"), exports);
|
|
122
122
|
__exportStar(require("./ExternalApiProvider"), exports);
|
|
123
123
|
__exportStar(require("./ExternalApiSyncStatus"), exports);
|
|
124
|
+
__exportStar(require("./FrontendCartResource"), exports);
|
|
125
|
+
__exportStar(require("./FrontendCartResourceArrayResponse"), exports);
|
|
126
|
+
__exportStar(require("./FrontendLineItemResource"), exports);
|
|
127
|
+
__exportStar(require("./FrontendLineItemResourceArrayResponse"), exports);
|
|
128
|
+
__exportStar(require("./FrontendOrderResource"), exports);
|
|
129
|
+
__exportStar(require("./FrontendOrderResourceArrayResponse"), exports);
|
|
124
130
|
__exportStar(require("./GenericResponse"), exports);
|
|
125
|
-
__exportStar(require("./GetAllAdminNoteRequest"), exports);
|
|
126
131
|
__exportStar(require("./GetAllAttributeRequest"), exports);
|
|
127
132
|
__exportStar(require("./GetAllAttributeValueRequest"), exports);
|
|
128
133
|
__exportStar(require("./GetAllDefinitionRequest"), exports);
|
|
@@ -225,7 +230,6 @@ __exportStar(require("./OverlayTemplateLiteResource"), exports);
|
|
|
225
230
|
__exportStar(require("./OverlayTemplateLiteResourceArrayResponse"), exports);
|
|
226
231
|
__exportStar(require("./OverlayTemplateResource"), exports);
|
|
227
232
|
__exportStar(require("./OverlayTemplateResourceArrayResponse"), exports);
|
|
228
|
-
__exportStar(require("./PaginatedAdminNoteResourceResponse"), exports);
|
|
229
233
|
__exportStar(require("./PaginatedAttributeListResourceResponse"), exports);
|
|
230
234
|
__exportStar(require("./PaginatedAttributeLiteResourceResponse"), exports);
|
|
231
235
|
__exportStar(require("./PaginatedAttributeProductTypeRelationResourceResponse"), exports);
|
package/docs/AddressResource.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
10
|
`sourceAddressId` | number
|
|
11
|
+
`addresseeName` | string
|
|
11
12
|
`company` | string
|
|
12
13
|
`addressee` | string
|
|
13
14
|
`line1` | string
|
|
@@ -27,6 +28,7 @@ import type { AddressResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
27
28
|
const example = {
|
|
28
29
|
"id": null,
|
|
29
30
|
"sourceAddressId": null,
|
|
31
|
+
"addresseeName": null,
|
|
30
32
|
"company": null,
|
|
31
33
|
"addressee": null,
|
|
32
34
|
"line1": null,
|
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
|
-
|
|
@@ -24,7 +24,7 @@ Name | Type
|
|
|
24
24
|
`omnisendId` | string
|
|
25
25
|
`subtotal` | number
|
|
26
26
|
`productDiscountAmount` | number
|
|
27
|
-
`
|
|
27
|
+
`subtotalDiscountAmount` | number
|
|
28
28
|
`shippingDiscountAmount` | number
|
|
29
29
|
`shippingAmount` | number
|
|
30
30
|
`total` | number
|
|
@@ -44,7 +44,7 @@ Name | Type
|
|
|
44
44
|
`coupons` | object
|
|
45
45
|
`shippingAddress` | object
|
|
46
46
|
`billingAddress` | object
|
|
47
|
-
`omnisendSync` |
|
|
47
|
+
`omnisendSync` | string
|
|
48
48
|
|
|
49
49
|
## Example
|
|
50
50
|
|
|
@@ -71,7 +71,7 @@ const example = {
|
|
|
71
71
|
"omnisendId": null,
|
|
72
72
|
"subtotal": null,
|
|
73
73
|
"productDiscountAmount": null,
|
|
74
|
-
"
|
|
74
|
+
"subtotalDiscountAmount": null,
|
|
75
75
|
"shippingDiscountAmount": null,
|
|
76
76
|
"shippingAmount": null,
|
|
77
77
|
"total": null,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# CartCouponLiteResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -7,28 +7,20 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
11
|
-
`
|
|
12
|
-
`note` | string
|
|
13
|
-
`createdAt` | Date
|
|
14
|
-
`updatedAt` | Date
|
|
15
|
-
`admin` | Array<number>
|
|
10
|
+
`code` | string
|
|
11
|
+
`name` | string
|
|
16
12
|
|
|
17
13
|
## Example
|
|
18
14
|
|
|
19
15
|
```typescript
|
|
20
|
-
import type {
|
|
16
|
+
import type { CartCouponLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
21
17
|
|
|
22
18
|
// TODO: Update the object below with actual values
|
|
23
19
|
const example = {
|
|
24
20
|
"id": null,
|
|
25
|
-
"
|
|
26
|
-
"
|
|
27
|
-
|
|
28
|
-
"createdAt": null,
|
|
29
|
-
"updatedAt": null,
|
|
30
|
-
"admin": null,
|
|
31
|
-
} satisfies AdminNoteResource
|
|
21
|
+
"code": null,
|
|
22
|
+
"name": null,
|
|
23
|
+
} satisfies CartCouponLiteResource
|
|
32
24
|
|
|
33
25
|
console.log(example)
|
|
34
26
|
|
|
@@ -37,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
37
29
|
console.log(exampleJSON)
|
|
38
30
|
|
|
39
31
|
// Parse the JSON string back to an object
|
|
40
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as CartCouponLiteResource
|
|
41
33
|
console.log(exampleParsed)
|
|
42
34
|
```
|
|
43
35
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# CartCouponLiteResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { CartCouponLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies CartCouponLiteResourceArrayResponse
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as CartCouponLiteResourceArrayResponse
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
package/docs/CartResource.md
CHANGED
|
@@ -18,7 +18,7 @@ Name | Type
|
|
|
18
18
|
`shippingType` | string
|
|
19
19
|
`shippingSubtotal` | number
|
|
20
20
|
`overrideShipping` | boolean
|
|
21
|
-
`
|
|
21
|
+
`insuranceSubtotal` | string
|
|
22
22
|
`overrideInsurance` | boolean
|
|
23
23
|
`useAsBillingAddress` | boolean
|
|
24
24
|
`admin` | object
|
|
@@ -31,11 +31,12 @@ Name | Type
|
|
|
31
31
|
`discountPreview` | number
|
|
32
32
|
`subtotal` | number
|
|
33
33
|
`shippingAmount` | number
|
|
34
|
+
`insuranceAmount` | number
|
|
34
35
|
`total` | number
|
|
35
36
|
`discountAmount` | number
|
|
36
37
|
`productDiscountAmount` | number
|
|
37
38
|
`shippingDiscountAmount` | number
|
|
38
|
-
`
|
|
39
|
+
`subtotalDiscountAmount` | number
|
|
39
40
|
`finalTotalAmount` | number
|
|
40
41
|
`status` | string
|
|
41
42
|
|
|
@@ -58,7 +59,7 @@ const example = {
|
|
|
58
59
|
"shippingType": null,
|
|
59
60
|
"shippingSubtotal": null,
|
|
60
61
|
"overrideShipping": null,
|
|
61
|
-
"
|
|
62
|
+
"insuranceSubtotal": null,
|
|
62
63
|
"overrideInsurance": null,
|
|
63
64
|
"useAsBillingAddress": null,
|
|
64
65
|
"admin": null,
|
|
@@ -71,11 +72,12 @@ const example = {
|
|
|
71
72
|
"discountPreview": null,
|
|
72
73
|
"subtotal": null,
|
|
73
74
|
"shippingAmount": null,
|
|
75
|
+
"insuranceAmount": null,
|
|
74
76
|
"total": null,
|
|
75
77
|
"discountAmount": null,
|
|
76
78
|
"productDiscountAmount": null,
|
|
77
79
|
"shippingDiscountAmount": null,
|
|
78
|
-
"
|
|
80
|
+
"subtotalDiscountAmount": null,
|
|
79
81
|
"finalTotalAmount": null,
|
|
80
82
|
"status": null,
|
|
81
83
|
} satisfies CartResource
|
|
@@ -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
|
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# FrontendLineItemResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`quantity` | number
|
|
11
|
+
`productPrice` | number
|
|
12
|
+
`subtotalAmount` | number
|
|
13
|
+
`totalAmount` | number
|
|
14
|
+
`productChild` | [ProductChildCartLiteResource](ProductChildCartLiteResource.md)
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { FrontendLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"id": null,
|
|
24
|
+
"quantity": null,
|
|
25
|
+
"productPrice": null,
|
|
26
|
+
"subtotalAmount": null,
|
|
27
|
+
"totalAmount": null,
|
|
28
|
+
"productChild": null,
|
|
29
|
+
} satisfies FrontendLineItemResource
|
|
30
|
+
|
|
31
|
+
console.log(example)
|
|
32
|
+
|
|
33
|
+
// Convert the instance to a JSON string
|
|
34
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
35
|
+
console.log(exampleJSON)
|
|
36
|
+
|
|
37
|
+
// Parse the JSON string back to an object
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendLineItemResource
|
|
39
|
+
console.log(exampleParsed)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
43
|
+
|
|
44
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# FrontendLineItemResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { FrontendLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies FrontendLineItemResourceArrayResponse
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendLineItemResourceArrayResponse
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -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
|
|
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`model` | string
|
|
13
13
|
`modelNumber` | string
|
|
14
14
|
`name` | string
|
|
15
|
+
`slug` | string
|
|
15
16
|
`stock` | number
|
|
16
17
|
`salePrice` | number
|
|
17
18
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
@@ -30,6 +31,7 @@ const example = {
|
|
|
30
31
|
"model": null,
|
|
31
32
|
"modelNumber": null,
|
|
32
33
|
"name": null,
|
|
34
|
+
"slug": null,
|
|
33
35
|
"stock": null,
|
|
34
36
|
"salePrice": null,
|
|
35
37
|
"thumbnail": null,
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`addresseeName` | string
|
|
9
10
|
`company` | string
|
|
10
11
|
`addressee` | string
|
|
11
12
|
`line1` | string
|
|
@@ -22,6 +23,7 @@ import type { StoreCartRequestShippingAddress } from '@digital8/lighting-illusio
|
|
|
22
23
|
|
|
23
24
|
// TODO: Update the object below with actual values
|
|
24
25
|
const example = {
|
|
26
|
+
"addresseeName": null,
|
|
25
27
|
"company": null,
|
|
26
28
|
"addressee": null,
|
|
27
29
|
"line1": null,
|