@digital8/lighting-illusions-ts-sdk 0.0.2093 → 0.0.2095
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 -18
- package/README.md +12 -12
- package/dist/apis/OrdersApi.d.ts +15 -17
- package/dist/apis/OrdersApi.js +59 -60
- package/dist/models/AddressFrontendResource.d.ts +2 -2
- package/dist/models/AddressFrontendResource.js +6 -2
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +1 -3
- package/dist/models/AdminOrderResource.d.ts +3 -22
- package/dist/models/AdminOrderResource.js +3 -16
- 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/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +1 -3
- 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 +139 -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 +1 -1
- package/dist/models/StoreFrontendResource.js +1 -3
- 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/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +1 -3
- package/dist/models/index.d.ts +9 -9
- package/dist/models/index.js +9 -9
- package/docs/AdminOrderResource.md +1 -7
- package/docs/CartCouponLiteResource.md +42 -0
- package/docs/{OrderFulfillmentLineItemResourceArrayResponse.md → CartCouponLiteResourceArrayResponse.md} +5 -5
- package/docs/FrontendCartResource.md +70 -0
- package/docs/{OrderStatusId.md → FrontendCartResourceArrayResponse.md} +6 -4
- package/docs/{OrderFulfillmentLineItemResource.md → FrontendCartResourceCouponsInner.md} +12 -8
- package/docs/FrontendLineItemResource.md +50 -0
- package/docs/{OrderFulfillmentResourceArrayResponse.md → FrontendLineItemResourceArrayResponse.md} +5 -5
- package/docs/FrontendOrderResource.md +80 -0
- package/docs/{AdminOrderLineItemResourceArrayResponse.md → FrontendOrderResourceArrayResponse.md} +5 -5
- package/docs/OrdersApi.md +66 -66
- package/docs/ProductChildLineItemLiteResource.md +6 -0
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/StoreSpecialDateResource.md +1 -1
- package/package.json +1 -1
- package/src/apis/OrdersApi.ts +49 -54
- package/src/models/AddressFrontendResource.ts +6 -4
- package/src/models/AddressResource.ts +2 -3
- package/src/models/AdminOrderResource.ts +11 -45
- package/src/models/CartCouponLiteResource.ts +102 -0
- package/src/models/CartCouponLiteResourceArrayResponse.ts +73 -0
- package/src/models/ExternalApiLogResource.ts +2 -3
- 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 +298 -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 +2 -3
- package/src/models/StoreListResource.ts +3 -2
- package/src/models/StoreResource.ts +5 -5
- package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
- package/src/models/StoreSpecialDateResource.ts +3 -4
- package/src/models/index.ts +9 -9
- package/dist/models/AdminOrderLineItemResource.d.ts +0 -117
- package/dist/models/AdminOrderLineItemResource.js +0 -106
- package/dist/models/AdminOrderLineItemResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminOrderLineItemResourceArrayResponse.js +0 -50
- package/dist/models/OrderFulfillmentLineItemResource.d.ts +0 -45
- package/dist/models/OrderFulfillmentLineItemResource.js +0 -60
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.d.ts +0 -33
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.js +0 -50
- package/dist/models/OrderFulfillmentResource.d.ts +0 -87
- package/dist/models/OrderFulfillmentResource.js +0 -80
- package/dist/models/OrderFulfillmentResourceArrayResponse.d.ts +0 -33
- package/dist/models/OrderFulfillmentResourceArrayResponse.js +0 -50
- package/dist/models/OrderStatusId.d.ts +0 -37
- package/dist/models/OrderStatusId.js +0 -63
- package/dist/models/PaginatedOrderFulfillmentResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedOrderFulfillmentResourceResponse.js +0 -57
- package/dist/models/SearchOrderFulfillmentsRequest.d.ts +0 -120
- package/dist/models/SearchOrderFulfillmentsRequest.js +0 -88
- package/docs/AdminOrderLineItemResource.md +0 -62
- package/docs/OrderFulfillmentResource.md +0 -52
- package/docs/PaginatedOrderFulfillmentResourceResponse.md +0 -36
- package/docs/SearchOrderFulfillmentsRequest.md +0 -58
- package/src/models/AdminOrderLineItemResource.ts +0 -199
- package/src/models/AdminOrderLineItemResourceArrayResponse.ts +0 -73
- package/src/models/OrderFulfillmentLineItemResource.ts +0 -92
- package/src/models/OrderFulfillmentLineItemResourceArrayResponse.ts +0 -73
- package/src/models/OrderFulfillmentResource.ts +0 -151
- package/src/models/OrderFulfillmentResourceArrayResponse.ts +0 -73
- package/src/models/OrderStatusId.ts +0 -65
- package/src/models/PaginatedOrderFulfillmentResourceResponse.ts +0 -90
- package/src/models/SearchOrderFulfillmentsRequest.ts +0 -181
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FrontendCartResourceCouponsInner
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -7,20 +7,24 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
11
|
-
`
|
|
10
|
+
`code` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`discount` | number
|
|
13
|
+
`appliesTo` | string
|
|
12
14
|
|
|
13
15
|
## Example
|
|
14
16
|
|
|
15
17
|
```typescript
|
|
16
|
-
import type {
|
|
18
|
+
import type { FrontendCartResourceCouponsInner } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
19
|
|
|
18
20
|
// TODO: Update the object below with actual values
|
|
19
21
|
const example = {
|
|
20
22
|
"id": null,
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
|
|
23
|
+
"code": null,
|
|
24
|
+
"name": null,
|
|
25
|
+
"discount": null,
|
|
26
|
+
"appliesTo": null,
|
|
27
|
+
} satisfies FrontendCartResourceCouponsInner
|
|
24
28
|
|
|
25
29
|
console.log(example)
|
|
26
30
|
|
|
@@ -29,7 +33,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
29
33
|
console.log(exampleJSON)
|
|
30
34
|
|
|
31
35
|
// Parse the JSON string back to an object
|
|
32
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendCartResourceCouponsInner
|
|
33
37
|
console.log(exampleParsed)
|
|
34
38
|
```
|
|
35
39
|
|
|
@@ -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
|
+
|
package/docs/{OrderFulfillmentResourceArrayResponse.md → FrontendLineItemResourceArrayResponse.md}
RENAMED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FrontendLineItemResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { FrontendLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
18
|
"data": null,
|
|
19
|
-
} satisfies
|
|
19
|
+
} satisfies FrontendLineItemResourceArrayResponse
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendLineItemResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -0,0 +1,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` | string
|
|
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
|
+
|
package/docs/{AdminOrderLineItemResourceArrayResponse.md → FrontendOrderResourceArrayResponse.md}
RENAMED
|
@@ -1,22 +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<
|
|
9
|
+
`data` | [Array<FrontendOrderResource>](FrontendOrderResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { FrontendOrderResourceArrayResponse } 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 FrontendOrderResourceArrayResponse
|
|
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 FrontendOrderResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -4,7 +4,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**allOrderFulfillment**](OrdersApi.md#allorderfulfillment) | **POST** /admin-api/orders/fulfillments/all | Auto-generated: allOrderFulfillment |
|
|
8
7
|
| [**attachCouponOrder**](OrdersApi.md#attachcouponorder) | **POST** /admin-api/orders/{order}/coupons/attach | Auto-generated: attachCouponOrder |
|
|
9
8
|
| [**attachItemOrder**](OrdersApi.md#attachitemorder) | **POST** /admin-api/orders/{order}/line-items/attach | Auto-generated: attachItemOrder |
|
|
10
9
|
| [**destroyOrder**](OrdersApi.md#destroyorder) | **DELETE** /admin-api/orders/{order}/delete | Auto-generated: destroyOrder |
|
|
@@ -12,6 +11,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
12
11
|
| [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
|
|
13
12
|
| [**getAllOrder**](OrdersApi.md#getallorder) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
|
|
14
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 |
|
|
15
15
|
| [**sendPaymentLinkOrder**](OrdersApi.md#sendpaymentlinkorder) | **POST** /admin-api/orders/{order}/send-payment-link | Auto-generated: sendPaymentLinkOrder |
|
|
16
16
|
| [**showOrder**](OrdersApi.md#showorder) | **GET** /admin-api/orders/{order} | Auto-generated: showOrder |
|
|
17
17
|
| [**statusesAllOrder**](OrdersApi.md#statusesallorder) | **POST** /admin-api/orders/statuses/all | Auto-generated: statusesAllOrder |
|
|
@@ -20,71 +20,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
23
|
-
## allOrderFulfillment
|
|
24
|
-
|
|
25
|
-
> PaginatedOrderFulfillmentResourceResponse allOrderFulfillment(searchOrderFulfillmentsRequest)
|
|
26
|
-
|
|
27
|
-
Auto-generated: allOrderFulfillment
|
|
28
|
-
|
|
29
|
-
### Example
|
|
30
|
-
|
|
31
|
-
```ts
|
|
32
|
-
import {
|
|
33
|
-
Configuration,
|
|
34
|
-
OrdersApi,
|
|
35
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
36
|
-
import type { AllOrderFulfillmentRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
37
|
-
|
|
38
|
-
async function example() {
|
|
39
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
40
|
-
const api = new OrdersApi();
|
|
41
|
-
|
|
42
|
-
const body = {
|
|
43
|
-
// SearchOrderFulfillmentsRequest (optional)
|
|
44
|
-
searchOrderFulfillmentsRequest: ...,
|
|
45
|
-
} satisfies AllOrderFulfillmentRequest;
|
|
46
|
-
|
|
47
|
-
try {
|
|
48
|
-
const data = await api.allOrderFulfillment(body);
|
|
49
|
-
console.log(data);
|
|
50
|
-
} catch (error) {
|
|
51
|
-
console.error(error);
|
|
52
|
-
}
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
// Run the test
|
|
56
|
-
example().catch(console.error);
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
### Parameters
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
| Name | Type | Description | Notes |
|
|
63
|
-
|------------- | ------------- | ------------- | -------------|
|
|
64
|
-
| **searchOrderFulfillmentsRequest** | [SearchOrderFulfillmentsRequest](SearchOrderFulfillmentsRequest.md) | | [Optional] |
|
|
65
|
-
|
|
66
|
-
### Return type
|
|
67
|
-
|
|
68
|
-
[**PaginatedOrderFulfillmentResourceResponse**](PaginatedOrderFulfillmentResourceResponse.md)
|
|
69
|
-
|
|
70
|
-
### Authorization
|
|
71
|
-
|
|
72
|
-
No authorization required
|
|
73
|
-
|
|
74
|
-
### HTTP request headers
|
|
75
|
-
|
|
76
|
-
- **Content-Type**: `application/json`
|
|
77
|
-
- **Accept**: `application/json`
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
### HTTP response details
|
|
81
|
-
| Status code | Description | Response headers |
|
|
82
|
-
|-------------|-------------|------------------|
|
|
83
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\OrderFulfillmentResource[]>> | - |
|
|
84
|
-
|
|
85
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
86
|
-
|
|
87
|
-
|
|
88
23
|
## attachCouponOrder
|
|
89
24
|
|
|
90
25
|
> AdminOrderResource attachCouponOrder(order, attachCouponRequest)
|
|
@@ -552,6 +487,71 @@ No authorization required
|
|
|
552
487
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
553
488
|
|
|
554
489
|
|
|
490
|
+
## pdfOrder
|
|
491
|
+
|
|
492
|
+
> Blob 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
|
+
**Blob**
|
|
536
|
+
|
|
537
|
+
### Authorization
|
|
538
|
+
|
|
539
|
+
No authorization required
|
|
540
|
+
|
|
541
|
+
### HTTP request headers
|
|
542
|
+
|
|
543
|
+
- **Content-Type**: Not defined
|
|
544
|
+
- **Accept**: ``
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
### HTTP response details
|
|
548
|
+
| Status code | Description | Response headers |
|
|
549
|
+
|-------------|-------------|------------------|
|
|
550
|
+
| **200** | File download (application/pdf) | - |
|
|
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
|
+
|
|
555
555
|
## sendPaymentLinkOrder
|
|
556
556
|
|
|
557
557
|
> 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,
|
package/package.json
CHANGED
package/src/apis/OrdersApi.ts
CHANGED
|
@@ -48,11 +48,6 @@ import {
|
|
|
48
48
|
OrderStatusWithCountResourceArrayResponseFromJSON,
|
|
49
49
|
OrderStatusWithCountResourceArrayResponseToJSON,
|
|
50
50
|
} from '../models/OrderStatusWithCountResourceArrayResponse';
|
|
51
|
-
import {
|
|
52
|
-
type PaginatedOrderFulfillmentResourceResponse,
|
|
53
|
-
PaginatedOrderFulfillmentResourceResponseFromJSON,
|
|
54
|
-
PaginatedOrderFulfillmentResourceResponseToJSON,
|
|
55
|
-
} from '../models/PaginatedOrderFulfillmentResourceResponse';
|
|
56
51
|
import {
|
|
57
52
|
type PaginatedOrderListResourceResponse,
|
|
58
53
|
PaginatedOrderListResourceResponseFromJSON,
|
|
@@ -63,11 +58,6 @@ import {
|
|
|
63
58
|
SearchAllOrdersRequestFromJSON,
|
|
64
59
|
SearchAllOrdersRequestToJSON,
|
|
65
60
|
} from '../models/SearchAllOrdersRequest';
|
|
66
|
-
import {
|
|
67
|
-
type SearchOrderFulfillmentsRequest,
|
|
68
|
-
SearchOrderFulfillmentsRequestFromJSON,
|
|
69
|
-
SearchOrderFulfillmentsRequestToJSON,
|
|
70
|
-
} from '../models/SearchOrderFulfillmentsRequest';
|
|
71
61
|
import {
|
|
72
62
|
type SearchOrdersRequest,
|
|
73
63
|
SearchOrdersRequestFromJSON,
|
|
@@ -84,10 +74,6 @@ import {
|
|
|
84
74
|
UpdateOrderRequestToJSON,
|
|
85
75
|
} from '../models/UpdateOrderRequest';
|
|
86
76
|
|
|
87
|
-
export interface AllOrderFulfillmentRequest {
|
|
88
|
-
searchOrderFulfillmentsRequest?: SearchOrderFulfillmentsRequest;
|
|
89
|
-
}
|
|
90
|
-
|
|
91
77
|
export interface AttachCouponOrderRequest {
|
|
92
78
|
order: number;
|
|
93
79
|
attachCouponRequest?: AttachCouponRequest;
|
|
@@ -120,6 +106,10 @@ export interface IndexOrderRequest {
|
|
|
120
106
|
searchOrdersRequest?: SearchOrdersRequest;
|
|
121
107
|
}
|
|
122
108
|
|
|
109
|
+
export interface PdfOrderRequest {
|
|
110
|
+
order: number;
|
|
111
|
+
}
|
|
112
|
+
|
|
123
113
|
export interface SendPaymentLinkOrderRequest {
|
|
124
114
|
order: number;
|
|
125
115
|
}
|
|
@@ -144,46 +134,6 @@ export interface UpdateOrderOperationRequest {
|
|
|
144
134
|
*/
|
|
145
135
|
export class OrdersApi extends runtime.BaseAPI {
|
|
146
136
|
|
|
147
|
-
/**
|
|
148
|
-
* Creates request options for allOrderFulfillment without sending the request
|
|
149
|
-
*/
|
|
150
|
-
async allOrderFulfillmentRequestOpts(requestParameters: AllOrderFulfillmentRequest): Promise<runtime.RequestOpts> {
|
|
151
|
-
const queryParameters: any = {};
|
|
152
|
-
|
|
153
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
154
|
-
|
|
155
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
let urlPath = `/admin-api/orders/fulfillments/all`;
|
|
159
|
-
|
|
160
|
-
return {
|
|
161
|
-
path: urlPath,
|
|
162
|
-
method: 'POST',
|
|
163
|
-
headers: headerParameters,
|
|
164
|
-
query: queryParameters,
|
|
165
|
-
body: SearchOrderFulfillmentsRequestToJSON(requestParameters['searchOrderFulfillmentsRequest']),
|
|
166
|
-
};
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
/**
|
|
170
|
-
* Auto-generated: allOrderFulfillment
|
|
171
|
-
*/
|
|
172
|
-
async allOrderFulfillmentRaw(requestParameters: AllOrderFulfillmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedOrderFulfillmentResourceResponse>> {
|
|
173
|
-
const requestOptions = await this.allOrderFulfillmentRequestOpts(requestParameters);
|
|
174
|
-
const response = await this.request(requestOptions, initOverrides);
|
|
175
|
-
|
|
176
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedOrderFulfillmentResourceResponseFromJSON(jsonValue));
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
/**
|
|
180
|
-
* Auto-generated: allOrderFulfillment
|
|
181
|
-
*/
|
|
182
|
-
async allOrderFulfillment(requestParameters: AllOrderFulfillmentRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedOrderFulfillmentResourceResponse> {
|
|
183
|
-
const response = await this.allOrderFulfillmentRaw(requestParameters, initOverrides);
|
|
184
|
-
return await response.value();
|
|
185
|
-
}
|
|
186
|
-
|
|
187
137
|
/**
|
|
188
138
|
* Creates request options for attachCouponOrder without sending the request
|
|
189
139
|
*/
|
|
@@ -506,6 +456,51 @@ export class OrdersApi extends runtime.BaseAPI {
|
|
|
506
456
|
return await response.value();
|
|
507
457
|
}
|
|
508
458
|
|
|
459
|
+
/**
|
|
460
|
+
* Creates request options for pdfOrder without sending the request
|
|
461
|
+
*/
|
|
462
|
+
async pdfOrderRequestOpts(requestParameters: PdfOrderRequest): Promise<runtime.RequestOpts> {
|
|
463
|
+
if (requestParameters['order'] == null) {
|
|
464
|
+
throw new runtime.RequiredError(
|
|
465
|
+
'order',
|
|
466
|
+
'Required parameter "order" was null or undefined when calling pdfOrder().'
|
|
467
|
+
);
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
const queryParameters: any = {};
|
|
471
|
+
|
|
472
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
let urlPath = `/admin-api/orders/{order}/pdf`;
|
|
476
|
+
urlPath = urlPath.replace('{order}', encodeURIComponent(String(requestParameters['order'])));
|
|
477
|
+
|
|
478
|
+
return {
|
|
479
|
+
path: urlPath,
|
|
480
|
+
method: 'POST',
|
|
481
|
+
headers: headerParameters,
|
|
482
|
+
query: queryParameters,
|
|
483
|
+
};
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* Auto-generated: pdfOrder
|
|
488
|
+
*/
|
|
489
|
+
async pdfOrderRaw(requestParameters: PdfOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
|
|
490
|
+
const requestOptions = await this.pdfOrderRequestOpts(requestParameters);
|
|
491
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
492
|
+
|
|
493
|
+
return new runtime.BlobApiResponse(response);
|
|
494
|
+
}
|
|
495
|
+
|
|
496
|
+
/**
|
|
497
|
+
* Auto-generated: pdfOrder
|
|
498
|
+
*/
|
|
499
|
+
async pdfOrder(requestParameters: PdfOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
|
|
500
|
+
const response = await this.pdfOrderRaw(requestParameters, initOverrides);
|
|
501
|
+
return await response.value();
|
|
502
|
+
}
|
|
503
|
+
|
|
509
504
|
/**
|
|
510
505
|
* Creates request options for sendPaymentLinkOrder without sending the request
|
|
511
506
|
*/
|
|
@@ -24,7 +24,7 @@ export interface AddressFrontendResource {
|
|
|
24
24
|
* @type {string}
|
|
25
25
|
* @memberof AddressFrontendResource
|
|
26
26
|
*/
|
|
27
|
-
company
|
|
27
|
+
company: string;
|
|
28
28
|
/**
|
|
29
29
|
*
|
|
30
30
|
* @type {string}
|
|
@@ -36,7 +36,7 @@ export interface AddressFrontendResource {
|
|
|
36
36
|
* @type {string}
|
|
37
37
|
* @memberof AddressFrontendResource
|
|
38
38
|
*/
|
|
39
|
-
line2
|
|
39
|
+
line2: string;
|
|
40
40
|
/**
|
|
41
41
|
*
|
|
42
42
|
* @type {string}
|
|
@@ -73,7 +73,9 @@ export interface AddressFrontendResource {
|
|
|
73
73
|
* Check if a given object implements the AddressFrontendResource interface.
|
|
74
74
|
*/
|
|
75
75
|
export function instanceOfAddressFrontendResource(value: object): value is AddressFrontendResource {
|
|
76
|
+
if (!('company' in value) || value['company'] === undefined) return false;
|
|
76
77
|
if (!('line1' in value) || value['line1'] === undefined) return false;
|
|
78
|
+
if (!('line2' in value) || value['line2'] === undefined) return false;
|
|
77
79
|
if (!('postcode' in value) || value['postcode'] === undefined) return false;
|
|
78
80
|
if (!('suburb' in value) || value['suburb'] === undefined) return false;
|
|
79
81
|
if (!('country' in value) || value['country'] === undefined) return false;
|
|
@@ -92,9 +94,9 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
|
|
|
92
94
|
}
|
|
93
95
|
return {
|
|
94
96
|
|
|
95
|
-
'company': json['company']
|
|
97
|
+
'company': json['company'],
|
|
96
98
|
'line1': json['line1'],
|
|
97
|
-
'line2': json['line2']
|
|
99
|
+
'line2': json['line2'],
|
|
98
100
|
'postcode': json['postcode'],
|
|
99
101
|
'suburb': json['suburb'],
|
|
100
102
|
'country': json['country'],
|
|
@@ -48,7 +48,7 @@ export interface AddressResource {
|
|
|
48
48
|
* @type {string}
|
|
49
49
|
* @memberof AddressResource
|
|
50
50
|
*/
|
|
51
|
-
company
|
|
51
|
+
company?: string | null;
|
|
52
52
|
/**
|
|
53
53
|
*
|
|
54
54
|
* @type {string}
|
|
@@ -98,7 +98,6 @@ export interface AddressResource {
|
|
|
98
98
|
*/
|
|
99
99
|
export function instanceOfAddressResource(value: object): value is AddressResource {
|
|
100
100
|
if (!('addresseeName' in value) || value['addresseeName'] === undefined) return false;
|
|
101
|
-
if (!('company' in value) || value['company'] === undefined) return false;
|
|
102
101
|
if (!('line1' in value) || value['line1'] === undefined) return false;
|
|
103
102
|
if (!('postcode' in value) || value['postcode'] === undefined) return false;
|
|
104
103
|
if (!('suburb' in value) || value['suburb'] === undefined) return false;
|
|
@@ -122,7 +121,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
122
121
|
'type': json['type'] == null ? undefined : json['type'],
|
|
123
122
|
'sourceAddressId': json['sourceAddressId'] == null ? undefined : json['sourceAddressId'],
|
|
124
123
|
'addresseeName': json['addresseeName'],
|
|
125
|
-
'company': json['company'],
|
|
124
|
+
'company': json['company'] == null ? undefined : json['company'],
|
|
126
125
|
'line1': json['line1'],
|
|
127
126
|
'line2': json['line2'] == null ? undefined : json['line2'],
|
|
128
127
|
'postcode': json['postcode'],
|