@digital8/lighting-illusions-ts-sdk 0.0.2092 → 0.0.2093
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 -14
- package/README.md +12 -9
- package/dist/apis/OrdersApi.d.ts +17 -0
- package/dist/apis/OrdersApi.js +60 -0
- package/dist/models/AdminOrderLineItemResource.d.ts +117 -0
- package/dist/models/AdminOrderLineItemResource.js +106 -0
- package/dist/models/AdminOrderLineItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminOrderLineItemResourceArrayResponse.js +50 -0
- package/dist/models/AdminOrderResource.d.ts +22 -3
- package/dist/models/AdminOrderResource.js +16 -3
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +3 -1
- package/dist/models/OrderFulfillmentLineItemResource.d.ts +45 -0
- package/dist/models/OrderFulfillmentLineItemResource.js +60 -0
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.js +50 -0
- package/dist/models/OrderFulfillmentResource.d.ts +87 -0
- package/dist/models/OrderFulfillmentResource.js +80 -0
- package/dist/models/OrderFulfillmentResourceArrayResponse.d.ts +33 -0
- package/dist/models/OrderFulfillmentResourceArrayResponse.js +50 -0
- package/dist/models/OrderStatusId.d.ts +37 -0
- package/dist/models/OrderStatusId.js +63 -0
- package/dist/models/PaginatedOrderFulfillmentResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedOrderFulfillmentResourceResponse.js +57 -0
- package/dist/models/ProductChildLineItemLiteResource.d.ts +0 -18
- package/dist/models/ProductChildLineItemLiteResource.js +0 -12
- package/dist/models/SearchOrderFulfillmentsRequest.d.ts +120 -0
- package/dist/models/SearchOrderFulfillmentsRequest.js +88 -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 +3 -1
- package/dist/models/index.d.ts +9 -7
- package/dist/models/index.js +9 -7
- package/docs/AdminOrderLineItemResource.md +62 -0
- package/docs/{CartCouponLiteResource.md → AdminOrderLineItemResourceArrayResponse.md} +6 -14
- package/docs/AdminOrderResource.md +7 -1
- package/docs/{FrontendCartResourceCouponsInner.md → OrderFulfillmentLineItemResource.md} +8 -12
- package/docs/{CartCouponLiteResourceArrayResponse.md → OrderFulfillmentLineItemResourceArrayResponse.md} +5 -5
- package/docs/OrderFulfillmentResource.md +52 -0
- package/docs/{FrontendLineItemResourceArrayResponse.md → OrderFulfillmentResourceArrayResponse.md} +5 -5
- package/docs/{FrontendCartResourceArrayResponse.md → OrderStatusId.md} +4 -6
- package/docs/OrdersApi.md +66 -0
- package/docs/PaginatedOrderFulfillmentResourceResponse.md +36 -0
- package/docs/ProductChildLineItemLiteResource.md +0 -6
- package/docs/SearchOrderFulfillmentsRequest.md +58 -0
- package/docs/StoreSpecialDateResource.md +1 -1
- package/package.json +1 -1
- package/src/apis/OrdersApi.ts +54 -0
- package/src/models/AdminOrderLineItemResource.ts +199 -0
- package/src/models/AdminOrderLineItemResourceArrayResponse.ts +73 -0
- package/src/models/AdminOrderResource.ts +45 -11
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/OrderFulfillmentLineItemResource.ts +92 -0
- package/src/models/OrderFulfillmentLineItemResourceArrayResponse.ts +73 -0
- package/src/models/OrderFulfillmentResource.ts +151 -0
- package/src/models/OrderFulfillmentResourceArrayResponse.ts +73 -0
- package/src/models/OrderStatusId.ts +65 -0
- package/src/models/PaginatedOrderFulfillmentResourceResponse.ts +90 -0
- package/src/models/ProductChildLineItemLiteResource.ts +0 -27
- package/src/models/SearchOrderFulfillmentsRequest.ts +181 -0
- package/src/models/StoreFrontendResource.ts +3 -2
- package/src/models/StoreListResource.ts +2 -3
- package/src/models/StoreSpecialDateResource.ts +4 -3
- package/src/models/index.ts +9 -7
- package/dist/models/CartCouponLiteResource.d.ts +0 -56
- package/dist/models/CartCouponLiteResource.js +0 -67
- package/dist/models/CartCouponLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/CartCouponLiteResourceArrayResponse.js +0 -50
- package/dist/models/FrontendCartResource.d.ts +0 -138
- package/dist/models/FrontendCartResource.js +0 -119
- package/dist/models/FrontendCartResourceArrayResponse.d.ts +0 -33
- package/dist/models/FrontendCartResourceArrayResponse.js +0 -50
- package/dist/models/FrontendCartResourceCouponsInner.d.ts +0 -56
- package/dist/models/FrontendCartResourceCouponsInner.js +0 -57
- package/dist/models/FrontendLineItemResource.d.ts +0 -81
- package/dist/models/FrontendLineItemResource.js +0 -82
- package/dist/models/FrontendLineItemResourceArrayResponse.d.ts +0 -33
- package/dist/models/FrontendLineItemResourceArrayResponse.js +0 -50
- package/docs/FrontendCartResource.md +0 -68
- package/docs/FrontendLineItemResource.md +0 -50
- package/src/models/CartCouponLiteResource.ts +0 -102
- package/src/models/CartCouponLiteResourceArrayResponse.ts +0 -73
- package/src/models/FrontendCartResource.ts +0 -246
- package/src/models/FrontendCartResourceArrayResponse.ts +0 -73
- package/src/models/FrontendCartResourceCouponsInner.ts +0 -97
- package/src/models/FrontendLineItemResource.ts +0 -145
- package/src/models/FrontendLineItemResourceArrayResponse.ts +0 -73
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
|
|
2
|
+
# AdminOrderLineItemResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`quantity` | number
|
|
11
|
+
`productPrice` | number
|
|
12
|
+
`labelId` | number
|
|
13
|
+
`productDiscount` | number
|
|
14
|
+
`totalDiscount` | number
|
|
15
|
+
`lineSubtotal` | number
|
|
16
|
+
`discounts` | object
|
|
17
|
+
`productChild` | [ProductChildLineItemLiteResource](ProductChildLineItemLiteResource.md)
|
|
18
|
+
`quantityFulfilled` | number
|
|
19
|
+
`returnsQuantity` | number
|
|
20
|
+
`lastDateShipped` | string
|
|
21
|
+
`lastTrackingNumber` | string
|
|
22
|
+
`lastTrackingUrl` | string
|
|
23
|
+
`totalShipments` | number
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import type { AdminOrderLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
29
|
+
|
|
30
|
+
// TODO: Update the object below with actual values
|
|
31
|
+
const example = {
|
|
32
|
+
"id": null,
|
|
33
|
+
"quantity": null,
|
|
34
|
+
"productPrice": null,
|
|
35
|
+
"labelId": null,
|
|
36
|
+
"productDiscount": null,
|
|
37
|
+
"totalDiscount": null,
|
|
38
|
+
"lineSubtotal": null,
|
|
39
|
+
"discounts": null,
|
|
40
|
+
"productChild": null,
|
|
41
|
+
"quantityFulfilled": null,
|
|
42
|
+
"returnsQuantity": null,
|
|
43
|
+
"lastDateShipped": null,
|
|
44
|
+
"lastTrackingNumber": null,
|
|
45
|
+
"lastTrackingUrl": null,
|
|
46
|
+
"totalShipments": null,
|
|
47
|
+
} satisfies AdminOrderLineItemResource
|
|
48
|
+
|
|
49
|
+
console.log(example)
|
|
50
|
+
|
|
51
|
+
// Convert the instance to a JSON string
|
|
52
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
53
|
+
console.log(exampleJSON)
|
|
54
|
+
|
|
55
|
+
// Parse the JSON string back to an object
|
|
56
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminOrderLineItemResource
|
|
57
|
+
console.log(exampleParsed)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
61
|
+
|
|
62
|
+
|
|
@@ -1,30 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AdminOrderLineItemResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
10
|
-
`code` | string
|
|
11
|
-
`name` | string
|
|
12
|
-
`discount` | number
|
|
13
|
-
`appliesTo` | string
|
|
9
|
+
`data` | [Array<AdminOrderLineItemResource>](AdminOrderLineItemResource.md)
|
|
14
10
|
|
|
15
11
|
## Example
|
|
16
12
|
|
|
17
13
|
```typescript
|
|
18
|
-
import type {
|
|
14
|
+
import type { AdminOrderLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
15
|
|
|
20
16
|
// TODO: Update the object below with actual values
|
|
21
17
|
const example = {
|
|
22
|
-
"
|
|
23
|
-
|
|
24
|
-
"name": null,
|
|
25
|
-
"discount": null,
|
|
26
|
-
"appliesTo": null,
|
|
27
|
-
} satisfies CartCouponLiteResource
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies AdminOrderLineItemResourceArrayResponse
|
|
28
20
|
|
|
29
21
|
console.log(example)
|
|
30
22
|
|
|
@@ -33,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
33
25
|
console.log(exampleJSON)
|
|
34
26
|
|
|
35
27
|
// Parse the JSON string back to an object
|
|
36
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminOrderLineItemResourceArrayResponse
|
|
37
29
|
console.log(exampleParsed)
|
|
38
30
|
```
|
|
39
31
|
|
|
@@ -37,10 +37,13 @@ Name | Type
|
|
|
37
37
|
`totalOutstanding` | number
|
|
38
38
|
`insuranceEstimate` | number
|
|
39
39
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
40
|
+
`fulfillmentStatus` | string
|
|
41
|
+
`fulfillmentsCount` | object
|
|
42
|
+
`latestFulfillment` | [OrderFulfillmentResource](OrderFulfillmentResource.md)
|
|
40
43
|
`customer` | [CustomerResource](CustomerResource.md)
|
|
41
44
|
`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
|
|
42
45
|
`status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
|
|
43
|
-
`lineItems` | [Array<
|
|
46
|
+
`lineItems` | [Array<AdminOrderLineItemResource>](AdminOrderLineItemResource.md)
|
|
44
47
|
`coupons` | [Array<CartCouponResource>](CartCouponResource.md)
|
|
45
48
|
`discounts` | [Array<DiscountResource>](DiscountResource.md)
|
|
46
49
|
`transactions` | [Array<TransactionLiteResource>](TransactionLiteResource.md)
|
|
@@ -86,6 +89,9 @@ const example = {
|
|
|
86
89
|
"totalOutstanding": null,
|
|
87
90
|
"insuranceEstimate": null,
|
|
88
91
|
"site": null,
|
|
92
|
+
"fulfillmentStatus": null,
|
|
93
|
+
"fulfillmentsCount": null,
|
|
94
|
+
"latestFulfillment": null,
|
|
89
95
|
"customer": null,
|
|
90
96
|
"admin": null,
|
|
91
97
|
"status": null,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderFulfillmentLineItemResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -7,24 +7,20 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
11
|
-
`
|
|
12
|
-
`discount` | number
|
|
13
|
-
`appliesTo` | string
|
|
10
|
+
`quantity` | number
|
|
11
|
+
`lineItem` | [AdminOrderLineItemResource](AdminOrderLineItemResource.md)
|
|
14
12
|
|
|
15
13
|
## Example
|
|
16
14
|
|
|
17
15
|
```typescript
|
|
18
|
-
import type {
|
|
16
|
+
import type { OrderFulfillmentLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
17
|
|
|
20
18
|
// TODO: Update the object below with actual values
|
|
21
19
|
const example = {
|
|
22
20
|
"id": null,
|
|
23
|
-
"
|
|
24
|
-
"
|
|
25
|
-
|
|
26
|
-
"appliesTo": null,
|
|
27
|
-
} satisfies FrontendCartResourceCouponsInner
|
|
21
|
+
"quantity": null,
|
|
22
|
+
"lineItem": null,
|
|
23
|
+
} satisfies OrderFulfillmentLineItemResource
|
|
28
24
|
|
|
29
25
|
console.log(example)
|
|
30
26
|
|
|
@@ -33,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
33
29
|
console.log(exampleJSON)
|
|
34
30
|
|
|
35
31
|
// Parse the JSON string back to an object
|
|
36
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderFulfillmentLineItemResource
|
|
37
33
|
console.log(exampleParsed)
|
|
38
34
|
```
|
|
39
35
|
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderFulfillmentLineItemResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<OrderFulfillmentLineItemResource>](OrderFulfillmentLineItemResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { OrderFulfillmentLineItemResourceArrayResponse } 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 OrderFulfillmentLineItemResourceArrayResponse
|
|
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 OrderFulfillmentLineItemResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
|
|
2
|
+
# OrderFulfillmentResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`orderId` | number
|
|
11
|
+
`dateShipped` | Date
|
|
12
|
+
`trackingNumber` | string
|
|
13
|
+
`trackingUrl` | string
|
|
14
|
+
`trackingCompany` | string
|
|
15
|
+
`docnum` | string
|
|
16
|
+
`createdAt` | Date
|
|
17
|
+
`updatedAt` | Date
|
|
18
|
+
`orderFulfillmentLineItems` | [Array<OrderFulfillmentLineItemResource>](OrderFulfillmentLineItemResource.md)
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { OrderFulfillmentResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"id": null,
|
|
28
|
+
"orderId": null,
|
|
29
|
+
"dateShipped": null,
|
|
30
|
+
"trackingNumber": null,
|
|
31
|
+
"trackingUrl": null,
|
|
32
|
+
"trackingCompany": null,
|
|
33
|
+
"docnum": null,
|
|
34
|
+
"createdAt": null,
|
|
35
|
+
"updatedAt": null,
|
|
36
|
+
"orderFulfillmentLineItems": null,
|
|
37
|
+
} satisfies OrderFulfillmentResource
|
|
38
|
+
|
|
39
|
+
console.log(example)
|
|
40
|
+
|
|
41
|
+
// Convert the instance to a JSON string
|
|
42
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
43
|
+
console.log(exampleJSON)
|
|
44
|
+
|
|
45
|
+
// Parse the JSON string back to an object
|
|
46
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderFulfillmentResource
|
|
47
|
+
console.log(exampleParsed)
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
51
|
+
|
|
52
|
+
|
package/docs/{FrontendLineItemResourceArrayResponse.md → OrderFulfillmentResourceArrayResponse.md}
RENAMED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderFulfillmentResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<OrderFulfillmentResource>](OrderFulfillmentResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { OrderFulfillmentResourceArrayResponse } 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 OrderFulfillmentResourceArrayResponse
|
|
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 OrderFulfillmentResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -1,22 +1,20 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderStatusId
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<FrontendCartResource>](FrontendCartResource.md)
|
|
10
9
|
|
|
11
10
|
## Example
|
|
12
11
|
|
|
13
12
|
```typescript
|
|
14
|
-
import type {
|
|
13
|
+
import type { OrderStatusId } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
14
|
|
|
16
15
|
// TODO: Update the object below with actual values
|
|
17
16
|
const example = {
|
|
18
|
-
|
|
19
|
-
} satisfies FrontendCartResourceArrayResponse
|
|
17
|
+
} satisfies OrderStatusId
|
|
20
18
|
|
|
21
19
|
console.log(example)
|
|
22
20
|
|
|
@@ -25,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
23
|
console.log(exampleJSON)
|
|
26
24
|
|
|
27
25
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
26
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderStatusId
|
|
29
27
|
console.log(exampleParsed)
|
|
30
28
|
```
|
|
31
29
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -4,6 +4,7 @@ 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 |
|
|
7
8
|
| [**attachCouponOrder**](OrdersApi.md#attachcouponorder) | **POST** /admin-api/orders/{order}/coupons/attach | Auto-generated: attachCouponOrder |
|
|
8
9
|
| [**attachItemOrder**](OrdersApi.md#attachitemorder) | **POST** /admin-api/orders/{order}/line-items/attach | Auto-generated: attachItemOrder |
|
|
9
10
|
| [**destroyOrder**](OrdersApi.md#destroyorder) | **DELETE** /admin-api/orders/{order}/delete | Auto-generated: destroyOrder |
|
|
@@ -19,6 +20,71 @@ All URIs are relative to *http://localhost/api*
|
|
|
19
20
|
|
|
20
21
|
|
|
21
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
|
+
|
|
22
88
|
## attachCouponOrder
|
|
23
89
|
|
|
24
90
|
> AdminOrderResource attachCouponOrder(order, attachCouponRequest)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedOrderFulfillmentResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<OrderFulfillmentResource>](OrderFulfillmentResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedOrderFulfillmentResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"meta": null,
|
|
21
|
+
} satisfies PaginatedOrderFulfillmentResourceResponse
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedOrderFulfillmentResourceResponse
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -12,9 +12,6 @@ Name | Type
|
|
|
12
12
|
`model` | string
|
|
13
13
|
`modelNumber` | string
|
|
14
14
|
`name` | string
|
|
15
|
-
`parentName` | string
|
|
16
|
-
`variantName` | string
|
|
17
|
-
`slug` | string
|
|
18
15
|
`stock` | number
|
|
19
16
|
`salePrice` | number
|
|
20
17
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
@@ -33,9 +30,6 @@ const example = {
|
|
|
33
30
|
"model": null,
|
|
34
31
|
"modelNumber": null,
|
|
35
32
|
"name": null,
|
|
36
|
-
"parentName": null,
|
|
37
|
-
"variantName": null,
|
|
38
|
-
"slug": null,
|
|
39
33
|
"stock": null,
|
|
40
34
|
"salePrice": null,
|
|
41
35
|
"thumbnail": null,
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
|
|
2
|
+
# SearchOrderFulfillmentsRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`search` | string
|
|
10
|
+
`sortBy` | string
|
|
11
|
+
`sortDirection` | string
|
|
12
|
+
`perPage` | number
|
|
13
|
+
`page` | number
|
|
14
|
+
`orderId` | Array<string>
|
|
15
|
+
`beforeDateShipped` | Date
|
|
16
|
+
`afterDateShipped` | Date
|
|
17
|
+
`beforeCreatedAt` | Date
|
|
18
|
+
`afterCreatedAt` | Date
|
|
19
|
+
`relatedId` | number
|
|
20
|
+
`relatedType` | string
|
|
21
|
+
`includesRelations` | boolean
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import type { SearchOrderFulfillmentsRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
27
|
+
|
|
28
|
+
// TODO: Update the object below with actual values
|
|
29
|
+
const example = {
|
|
30
|
+
"search": null,
|
|
31
|
+
"sortBy": null,
|
|
32
|
+
"sortDirection": null,
|
|
33
|
+
"perPage": null,
|
|
34
|
+
"page": null,
|
|
35
|
+
"orderId": null,
|
|
36
|
+
"beforeDateShipped": null,
|
|
37
|
+
"afterDateShipped": null,
|
|
38
|
+
"beforeCreatedAt": null,
|
|
39
|
+
"afterCreatedAt": null,
|
|
40
|
+
"relatedId": null,
|
|
41
|
+
"relatedType": null,
|
|
42
|
+
"includesRelations": null,
|
|
43
|
+
} satisfies SearchOrderFulfillmentsRequest
|
|
44
|
+
|
|
45
|
+
console.log(example)
|
|
46
|
+
|
|
47
|
+
// Convert the instance to a JSON string
|
|
48
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
49
|
+
console.log(exampleJSON)
|
|
50
|
+
|
|
51
|
+
// Parse the JSON string back to an object
|
|
52
|
+
const exampleParsed = JSON.parse(exampleJSON) as SearchOrderFulfillmentsRequest
|
|
53
|
+
console.log(exampleParsed)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
57
|
+
|
|
58
|
+
|
package/package.json
CHANGED
package/src/apis/OrdersApi.ts
CHANGED
|
@@ -48,6 +48,11 @@ 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';
|
|
51
56
|
import {
|
|
52
57
|
type PaginatedOrderListResourceResponse,
|
|
53
58
|
PaginatedOrderListResourceResponseFromJSON,
|
|
@@ -58,6 +63,11 @@ import {
|
|
|
58
63
|
SearchAllOrdersRequestFromJSON,
|
|
59
64
|
SearchAllOrdersRequestToJSON,
|
|
60
65
|
} from '../models/SearchAllOrdersRequest';
|
|
66
|
+
import {
|
|
67
|
+
type SearchOrderFulfillmentsRequest,
|
|
68
|
+
SearchOrderFulfillmentsRequestFromJSON,
|
|
69
|
+
SearchOrderFulfillmentsRequestToJSON,
|
|
70
|
+
} from '../models/SearchOrderFulfillmentsRequest';
|
|
61
71
|
import {
|
|
62
72
|
type SearchOrdersRequest,
|
|
63
73
|
SearchOrdersRequestFromJSON,
|
|
@@ -74,6 +84,10 @@ import {
|
|
|
74
84
|
UpdateOrderRequestToJSON,
|
|
75
85
|
} from '../models/UpdateOrderRequest';
|
|
76
86
|
|
|
87
|
+
export interface AllOrderFulfillmentRequest {
|
|
88
|
+
searchOrderFulfillmentsRequest?: SearchOrderFulfillmentsRequest;
|
|
89
|
+
}
|
|
90
|
+
|
|
77
91
|
export interface AttachCouponOrderRequest {
|
|
78
92
|
order: number;
|
|
79
93
|
attachCouponRequest?: AttachCouponRequest;
|
|
@@ -130,6 +144,46 @@ export interface UpdateOrderOperationRequest {
|
|
|
130
144
|
*/
|
|
131
145
|
export class OrdersApi extends runtime.BaseAPI {
|
|
132
146
|
|
|
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
|
+
|
|
133
187
|
/**
|
|
134
188
|
* Creates request options for attachCouponOrder without sending the request
|
|
135
189
|
*/
|