@digital8/lighting-illusions-ts-sdk 0.0.2033 → 0.0.2035
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 -8
- package/README.md +12 -7
- package/dist/apis/OrdersApi.d.ts +15 -0
- package/dist/apis/OrdersApi.js +59 -0
- package/dist/apis/ProductApi.d.ts +0 -16
- package/dist/apis/ProductApi.js +0 -59
- package/dist/apis/TransactionsApi.d.ts +3 -3
- package/dist/apis/TransactionsApi.js +2 -2
- package/dist/models/AddressResource.d.ts +1 -7
- package/dist/models/AddressResource.js +3 -3
- package/dist/models/AdminNoteResource.d.ts +12 -0
- package/dist/models/AdminNoteResource.js +8 -0
- package/dist/models/AdminOrderResource.d.ts +3 -3
- package/dist/models/AdminOrderResource.js +3 -3
- 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/CartResource.d.ts +3 -3
- package/dist/models/CartResource.js +3 -3
- package/dist/models/CreateTransactionRequest.d.ts +0 -6
- package/dist/models/CreateTransactionRequest.js +0 -2
- package/dist/models/CustomerListResource.d.ts +7 -0
- package/dist/models/CustomerListResource.js +5 -0
- 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 +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/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/StoreFrontendResource.d.ts +2 -2
- package/dist/models/StoreFrontendResource.js +4 -4
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +3 -1
- package/dist/models/StoreResource.d.ts +2 -2
- package/dist/models/StoreResource.js +4 -4
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +1 -3
- package/dist/models/TransactionLiteResource.d.ts +0 -12
- package/dist/models/TransactionLiteResource.js +0 -4
- package/dist/models/UpdateOrderRequest.d.ts +0 -6
- package/dist/models/UpdateOrderRequest.js +0 -2
- package/dist/models/index.d.ts +9 -4
- package/dist/models/index.js +9 -4
- package/docs/AddressResource.md +0 -2
- package/docs/AdminNoteResource.md +4 -0
- package/docs/AdminOrderResource.md +1 -1
- package/docs/CartCouponLiteResource.md +42 -0
- package/docs/{TransactionListResourceArrayResponse.md → CartCouponLiteResourceArrayResponse.md} +5 -5
- package/docs/CartResource.md +1 -1
- package/docs/CreateTransactionRequest.md +0 -2
- package/docs/CustomerListResource.md +2 -0
- package/docs/FrontendCartResource.md +70 -0
- package/docs/{SkuSearchProductChildRequest.md → FrontendCartResourceArrayResponse.md} +6 -8
- package/docs/FrontendCartResourceCouponsInner.md +42 -0
- package/docs/FrontendLineItemResource.md +50 -0
- package/docs/{PaginatedTransactionListResourceResponse.md → FrontendLineItemResourceArrayResponse.md} +5 -7
- package/docs/FrontendOrderResource.md +78 -0
- package/docs/FrontendOrderResourceArrayResponse.md +34 -0
- package/docs/OrdersApi.md +66 -0
- package/docs/ProductApi.md +0 -66
- package/docs/ProductChildLineItemLiteResource.md +6 -0
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/TransactionLiteResource.md +0 -4
- package/docs/TransactionsApi.md +3 -3
- package/docs/UpdateOrderRequest.md +0 -2
- package/package.json +1 -1
- package/src/apis/OrdersApi.ts +49 -0
- package/src/apis/ProductApi.ts +0 -49
- package/src/apis/TransactionsApi.ts +7 -7
- package/src/models/AddressResource.ts +3 -10
- package/src/models/AdminNoteResource.ts +18 -0
- package/src/models/AdminOrderResource.ts +11 -11
- package/src/models/CartCouponLiteResource.ts +102 -0
- package/src/models/CartCouponLiteResourceArrayResponse.ts +73 -0
- package/src/models/CartResource.ts +11 -11
- package/src/models/CreateTransactionRequest.ts +0 -8
- package/src/models/CustomerListResource.ts +16 -0
- 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 +290 -0
- package/src/models/FrontendOrderResourceArrayResponse.ts +73 -0
- package/src/models/PaymentSource.ts +2 -1
- package/src/models/ProductChildLineItemLiteResource.ts +27 -0
- package/src/models/StoreFrontendResource.ts +5 -5
- package/src/models/StoreListResource.ts +3 -2
- package/src/models/StoreResource.ts +5 -5
- package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
- package/src/models/TransactionLiteResource.ts +0 -16
- package/src/models/UpdateOrderRequest.ts +0 -8
- package/src/models/index.ts +9 -4
- package/dist/models/PaginatedTransactionListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedTransactionListResourceResponse.js +0 -57
- package/dist/models/SkuSearchProductChildRequest.d.ts +0 -38
- package/dist/models/SkuSearchProductChildRequest.js +0 -55
- package/dist/models/TransactionListResource.d.ts +0 -116
- package/dist/models/TransactionListResource.js +0 -97
- package/dist/models/TransactionListResourceArrayResponse.d.ts +0 -33
- package/dist/models/TransactionListResourceArrayResponse.js +0 -50
- package/docs/TransactionListResource.md +0 -62
- package/src/models/PaginatedTransactionListResourceResponse.ts +0 -90
- package/src/models/SkuSearchProductChildRequest.ts +0 -75
- package/src/models/TransactionListResource.ts +0 -187
- package/src/models/TransactionListResourceArrayResponse.ts +0 -73
|
@@ -11,7 +11,6 @@ Name | Type
|
|
|
11
11
|
`amount` | number
|
|
12
12
|
`surcharge` | number
|
|
13
13
|
`paymentMethod` | string
|
|
14
|
-
`description` | string
|
|
15
14
|
`nonce` | string
|
|
16
15
|
`deviceData` | string
|
|
17
16
|
|
|
@@ -27,7 +26,6 @@ const example = {
|
|
|
27
26
|
"amount": null,
|
|
28
27
|
"surcharge": null,
|
|
29
28
|
"paymentMethod": null,
|
|
30
|
-
"description": null,
|
|
31
29
|
"nonce": null,
|
|
32
30
|
"deviceData": null,
|
|
33
31
|
} satisfies CreateTransactionRequest
|
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`email` | string
|
|
13
13
|
`phone` | string
|
|
14
14
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
15
|
+
`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -26,6 +27,7 @@ const example = {
|
|
|
26
27
|
"email": null,
|
|
27
28
|
"phone": null,
|
|
28
29
|
"site": null,
|
|
30
|
+
"addresses": null,
|
|
29
31
|
} satisfies CustomerListResource
|
|
30
32
|
|
|
31
33
|
console.log(example)
|
|
@@ -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
|
+
|
|
@@ -1,24 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FrontendCartResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
10
|
-
`siteId` | number
|
|
9
|
+
`data` | [Array<FrontendCartResource>](FrontendCartResource.md)
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
14
13
|
```typescript
|
|
15
|
-
import type {
|
|
14
|
+
import type { FrontendCartResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
15
|
|
|
17
16
|
// TODO: Update the object below with actual values
|
|
18
17
|
const example = {
|
|
19
|
-
"
|
|
20
|
-
|
|
21
|
-
} satisfies SkuSearchProductChildRequest
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies FrontendCartResourceArrayResponse
|
|
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 FrontendCartResourceArrayResponse
|
|
31
29
|
console.log(exampleParsed)
|
|
32
30
|
```
|
|
33
31
|
|
|
@@ -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
|
+
|
|
@@ -1,24 +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<
|
|
10
|
-
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
9
|
+
`data` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
14
13
|
```typescript
|
|
15
|
-
import type {
|
|
14
|
+
import type { FrontendLineItemResourceArrayResponse } 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 PaginatedTransactionListResourceResponse
|
|
19
|
+
} satisfies FrontendLineItemResourceArrayResponse
|
|
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 FrontendLineItemResourceArrayResponse
|
|
31
29
|
console.log(exampleParsed)
|
|
32
30
|
```
|
|
33
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` | object
|
|
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
|
+
|
|
@@ -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
|
@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
11
11
|
| [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
|
|
12
12
|
| [**getAllOrder**](OrdersApi.md#getallorder) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
|
|
13
13
|
| [**indexOrder**](OrdersApi.md#indexorder) | **POST** /admin-api/orders/list | Auto-generated: indexOrder |
|
|
14
|
+
| [**pdfOrder**](OrdersApi.md#pdforder) | **POST** /admin-api/orders/{order}/pdf | Auto-generated: pdfOrder |
|
|
14
15
|
| [**sendPaymentLinkOrder**](OrdersApi.md#sendpaymentlinkorder) | **POST** /admin-api/orders/{order}/send-payment-link | Auto-generated: sendPaymentLinkOrder |
|
|
15
16
|
| [**showOrder**](OrdersApi.md#showorder) | **GET** /admin-api/orders/{order} | Auto-generated: showOrder |
|
|
16
17
|
| [**statusesAllOrder**](OrdersApi.md#statusesallorder) | **POST** /admin-api/orders/statuses/all | Auto-generated: statusesAllOrder |
|
|
@@ -486,6 +487,71 @@ No authorization required
|
|
|
486
487
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
487
488
|
|
|
488
489
|
|
|
490
|
+
## pdfOrder
|
|
491
|
+
|
|
492
|
+
> GenericResponse pdfOrder(order)
|
|
493
|
+
|
|
494
|
+
Auto-generated: pdfOrder
|
|
495
|
+
|
|
496
|
+
### Example
|
|
497
|
+
|
|
498
|
+
```ts
|
|
499
|
+
import {
|
|
500
|
+
Configuration,
|
|
501
|
+
OrdersApi,
|
|
502
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
503
|
+
import type { PdfOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
504
|
+
|
|
505
|
+
async function example() {
|
|
506
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
507
|
+
const api = new OrdersApi();
|
|
508
|
+
|
|
509
|
+
const body = {
|
|
510
|
+
// number | The id of the order
|
|
511
|
+
order: 56,
|
|
512
|
+
} satisfies PdfOrderRequest;
|
|
513
|
+
|
|
514
|
+
try {
|
|
515
|
+
const data = await api.pdfOrder(body);
|
|
516
|
+
console.log(data);
|
|
517
|
+
} catch (error) {
|
|
518
|
+
console.error(error);
|
|
519
|
+
}
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
// Run the test
|
|
523
|
+
example().catch(console.error);
|
|
524
|
+
```
|
|
525
|
+
|
|
526
|
+
### Parameters
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
| Name | Type | Description | Notes |
|
|
530
|
+
|------------- | ------------- | ------------- | -------------|
|
|
531
|
+
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
532
|
+
|
|
533
|
+
### Return type
|
|
534
|
+
|
|
535
|
+
[**GenericResponse**](GenericResponse.md)
|
|
536
|
+
|
|
537
|
+
### Authorization
|
|
538
|
+
|
|
539
|
+
No authorization required
|
|
540
|
+
|
|
541
|
+
### HTTP request headers
|
|
542
|
+
|
|
543
|
+
- **Content-Type**: Not defined
|
|
544
|
+
- **Accept**: `application/json`
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
### HTTP response details
|
|
548
|
+
| Status code | Description | Response headers |
|
|
549
|
+
|-------------|-------------|------------------|
|
|
550
|
+
| **200** | Generic JSON success | - |
|
|
551
|
+
|
|
552
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
553
|
+
|
|
554
|
+
|
|
489
555
|
## sendPaymentLinkOrder
|
|
490
556
|
|
|
491
557
|
> AdminOrderResource sendPaymentLinkOrder(order)
|
package/docs/ProductApi.md
CHANGED
|
@@ -22,7 +22,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
22
22
|
| [**showAttributesProductChild**](ProductApi.md#showattributesproductchild) | **POST** /admin-api/product/children/{productChild}/attributes | Auto-generated: showAttributesProductChild |
|
|
23
23
|
| [**showProduct**](ProductApi.md#showproduct) | **GET** /admin-api/product/parent/{product} | Auto-generated: showProduct |
|
|
24
24
|
| [**showProductChild**](ProductApi.md#showproductchild) | **GET** /admin-api/product/children/{productChild} | Auto-generated: showProductChild |
|
|
25
|
-
| [**skuSearchProductChild**](ProductApi.md#skusearchproductchildoperation) | **POST** /admin-api/product/children/sku-search | Auto-generated: skuSearchProductChild |
|
|
26
25
|
| [**storeProduct**](ProductApi.md#storeproduct) | **POST** /admin-api/product/parent/create | Auto-generated: storeProduct |
|
|
27
26
|
| [**storeProductChild**](ProductApi.md#storeproductchild) | **POST** /admin-api/product/children/create | Auto-generated: storeProductChild |
|
|
28
27
|
| [**updateProduct**](ProductApi.md#updateproductoperation) | **PUT** /admin-api/product/parent/{product}/update | Auto-generated: updateProduct |
|
|
@@ -1230,71 +1229,6 @@ No authorization required
|
|
|
1230
1229
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1231
1230
|
|
|
1232
1231
|
|
|
1233
|
-
## skuSearchProductChild
|
|
1234
|
-
|
|
1235
|
-
> ProductChildResource skuSearchProductChild(skuSearchProductChildRequest)
|
|
1236
|
-
|
|
1237
|
-
Auto-generated: skuSearchProductChild
|
|
1238
|
-
|
|
1239
|
-
### Example
|
|
1240
|
-
|
|
1241
|
-
```ts
|
|
1242
|
-
import {
|
|
1243
|
-
Configuration,
|
|
1244
|
-
ProductApi,
|
|
1245
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
1246
|
-
import type { SkuSearchProductChildOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
1247
|
-
|
|
1248
|
-
async function example() {
|
|
1249
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
1250
|
-
const api = new ProductApi();
|
|
1251
|
-
|
|
1252
|
-
const body = {
|
|
1253
|
-
// SkuSearchProductChildRequest (optional)
|
|
1254
|
-
skuSearchProductChildRequest: ...,
|
|
1255
|
-
} satisfies SkuSearchProductChildOperationRequest;
|
|
1256
|
-
|
|
1257
|
-
try {
|
|
1258
|
-
const data = await api.skuSearchProductChild(body);
|
|
1259
|
-
console.log(data);
|
|
1260
|
-
} catch (error) {
|
|
1261
|
-
console.error(error);
|
|
1262
|
-
}
|
|
1263
|
-
}
|
|
1264
|
-
|
|
1265
|
-
// Run the test
|
|
1266
|
-
example().catch(console.error);
|
|
1267
|
-
```
|
|
1268
|
-
|
|
1269
|
-
### Parameters
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
| Name | Type | Description | Notes |
|
|
1273
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1274
|
-
| **skuSearchProductChildRequest** | [SkuSearchProductChildRequest](SkuSearchProductChildRequest.md) | | [Optional] |
|
|
1275
|
-
|
|
1276
|
-
### Return type
|
|
1277
|
-
|
|
1278
|
-
[**ProductChildResource**](ProductChildResource.md)
|
|
1279
|
-
|
|
1280
|
-
### Authorization
|
|
1281
|
-
|
|
1282
|
-
No authorization required
|
|
1283
|
-
|
|
1284
|
-
### HTTP request headers
|
|
1285
|
-
|
|
1286
|
-
- **Content-Type**: `application/json`
|
|
1287
|
-
- **Accept**: `application/json`
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
### HTTP response details
|
|
1291
|
-
| Status code | Description | Response headers |
|
|
1292
|
-
|-------------|-------------|------------------|
|
|
1293
|
-
| **200** | Successful resource response | - |
|
|
1294
|
-
|
|
1295
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
1232
|
## storeProduct
|
|
1299
1233
|
|
|
1300
1234
|
> ProductResource storeProduct(createProductRequest)
|
|
@@ -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,
|
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`id` | number
|
|
10
9
|
`paymentSource` | string
|
|
11
10
|
`paymentMethod` | string
|
|
12
11
|
`paymentMethodThumbnail` | string
|
|
@@ -16,7 +15,6 @@ Name | Type
|
|
|
16
15
|
`surcharge` | number
|
|
17
16
|
`totalAmount` | number
|
|
18
17
|
`reference` | string
|
|
19
|
-
`description` | string
|
|
20
18
|
`createdAt` | Date
|
|
21
19
|
|
|
22
20
|
## Example
|
|
@@ -26,7 +24,6 @@ import type { TransactionLiteResource } from '@digital8/lighting-illusions-ts-sd
|
|
|
26
24
|
|
|
27
25
|
// TODO: Update the object below with actual values
|
|
28
26
|
const example = {
|
|
29
|
-
"id": null,
|
|
30
27
|
"paymentSource": null,
|
|
31
28
|
"paymentMethod": null,
|
|
32
29
|
"paymentMethodThumbnail": null,
|
|
@@ -36,7 +33,6 @@ const example = {
|
|
|
36
33
|
"surcharge": null,
|
|
37
34
|
"totalAmount": null,
|
|
38
35
|
"reference": null,
|
|
39
|
-
"description": null,
|
|
40
36
|
"createdAt": null,
|
|
41
37
|
} satisfies TransactionLiteResource
|
|
42
38
|
|
package/docs/TransactionsApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
12
12
|
|
|
13
13
|
## indexTransaction
|
|
14
14
|
|
|
15
|
-
>
|
|
15
|
+
> PaginatedTransactionResourceResponse indexTransaction(searchTransactionsRequest)
|
|
16
16
|
|
|
17
17
|
Auto-generated: indexTransaction
|
|
18
18
|
|
|
@@ -55,7 +55,7 @@ example().catch(console.error);
|
|
|
55
55
|
|
|
56
56
|
### Return type
|
|
57
57
|
|
|
58
|
-
[**
|
|
58
|
+
[**PaginatedTransactionResourceResponse**](PaginatedTransactionResourceResponse.md)
|
|
59
59
|
|
|
60
60
|
### Authorization
|
|
61
61
|
|
|
@@ -70,7 +70,7 @@ No authorization required
|
|
|
70
70
|
### HTTP response details
|
|
71
71
|
| Status code | Description | Response headers |
|
|
72
72
|
|-------------|-------------|------------------|
|
|
73
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\
|
|
73
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\TransactionResource[]>> | - |
|
|
74
74
|
|
|
75
75
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
76
76
|
|
|
@@ -15,7 +15,6 @@ Name | Type
|
|
|
15
15
|
`insuranceAmount` | number
|
|
16
16
|
`includeInsurance` | boolean
|
|
17
17
|
`overrideInsurance` | boolean
|
|
18
|
-
`useAsBillingAddress` | boolean
|
|
19
18
|
`shippingAddressId` | number
|
|
20
19
|
`billingAddressId` | number
|
|
21
20
|
`shippingAddress` | [CreateCartRequestShippingAddress](CreateCartRequestShippingAddress.md)
|
|
@@ -37,7 +36,6 @@ const example = {
|
|
|
37
36
|
"insuranceAmount": null,
|
|
38
37
|
"includeInsurance": null,
|
|
39
38
|
"overrideInsurance": null,
|
|
40
|
-
"useAsBillingAddress": null,
|
|
41
39
|
"shippingAddressId": null,
|
|
42
40
|
"billingAddressId": null,
|
|
43
41
|
"shippingAddress": null,
|