@digital8/lighting-illusions-ts-sdk 0.0.2178 → 0.0.2180
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 -0
- package/README.md +12 -2
- package/dist/apis/OrdersApi.d.ts +15 -0
- package/dist/apis/OrdersApi.js +59 -0
- 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/CartCouponLiteResource.d.ts +56 -0
- package/dist/models/CartCouponLiteResource.js +67 -0
- package/dist/models/CartCouponLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/CartCouponLiteResourceArrayResponse.js +50 -0
- package/dist/models/CreateCartRequest.d.ts +1 -0
- package/dist/models/CreateCartRequest.js +1 -0
- 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/FrontendCartResourceCouponsInner.d.ts +56 -0
- package/dist/models/FrontendCartResourceCouponsInner.js +57 -0
- package/dist/models/FrontendLineItemResource.d.ts +81 -0
- package/dist/models/FrontendLineItemResource.js +82 -0
- package/dist/models/FrontendLineItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/FrontendLineItemResourceArrayResponse.js +50 -0
- package/dist/models/FrontendOrderResource.d.ts +174 -0
- package/dist/models/FrontendOrderResource.js +141 -0
- package/dist/models/FrontendOrderResourceArrayResponse.d.ts +33 -0
- package/dist/models/FrontendOrderResourceArrayResponse.js +50 -0
- package/dist/models/OrderFulfillmentResource.d.ts +1 -1
- package/dist/models/OrderFulfillmentResource.js +1 -3
- package/dist/models/OrderStatusId.d.ts +2 -6
- package/dist/models/OrderStatusId.js +2 -6
- package/dist/models/PaymentSource.d.ts +1 -0
- package/dist/models/PaymentSource.js +2 -1
- package/dist/models/ProductChildLineItemLiteResource.d.ts +18 -0
- package/dist/models/ProductChildLineItemLiteResource.js +12 -0
- package/dist/models/ProductChildResource.d.ts +6 -0
- package/dist/models/ProductChildResource.js +4 -0
- package/dist/models/ShippingType.d.ts +1 -0
- package/dist/models/ShippingType.js +1 -0
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +3 -1
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +1 -3
- package/dist/models/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +1 -3
- package/dist/models/UpdateCartRequest.d.ts +1 -0
- package/dist/models/UpdateCartRequest.js +1 -0
- package/dist/models/UpdateOrderRequest.d.ts +1 -0
- package/dist/models/UpdateOrderRequest.js +1 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/docs/CartCouponLiteResource.md +42 -0
- package/docs/CartCouponLiteResourceArrayResponse.md +34 -0
- package/docs/FrontendCartResource.md +70 -0
- package/docs/FrontendCartResourceArrayResponse.md +34 -0
- package/docs/FrontendCartResourceCouponsInner.md +42 -0
- package/docs/FrontendLineItemResource.md +50 -0
- package/docs/FrontendLineItemResourceArrayResponse.md +34 -0
- package/docs/FrontendOrderResource.md +80 -0
- package/docs/FrontendOrderResourceArrayResponse.md +34 -0
- package/docs/OrdersApi.md +66 -0
- package/docs/ProductChildLineItemLiteResource.md +6 -0
- package/docs/ProductChildResource.md +2 -0
- package/docs/StoreSpecialDateResource.md +1 -1
- package/package.json +1 -1
- package/src/apis/OrdersApi.ts +49 -0
- package/src/models/AddressFrontendResource.ts +2 -3
- package/src/models/AddressResource.ts +5 -5
- package/src/models/CartCouponLiteResource.ts +102 -0
- package/src/models/CartCouponLiteResourceArrayResponse.ts +73 -0
- package/src/models/CreateCartRequest.ts +1 -0
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/FrontendCartResource.ts +254 -0
- package/src/models/FrontendCartResourceArrayResponse.ts +73 -0
- package/src/models/FrontendCartResourceCouponsInner.ts +97 -0
- package/src/models/FrontendLineItemResource.ts +145 -0
- package/src/models/FrontendLineItemResourceArrayResponse.ts +73 -0
- package/src/models/FrontendOrderResource.ts +299 -0
- package/src/models/FrontendOrderResourceArrayResponse.ts +73 -0
- package/src/models/OrderFulfillmentResource.ts +2 -3
- package/src/models/OrderStatusId.ts +2 -6
- package/src/models/PaymentSource.ts +2 -1
- package/src/models/ProductChildLineItemLiteResource.ts +27 -0
- package/src/models/ProductChildResource.ts +9 -0
- package/src/models/ShippingType.ts +1 -0
- package/src/models/StoreFrontendResource.ts +3 -2
- package/src/models/StoreListResource.ts +2 -3
- package/src/models/StoreSpecialDateResource.ts +3 -4
- package/src/models/UpdateCartRequest.ts +1 -0
- package/src/models/UpdateOrderRequest.ts +1 -0
- package/src/models/index.ts +9 -0
|
@@ -26,8 +26,6 @@ function instanceOfStoreSpecialDateResource(value) {
|
|
|
26
26
|
return false;
|
|
27
27
|
if (!('hours' in value) || value['hours'] === undefined)
|
|
28
28
|
return false;
|
|
29
|
-
if (!('date' in value) || value['date'] === undefined)
|
|
30
|
-
return false;
|
|
31
29
|
if (!('closed' in value) || value['closed'] === undefined)
|
|
32
30
|
return false;
|
|
33
31
|
if (!('displayStartDate' in value) || value['displayStartDate'] === undefined)
|
|
@@ -47,7 +45,7 @@ function StoreSpecialDateResourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
45
|
'id': json['id'] == null ? undefined : json['id'],
|
|
48
46
|
'name': json['name'],
|
|
49
47
|
'hours': json['hours'],
|
|
50
|
-
'date': json['date'],
|
|
48
|
+
'date': json['date'] == null ? undefined : json['date'],
|
|
51
49
|
'closed': json['closed'],
|
|
52
50
|
'displayStartDate': json['displayStartDate'],
|
|
53
51
|
'displayEndDate': json['displayEndDate'],
|
|
@@ -133,6 +133,7 @@ export type UpdateCartRequestSourceEnum = typeof UpdateCartRequestSourceEnum[key
|
|
|
133
133
|
export declare const UpdateCartRequestShippingTypeEnum: {
|
|
134
134
|
readonly Pickup: "pickup";
|
|
135
135
|
readonly Delivery: "delivery";
|
|
136
|
+
readonly AuspostStandard: "auspost_standard";
|
|
136
137
|
readonly Express: "express";
|
|
137
138
|
readonly Courier: "courier";
|
|
138
139
|
readonly DontShip: "dont_ship";
|
|
@@ -115,6 +115,7 @@ export type UpdateOrderRequestSourceEnum = typeof UpdateOrderRequestSourceEnum[k
|
|
|
115
115
|
export declare const UpdateOrderRequestShippingTypeEnum: {
|
|
116
116
|
readonly Pickup: "pickup";
|
|
117
117
|
readonly Delivery: "delivery";
|
|
118
|
+
readonly AuspostStandard: "auspost_standard";
|
|
118
119
|
readonly Express: "express";
|
|
119
120
|
readonly Courier: "courier";
|
|
120
121
|
readonly DontShip: "dont_ship";
|
package/dist/models/index.d.ts
CHANGED
|
@@ -59,6 +59,8 @@ export * from './BlogFrontendResource';
|
|
|
59
59
|
export * from './BlogFrontendResourceArrayResponse';
|
|
60
60
|
export * from './BlogResource';
|
|
61
61
|
export * from './BlogResourceArrayResponse';
|
|
62
|
+
export * from './CartCouponLiteResource';
|
|
63
|
+
export * from './CartCouponLiteResourceArrayResponse';
|
|
62
64
|
export * from './CartCouponResource';
|
|
63
65
|
export * from './CartCouponResourceArrayResponse';
|
|
64
66
|
export * from './CartListResource';
|
|
@@ -173,10 +175,17 @@ export * from './ExternalApiLogResource';
|
|
|
173
175
|
export * from './ExternalApiLogResourceArrayResponse';
|
|
174
176
|
export * from './ExternalApiProvider';
|
|
175
177
|
export * from './ExternalApiSyncStatus';
|
|
178
|
+
export * from './FrontendCartResource';
|
|
179
|
+
export * from './FrontendCartResourceArrayResponse';
|
|
180
|
+
export * from './FrontendCartResourceCouponsInner';
|
|
176
181
|
export * from './FrontendComponentLiteResource';
|
|
177
182
|
export * from './FrontendComponentLiteResourceArrayResponse';
|
|
178
183
|
export * from './FrontendComponentResource';
|
|
179
184
|
export * from './FrontendComponentResourceArrayResponse';
|
|
185
|
+
export * from './FrontendLineItemResource';
|
|
186
|
+
export * from './FrontendLineItemResourceArrayResponse';
|
|
187
|
+
export * from './FrontendOrderResource';
|
|
188
|
+
export * from './FrontendOrderResourceArrayResponse';
|
|
180
189
|
export * from './GenericResponse';
|
|
181
190
|
export * from './GetUniqueEndpointsRequest';
|
|
182
191
|
export * from './GlobalSearchCategoryResource';
|
package/dist/models/index.js
CHANGED
|
@@ -77,6 +77,8 @@ __exportStar(require("./BlogFrontendResource"), exports);
|
|
|
77
77
|
__exportStar(require("./BlogFrontendResourceArrayResponse"), exports);
|
|
78
78
|
__exportStar(require("./BlogResource"), exports);
|
|
79
79
|
__exportStar(require("./BlogResourceArrayResponse"), exports);
|
|
80
|
+
__exportStar(require("./CartCouponLiteResource"), exports);
|
|
81
|
+
__exportStar(require("./CartCouponLiteResourceArrayResponse"), exports);
|
|
80
82
|
__exportStar(require("./CartCouponResource"), exports);
|
|
81
83
|
__exportStar(require("./CartCouponResourceArrayResponse"), exports);
|
|
82
84
|
__exportStar(require("./CartListResource"), exports);
|
|
@@ -191,10 +193,17 @@ __exportStar(require("./ExternalApiLogResource"), exports);
|
|
|
191
193
|
__exportStar(require("./ExternalApiLogResourceArrayResponse"), exports);
|
|
192
194
|
__exportStar(require("./ExternalApiProvider"), exports);
|
|
193
195
|
__exportStar(require("./ExternalApiSyncStatus"), exports);
|
|
196
|
+
__exportStar(require("./FrontendCartResource"), exports);
|
|
197
|
+
__exportStar(require("./FrontendCartResourceArrayResponse"), exports);
|
|
198
|
+
__exportStar(require("./FrontendCartResourceCouponsInner"), exports);
|
|
194
199
|
__exportStar(require("./FrontendComponentLiteResource"), exports);
|
|
195
200
|
__exportStar(require("./FrontendComponentLiteResourceArrayResponse"), exports);
|
|
196
201
|
__exportStar(require("./FrontendComponentResource"), exports);
|
|
197
202
|
__exportStar(require("./FrontendComponentResourceArrayResponse"), exports);
|
|
203
|
+
__exportStar(require("./FrontendLineItemResource"), exports);
|
|
204
|
+
__exportStar(require("./FrontendLineItemResourceArrayResponse"), exports);
|
|
205
|
+
__exportStar(require("./FrontendOrderResource"), exports);
|
|
206
|
+
__exportStar(require("./FrontendOrderResourceArrayResponse"), exports);
|
|
198
207
|
__exportStar(require("./GenericResponse"), exports);
|
|
199
208
|
__exportStar(require("./GetUniqueEndpointsRequest"), exports);
|
|
200
209
|
__exportStar(require("./GlobalSearchCategoryResource"), exports);
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# CartCouponLiteResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`code` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`discount` | number
|
|
13
|
+
`appliesTo` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { CartCouponLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": null,
|
|
23
|
+
"code": null,
|
|
24
|
+
"name": null,
|
|
25
|
+
"discount": null,
|
|
26
|
+
"appliesTo": null,
|
|
27
|
+
} satisfies CartCouponLiteResource
|
|
28
|
+
|
|
29
|
+
console.log(example)
|
|
30
|
+
|
|
31
|
+
// Convert the instance to a JSON string
|
|
32
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
33
|
+
console.log(exampleJSON)
|
|
34
|
+
|
|
35
|
+
// Parse the JSON string back to an object
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as CartCouponLiteResource
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|
|
@@ -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
|
+
|
|
@@ -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<FrontendCartResourceCouponsInner>](FrontendCartResourceCouponsInner.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
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# FrontendCartResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<FrontendCartResource>](FrontendCartResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { FrontendCartResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies FrontendCartResourceArrayResponse
|
|
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 FrontendCartResourceArrayResponse
|
|
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,42 @@
|
|
|
1
|
+
|
|
2
|
+
# FrontendCartResourceCouponsInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`code` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`discount` | number
|
|
13
|
+
`appliesTo` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { FrontendCartResourceCouponsInner } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": null,
|
|
23
|
+
"code": null,
|
|
24
|
+
"name": null,
|
|
25
|
+
"discount": null,
|
|
26
|
+
"appliesTo": null,
|
|
27
|
+
} satisfies FrontendCartResourceCouponsInner
|
|
28
|
+
|
|
29
|
+
console.log(example)
|
|
30
|
+
|
|
31
|
+
// Convert the instance to a JSON string
|
|
32
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
33
|
+
console.log(exampleJSON)
|
|
34
|
+
|
|
35
|
+
// Parse the JSON string back to an object
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendCartResourceCouponsInner
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
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
|
+
`promotionalSaving` | number
|
|
15
|
+
`isAvailable` | boolean
|
|
16
|
+
`isInStock` | boolean
|
|
17
|
+
`productChild` | [ProductChildLineItemLiteResource](ProductChildLineItemLiteResource.md)
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { FrontendLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"id": null,
|
|
27
|
+
"quantity": null,
|
|
28
|
+
"productPrice": null,
|
|
29
|
+
"subtotalAmount": null,
|
|
30
|
+
"totalAmount": null,
|
|
31
|
+
"promotionalSaving": null,
|
|
32
|
+
"isAvailable": null,
|
|
33
|
+
"isInStock": null,
|
|
34
|
+
"productChild": null,
|
|
35
|
+
} satisfies FrontendLineItemResource
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendLineItemResource
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|
|
@@ -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,80 @@
|
|
|
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
|
+
`accessToken` | object
|
|
16
|
+
`shippingType` | string
|
|
17
|
+
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
18
|
+
`status` | object
|
|
19
|
+
`shippingAddress` | [AddressResource](AddressResource.md)
|
|
20
|
+
`billingAddress` | [AddressResource](AddressResource.md)
|
|
21
|
+
`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
22
|
+
`coupons` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
|
|
23
|
+
`subtotal` | number
|
|
24
|
+
`promotionalDiscount` | number
|
|
25
|
+
`couponSubtotalDiscount` | number
|
|
26
|
+
`couponShippingDiscount` | number
|
|
27
|
+
`shipping` | number
|
|
28
|
+
`transitInsurance` | number
|
|
29
|
+
`gst` | number
|
|
30
|
+
`grandTotal` | number
|
|
31
|
+
`amountPaid` | number
|
|
32
|
+
`amountDue` | number
|
|
33
|
+
|
|
34
|
+
## Example
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import type { FrontendOrderResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
38
|
+
|
|
39
|
+
// TODO: Update the object below with actual values
|
|
40
|
+
const example = {
|
|
41
|
+
"id": null,
|
|
42
|
+
"cartId": null,
|
|
43
|
+
"siteId": null,
|
|
44
|
+
"placedAt": null,
|
|
45
|
+
"source": null,
|
|
46
|
+
"paymentToken": null,
|
|
47
|
+
"accessToken": null,
|
|
48
|
+
"shippingType": null,
|
|
49
|
+
"customer": null,
|
|
50
|
+
"status": null,
|
|
51
|
+
"shippingAddress": null,
|
|
52
|
+
"billingAddress": null,
|
|
53
|
+
"lineItems": null,
|
|
54
|
+
"coupons": null,
|
|
55
|
+
"subtotal": null,
|
|
56
|
+
"promotionalDiscount": null,
|
|
57
|
+
"couponSubtotalDiscount": null,
|
|
58
|
+
"couponShippingDiscount": null,
|
|
59
|
+
"shipping": null,
|
|
60
|
+
"transitInsurance": null,
|
|
61
|
+
"gst": null,
|
|
62
|
+
"grandTotal": null,
|
|
63
|
+
"amountPaid": null,
|
|
64
|
+
"amountDue": null,
|
|
65
|
+
} satisfies FrontendOrderResource
|
|
66
|
+
|
|
67
|
+
console.log(example)
|
|
68
|
+
|
|
69
|
+
// Convert the instance to a JSON string
|
|
70
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
71
|
+
console.log(exampleJSON)
|
|
72
|
+
|
|
73
|
+
// Parse the JSON string back to an object
|
|
74
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendOrderResource
|
|
75
|
+
console.log(exampleParsed)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
79
|
+
|
|
80
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# FrontendOrderResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<FrontendOrderResource>](FrontendOrderResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { FrontendOrderResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies FrontendOrderResourceArrayResponse
|
|
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 FrontendOrderResourceArrayResponse
|
|
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/OrdersApi.md
CHANGED
|
@@ -12,6 +12,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
12
12
|
| [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
|
|
13
13
|
| [**getAllOrder**](OrdersApi.md#getallorder) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
|
|
14
14
|
| [**indexOrder**](OrdersApi.md#indexorder) | **POST** /admin-api/orders/list | Auto-generated: indexOrder |
|
|
15
|
+
| [**pdfOrder**](OrdersApi.md#pdforder) | **POST** /admin-api/orders/{order}/pdf | Auto-generated: pdfOrder |
|
|
15
16
|
| [**sendPaymentLinkOrder**](OrdersApi.md#sendpaymentlinkorder) | **POST** /admin-api/orders/{order}/send-payment-link | Auto-generated: sendPaymentLinkOrder |
|
|
16
17
|
| [**showOrder**](OrdersApi.md#showorder) | **GET** /admin-api/orders/{order} | Auto-generated: showOrder |
|
|
17
18
|
| [**statusesAllOrder**](OrdersApi.md#statusesallorder) | **POST** /admin-api/orders/statuses/all | Auto-generated: statusesAllOrder |
|
|
@@ -552,6 +553,71 @@ No authorization required
|
|
|
552
553
|
[[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
|
|
|
554
555
|
|
|
556
|
+
## pdfOrder
|
|
557
|
+
|
|
558
|
+
> GenericResponse pdfOrder(order)
|
|
559
|
+
|
|
560
|
+
Auto-generated: pdfOrder
|
|
561
|
+
|
|
562
|
+
### Example
|
|
563
|
+
|
|
564
|
+
```ts
|
|
565
|
+
import {
|
|
566
|
+
Configuration,
|
|
567
|
+
OrdersApi,
|
|
568
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
569
|
+
import type { PdfOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
570
|
+
|
|
571
|
+
async function example() {
|
|
572
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
573
|
+
const api = new OrdersApi();
|
|
574
|
+
|
|
575
|
+
const body = {
|
|
576
|
+
// number | The id of the order
|
|
577
|
+
order: 56,
|
|
578
|
+
} satisfies PdfOrderRequest;
|
|
579
|
+
|
|
580
|
+
try {
|
|
581
|
+
const data = await api.pdfOrder(body);
|
|
582
|
+
console.log(data);
|
|
583
|
+
} catch (error) {
|
|
584
|
+
console.error(error);
|
|
585
|
+
}
|
|
586
|
+
}
|
|
587
|
+
|
|
588
|
+
// Run the test
|
|
589
|
+
example().catch(console.error);
|
|
590
|
+
```
|
|
591
|
+
|
|
592
|
+
### Parameters
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
| Name | Type | Description | Notes |
|
|
596
|
+
|------------- | ------------- | ------------- | -------------|
|
|
597
|
+
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
598
|
+
|
|
599
|
+
### Return type
|
|
600
|
+
|
|
601
|
+
[**GenericResponse**](GenericResponse.md)
|
|
602
|
+
|
|
603
|
+
### Authorization
|
|
604
|
+
|
|
605
|
+
No authorization required
|
|
606
|
+
|
|
607
|
+
### HTTP request headers
|
|
608
|
+
|
|
609
|
+
- **Content-Type**: Not defined
|
|
610
|
+
- **Accept**: `application/json`
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
### HTTP response details
|
|
614
|
+
| Status code | Description | Response headers |
|
|
615
|
+
|-------------|-------------|------------------|
|
|
616
|
+
| **200** | \\Response | - |
|
|
617
|
+
|
|
618
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
619
|
+
|
|
620
|
+
|
|
555
621
|
## sendPaymentLinkOrder
|
|
556
622
|
|
|
557
623
|
> AdminOrderResource sendPaymentLinkOrder(order)
|
|
@@ -12,6 +12,9 @@ Name | Type
|
|
|
12
12
|
`model` | string
|
|
13
13
|
`modelNumber` | string
|
|
14
14
|
`name` | string
|
|
15
|
+
`parentName` | string
|
|
16
|
+
`variantName` | string
|
|
17
|
+
`slug` | string
|
|
15
18
|
`stock` | number
|
|
16
19
|
`salePrice` | number
|
|
17
20
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
@@ -30,6 +33,9 @@ const example = {
|
|
|
30
33
|
"model": null,
|
|
31
34
|
"modelNumber": null,
|
|
32
35
|
"name": null,
|
|
36
|
+
"parentName": null,
|
|
37
|
+
"variantName": null,
|
|
38
|
+
"slug": null,
|
|
33
39
|
"stock": null,
|
|
34
40
|
"salePrice": null,
|
|
35
41
|
"thumbnail": null,
|
|
@@ -8,6 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
10
|
`name` | string
|
|
11
|
+
`fullName` | string
|
|
11
12
|
`allowOversell` | boolean
|
|
12
13
|
`modelNumber` | string
|
|
13
14
|
`weight` | number
|
|
@@ -47,6 +48,7 @@ import type { ProductChildResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
47
48
|
const example = {
|
|
48
49
|
"id": null,
|
|
49
50
|
"name": null,
|
|
51
|
+
"fullName": null,
|
|
50
52
|
"allowOversell": null,
|
|
51
53
|
"modelNumber": null,
|
|
52
54
|
"weight": null,
|