@digital8/lighting-illusions-ts-sdk 0.0.1971 → 0.0.1972
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/AdminApi.d.ts +0 -17
- package/dist/apis/AdminApi.js +0 -60
- package/dist/apis/OrdersApi.d.ts +17 -0
- package/dist/apis/OrdersApi.js +60 -0
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +1 -3
- package/dist/models/AddressResource.d.ts +2 -2
- package/dist/models/AddressResource.js +4 -4
- package/dist/models/AdminOrderLineItemResource.d.ts +93 -0
- package/dist/models/AdminOrderLineItemResource.js +90 -0
- package/dist/models/AdminOrderLineItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminOrderLineItemResourceArrayResponse.js +50 -0
- package/dist/models/AdminOrderResource.d.ts +12 -0
- package/dist/models/AdminOrderResource.js +6 -0
- package/dist/models/AllOrderFulfillmentRequest.d.ts +108 -0
- package/dist/models/{GetAllAdminNoteRequest.js → AllOrderFulfillmentRequest.js} +20 -18
- package/dist/models/OrderFulfillmentLineItemResource.d.ts +56 -0
- package/dist/models/OrderFulfillmentLineItemResource.js +67 -0
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.js +50 -0
- package/dist/models/OrderFulfillmentResource.d.ts +86 -0
- package/dist/models/OrderFulfillmentResource.js +81 -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/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 +1 -3
- package/dist/models/StoreResource.d.ts +2 -2
- package/dist/models/StoreResource.js +6 -2
- package/dist/models/index.d.ts +9 -4
- package/dist/models/index.js +9 -4
- package/docs/AdminApi.md +0 -66
- package/docs/AdminOrderLineItemResource.md +54 -0
- package/docs/AdminOrderLineItemResourceArrayResponse.md +34 -0
- package/docs/AdminOrderResource.md +4 -0
- package/docs/{GetAllAdminNoteRequest.md → AllOrderFulfillmentRequest.md} +8 -6
- package/docs/OrderFulfillmentLineItemResource.md +42 -0
- package/docs/OrderFulfillmentLineItemResourceArrayResponse.md +34 -0
- package/docs/{AdminNoteResource.md → OrderFulfillmentResource.md} +16 -10
- package/docs/OrderFulfillmentResourceArrayResponse.md +34 -0
- package/docs/{AdminNoteResourceArrayResponse.md → OrderStatusId.md} +4 -6
- package/docs/OrdersApi.md +66 -0
- package/docs/{PaginatedAdminNoteResourceResponse.md → PaginatedOrderFulfillmentResourceResponse.md} +5 -5
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +0 -54
- package/src/apis/OrdersApi.ts +54 -0
- package/src/models/AddressFrontendResource.ts +2 -3
- package/src/models/AddressResource.ts +5 -5
- package/src/models/AdminOrderLineItemResource.ts +163 -0
- package/src/models/AdminOrderLineItemResourceArrayResponse.ts +73 -0
- package/src/models/AdminOrderResource.ts +17 -0
- package/src/models/AllOrderFulfillmentRequest.ts +165 -0
- package/src/models/OrderFulfillmentLineItemResource.ts +102 -0
- package/src/models/OrderFulfillmentLineItemResourceArrayResponse.ts +73 -0
- package/src/models/OrderFulfillmentResource.ts +144 -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/StoreFrontendResource.ts +2 -3
- package/src/models/StoreListResource.ts +2 -3
- package/src/models/StoreResource.ts +6 -4
- package/src/models/index.ts +9 -4
- package/dist/models/AdminNoteResource.d.ts +0 -68
- package/dist/models/AdminNoteResource.js +0 -71
- package/dist/models/AdminNoteResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminNoteResourceArrayResponse.js +0 -50
- package/dist/models/GetAllAdminNoteRequest.d.ts +0 -102
- package/dist/models/PaginatedAdminNoteResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedAdminNoteResourceResponse.js +0 -57
- package/src/models/AdminNoteResource.ts +0 -118
- package/src/models/AdminNoteResourceArrayResponse.ts +0 -73
- package/src/models/GetAllAdminNoteRequest.ts +0 -157
- package/src/models/PaginatedAdminNoteResourceResponse.ts +0 -90
package/docs/AdminApi.md
CHANGED
|
@@ -7,7 +7,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
7
7
|
| [**generateGoogleFeedAdmin**](AdminApi.md#generategooglefeedadmin) | **POST** /admin-api/admin/feeds/google/generate | Auto-generated: generateGoogleFeedAdmin |
|
|
8
8
|
| [**generateSocialFeedAdmin**](AdminApi.md#generatesocialfeedadmin) | **POST** /admin-api/admin/feeds/social/generate | Auto-generated: generateSocialFeedAdmin |
|
|
9
9
|
| [**generateTGNDataFeedAdmin**](AdminApi.md#generatetgndatafeedadmin) | **POST** /admin-api/admin/feeds/tgn-data/generate | Auto-generated: generateTGNDataFeedAdmin |
|
|
10
|
-
| [**getAllAdminNote**](AdminApi.md#getalladminnoteoperation) | **POST** /admin-api/admin/notes/all | Auto-generated: getAllAdminNote |
|
|
11
10
|
|
|
12
11
|
|
|
13
12
|
|
|
@@ -205,68 +204,3 @@ No authorization required
|
|
|
205
204
|
|
|
206
205
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
207
206
|
|
|
208
|
-
|
|
209
|
-
## getAllAdminNote
|
|
210
|
-
|
|
211
|
-
> AdminNoteResourceArrayResponse getAllAdminNote(getAllAdminNoteRequest)
|
|
212
|
-
|
|
213
|
-
Auto-generated: getAllAdminNote
|
|
214
|
-
|
|
215
|
-
### Example
|
|
216
|
-
|
|
217
|
-
```ts
|
|
218
|
-
import {
|
|
219
|
-
Configuration,
|
|
220
|
-
AdminApi,
|
|
221
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
222
|
-
import type { GetAllAdminNoteOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
223
|
-
|
|
224
|
-
async function example() {
|
|
225
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
226
|
-
const api = new AdminApi();
|
|
227
|
-
|
|
228
|
-
const body = {
|
|
229
|
-
// GetAllAdminNoteRequest (optional)
|
|
230
|
-
getAllAdminNoteRequest: ...,
|
|
231
|
-
} satisfies GetAllAdminNoteOperationRequest;
|
|
232
|
-
|
|
233
|
-
try {
|
|
234
|
-
const data = await api.getAllAdminNote(body);
|
|
235
|
-
console.log(data);
|
|
236
|
-
} catch (error) {
|
|
237
|
-
console.error(error);
|
|
238
|
-
}
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
// Run the test
|
|
242
|
-
example().catch(console.error);
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
### Parameters
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
| Name | Type | Description | Notes |
|
|
249
|
-
|------------- | ------------- | ------------- | -------------|
|
|
250
|
-
| **getAllAdminNoteRequest** | [GetAllAdminNoteRequest](GetAllAdminNoteRequest.md) | | [Optional] |
|
|
251
|
-
|
|
252
|
-
### Return type
|
|
253
|
-
|
|
254
|
-
[**AdminNoteResourceArrayResponse**](AdminNoteResourceArrayResponse.md)
|
|
255
|
-
|
|
256
|
-
### Authorization
|
|
257
|
-
|
|
258
|
-
No authorization required
|
|
259
|
-
|
|
260
|
-
### HTTP request headers
|
|
261
|
-
|
|
262
|
-
- **Content-Type**: `application/json`
|
|
263
|
-
- **Accept**: `application/json`
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
### HTTP response details
|
|
267
|
-
| Status code | Description | Response headers |
|
|
268
|
-
|-------------|-------------|------------------|
|
|
269
|
-
| **200** | Successful resource response | - |
|
|
270
|
-
|
|
271
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
272
|
-
|
|
@@ -0,0 +1,54 @@
|
|
|
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` | [ProductChildCartLiteResource](ProductChildCartLiteResource.md)
|
|
18
|
+
`quantityFulfilled` | number
|
|
19
|
+
`returnsQuantity` | number
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import type { AdminOrderLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
25
|
+
|
|
26
|
+
// TODO: Update the object below with actual values
|
|
27
|
+
const example = {
|
|
28
|
+
"id": null,
|
|
29
|
+
"quantity": null,
|
|
30
|
+
"productPrice": null,
|
|
31
|
+
"labelId": null,
|
|
32
|
+
"productDiscount": null,
|
|
33
|
+
"totalDiscount": null,
|
|
34
|
+
"lineSubtotal": null,
|
|
35
|
+
"discounts": null,
|
|
36
|
+
"productChild": null,
|
|
37
|
+
"quantityFulfilled": null,
|
|
38
|
+
"returnsQuantity": null,
|
|
39
|
+
} satisfies AdminOrderLineItemResource
|
|
40
|
+
|
|
41
|
+
console.log(example)
|
|
42
|
+
|
|
43
|
+
// Convert the instance to a JSON string
|
|
44
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
45
|
+
console.log(exampleJSON)
|
|
46
|
+
|
|
47
|
+
// Parse the JSON string back to an object
|
|
48
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminOrderLineItemResource
|
|
49
|
+
console.log(exampleParsed)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
53
|
+
|
|
54
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# AdminOrderLineItemResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<AdminOrderLineItemResource>](AdminOrderLineItemResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AdminOrderLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies AdminOrderLineItemResourceArrayResponse
|
|
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 AdminOrderLineItemResourceArrayResponse
|
|
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
|
+
|
|
@@ -44,6 +44,8 @@ Name | Type
|
|
|
44
44
|
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
45
45
|
`admin` | object
|
|
46
46
|
`status` | Array<number>
|
|
47
|
+
`fulfillmentsCount` | number
|
|
48
|
+
`latestFulfillment` | string
|
|
47
49
|
`lineItems` | object
|
|
48
50
|
`coupons` | object
|
|
49
51
|
`shippingAddress` | object
|
|
@@ -95,6 +97,8 @@ const example = {
|
|
|
95
97
|
"customer": null,
|
|
96
98
|
"admin": null,
|
|
97
99
|
"status": null,
|
|
100
|
+
"fulfillmentsCount": null,
|
|
101
|
+
"latestFulfillment": null,
|
|
98
102
|
"lineItems": null,
|
|
99
103
|
"coupons": null,
|
|
100
104
|
"shippingAddress": null,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AllOrderFulfillmentRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -11,8 +11,9 @@ Name | Type
|
|
|
11
11
|
`sortDirection` | string
|
|
12
12
|
`perPage` | number
|
|
13
13
|
`page` | number
|
|
14
|
-
`adminId` | Array<string>
|
|
15
14
|
`orderId` | Array<string>
|
|
15
|
+
`beforeDateShipped` | Date
|
|
16
|
+
`afterDateShipped` | Date
|
|
16
17
|
`relatedId` | number
|
|
17
18
|
`relatedType` | string
|
|
18
19
|
`includesRelations` | boolean
|
|
@@ -20,7 +21,7 @@ Name | Type
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
22
23
|
```typescript
|
|
23
|
-
import type {
|
|
24
|
+
import type { AllOrderFulfillmentRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
24
25
|
|
|
25
26
|
// TODO: Update the object below with actual values
|
|
26
27
|
const example = {
|
|
@@ -29,12 +30,13 @@ const example = {
|
|
|
29
30
|
"sortDirection": null,
|
|
30
31
|
"perPage": null,
|
|
31
32
|
"page": null,
|
|
32
|
-
"adminId": null,
|
|
33
33
|
"orderId": null,
|
|
34
|
+
"beforeDateShipped": null,
|
|
35
|
+
"afterDateShipped": null,
|
|
34
36
|
"relatedId": null,
|
|
35
37
|
"relatedType": null,
|
|
36
38
|
"includesRelations": null,
|
|
37
|
-
} satisfies
|
|
39
|
+
} satisfies AllOrderFulfillmentRequest
|
|
38
40
|
|
|
39
41
|
console.log(example)
|
|
40
42
|
|
|
@@ -43,7 +45,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
43
45
|
console.log(exampleJSON)
|
|
44
46
|
|
|
45
47
|
// Parse the JSON string back to an object
|
|
46
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
48
|
+
const exampleParsed = JSON.parse(exampleJSON) as AllOrderFulfillmentRequest
|
|
47
49
|
console.log(exampleParsed)
|
|
48
50
|
```
|
|
49
51
|
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# OrderFulfillmentLineItemResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`orderFulfillmentId` | number
|
|
11
|
+
`lineItemId` | number
|
|
12
|
+
`quantity` | number
|
|
13
|
+
`lineItem` | Array<number>
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { OrderFulfillmentLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": null,
|
|
23
|
+
"orderFulfillmentId": null,
|
|
24
|
+
"lineItemId": null,
|
|
25
|
+
"quantity": null,
|
|
26
|
+
"lineItem": null,
|
|
27
|
+
} satisfies OrderFulfillmentLineItemResource
|
|
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 OrderFulfillmentLineItemResource
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# OrderFulfillmentLineItemResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<OrderFulfillmentLineItemResource>](OrderFulfillmentLineItemResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { OrderFulfillmentLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies OrderFulfillmentLineItemResourceArrayResponse
|
|
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 OrderFulfillmentLineItemResourceArrayResponse
|
|
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
|
+
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OrderFulfillmentResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -8,27 +8,33 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
10
|
`orderId` | number
|
|
11
|
-
`
|
|
12
|
-
`
|
|
11
|
+
`dateShipped` | Date
|
|
12
|
+
`trackingNumber` | string
|
|
13
|
+
`trackingUrl` | string
|
|
14
|
+
`trackingCompany` | string
|
|
15
|
+
`docnum` | string
|
|
13
16
|
`createdAt` | Date
|
|
14
17
|
`updatedAt` | Date
|
|
15
|
-
`
|
|
18
|
+
`orderFulfillmentLineItems` | object
|
|
16
19
|
|
|
17
20
|
## Example
|
|
18
21
|
|
|
19
22
|
```typescript
|
|
20
|
-
import type {
|
|
23
|
+
import type { OrderFulfillmentResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
21
24
|
|
|
22
25
|
// TODO: Update the object below with actual values
|
|
23
26
|
const example = {
|
|
24
27
|
"id": null,
|
|
25
28
|
"orderId": null,
|
|
26
|
-
"
|
|
27
|
-
"
|
|
29
|
+
"dateShipped": null,
|
|
30
|
+
"trackingNumber": null,
|
|
31
|
+
"trackingUrl": null,
|
|
32
|
+
"trackingCompany": null,
|
|
33
|
+
"docnum": null,
|
|
28
34
|
"createdAt": null,
|
|
29
35
|
"updatedAt": null,
|
|
30
|
-
"
|
|
31
|
-
} satisfies
|
|
36
|
+
"orderFulfillmentLineItems": null,
|
|
37
|
+
} satisfies OrderFulfillmentResource
|
|
32
38
|
|
|
33
39
|
console.log(example)
|
|
34
40
|
|
|
@@ -37,7 +43,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
37
43
|
console.log(exampleJSON)
|
|
38
44
|
|
|
39
45
|
// Parse the JSON string back to an object
|
|
40
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
46
|
+
const exampleParsed = JSON.parse(exampleJSON) as OrderFulfillmentResource
|
|
41
47
|
console.log(exampleParsed)
|
|
42
48
|
```
|
|
43
49
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# OrderFulfillmentResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<OrderFulfillmentResource>](OrderFulfillmentResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { OrderFulfillmentResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies OrderFulfillmentResourceArrayResponse
|
|
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 OrderFulfillmentResourceArrayResponse
|
|
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
|
+
|
|
@@ -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<AdminNoteResource>](AdminNoteResource.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 AdminNoteResourceArrayResponse
|
|
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#allorderfulfillmentoperation) | **POST** /admin-api/orders/fulfillments/all | Auto-generated: allOrderFulfillment |
|
|
7
8
|
| [**attachCouponOrder**](OrdersApi.md#attachcouponorderoperation) | **POST** /admin-api/orders/{order}/coupon/attach | Auto-generated: attachCouponOrder |
|
|
8
9
|
| [**attachItemOrder**](OrdersApi.md#attachitemorderoperation) | **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(allOrderFulfillmentRequest)
|
|
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 { AllOrderFulfillmentOperationRequest } 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
|
+
// AllOrderFulfillmentRequest (optional)
|
|
44
|
+
allOrderFulfillmentRequest: ...,
|
|
45
|
+
} satisfies AllOrderFulfillmentOperationRequest;
|
|
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
|
+
| **allOrderFulfillmentRequest** | [AllOrderFulfillmentRequest](AllOrderFulfillmentRequest.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, attachCouponOrderRequest)
|
package/docs/{PaginatedAdminNoteResourceResponse.md → PaginatedOrderFulfillmentResourceResponse.md}
RENAMED
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# PaginatedOrderFulfillmentResourceResponse
|
|
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
|
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import type {
|
|
15
|
+
import type { PaginatedOrderFulfillmentResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
16
|
|
|
17
17
|
// TODO: Update the object below with actual values
|
|
18
18
|
const example = {
|
|
19
19
|
"data": null,
|
|
20
20
|
"meta": null,
|
|
21
|
-
} satisfies
|
|
21
|
+
} satisfies PaginatedOrderFulfillmentResourceResponse
|
|
22
22
|
|
|
23
23
|
console.log(example)
|
|
24
24
|
|
|
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
27
27
|
console.log(exampleJSON)
|
|
28
28
|
|
|
29
29
|
// Parse the JSON string back to an object
|
|
30
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedOrderFulfillmentResourceResponse
|
|
31
31
|
console.log(exampleParsed)
|
|
32
32
|
```
|
|
33
33
|
|
package/package.json
CHANGED
package/src/apis/AdminApi.ts
CHANGED
|
@@ -13,21 +13,11 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import * as runtime from '../runtime';
|
|
16
|
-
import {
|
|
17
|
-
type AdminNoteResourceArrayResponse,
|
|
18
|
-
AdminNoteResourceArrayResponseFromJSON,
|
|
19
|
-
AdminNoteResourceArrayResponseToJSON,
|
|
20
|
-
} from '../models/AdminNoteResourceArrayResponse';
|
|
21
16
|
import {
|
|
22
17
|
type GenericResponse,
|
|
23
18
|
GenericResponseFromJSON,
|
|
24
19
|
GenericResponseToJSON,
|
|
25
20
|
} from '../models/GenericResponse';
|
|
26
|
-
import {
|
|
27
|
-
type GetAllAdminNoteRequest,
|
|
28
|
-
GetAllAdminNoteRequestFromJSON,
|
|
29
|
-
GetAllAdminNoteRequestToJSON,
|
|
30
|
-
} from '../models/GetAllAdminNoteRequest';
|
|
31
21
|
import {
|
|
32
22
|
type GetHierarchyProductCategoryRequest,
|
|
33
23
|
GetHierarchyProductCategoryRequestFromJSON,
|
|
@@ -46,10 +36,6 @@ export interface GenerateTGNDataFeedAdminRequest {
|
|
|
46
36
|
getHierarchyProductCategoryRequest?: GetHierarchyProductCategoryRequest;
|
|
47
37
|
}
|
|
48
38
|
|
|
49
|
-
export interface GetAllAdminNoteOperationRequest {
|
|
50
|
-
getAllAdminNoteRequest?: GetAllAdminNoteRequest;
|
|
51
|
-
}
|
|
52
|
-
|
|
53
39
|
/**
|
|
54
40
|
*
|
|
55
41
|
*/
|
|
@@ -175,44 +161,4 @@ export class AdminApi extends runtime.BaseAPI {
|
|
|
175
161
|
return await response.value();
|
|
176
162
|
}
|
|
177
163
|
|
|
178
|
-
/**
|
|
179
|
-
* Creates request options for getAllAdminNote without sending the request
|
|
180
|
-
*/
|
|
181
|
-
async getAllAdminNoteRequestOpts(requestParameters: GetAllAdminNoteOperationRequest): Promise<runtime.RequestOpts> {
|
|
182
|
-
const queryParameters: any = {};
|
|
183
|
-
|
|
184
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
185
|
-
|
|
186
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
let urlPath = `/admin-api/admin/notes/all`;
|
|
190
|
-
|
|
191
|
-
return {
|
|
192
|
-
path: urlPath,
|
|
193
|
-
method: 'POST',
|
|
194
|
-
headers: headerParameters,
|
|
195
|
-
query: queryParameters,
|
|
196
|
-
body: GetAllAdminNoteRequestToJSON(requestParameters['getAllAdminNoteRequest']),
|
|
197
|
-
};
|
|
198
|
-
}
|
|
199
|
-
|
|
200
|
-
/**
|
|
201
|
-
* Auto-generated: getAllAdminNote
|
|
202
|
-
*/
|
|
203
|
-
async getAllAdminNoteRaw(requestParameters: GetAllAdminNoteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminNoteResourceArrayResponse>> {
|
|
204
|
-
const requestOptions = await this.getAllAdminNoteRequestOpts(requestParameters);
|
|
205
|
-
const response = await this.request(requestOptions, initOverrides);
|
|
206
|
-
|
|
207
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => AdminNoteResourceArrayResponseFromJSON(jsonValue));
|
|
208
|
-
}
|
|
209
|
-
|
|
210
|
-
/**
|
|
211
|
-
* Auto-generated: getAllAdminNote
|
|
212
|
-
*/
|
|
213
|
-
async getAllAdminNote(requestParameters: GetAllAdminNoteOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminNoteResourceArrayResponse> {
|
|
214
|
-
const response = await this.getAllAdminNoteRaw(requestParameters, initOverrides);
|
|
215
|
-
return await response.value();
|
|
216
|
-
}
|
|
217
|
-
|
|
218
164
|
}
|