@digital8/lighting-illusions-ts-sdk 0.0.1901 → 0.0.1903
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 +38 -0
- package/README.md +32 -2
- package/dist/apis/AdminApi.d.ts +16 -1
- package/dist/apis/AdminApi.js +58 -0
- package/dist/apis/CartsApi.d.ts +16 -1
- package/dist/apis/CartsApi.js +59 -0
- package/dist/apis/OrdersApi.d.ts +170 -0
- package/dist/apis/OrdersApi.js +678 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +3 -1
- package/dist/models/AddressResource.d.ts +3 -3
- package/dist/models/AddressResource.js +7 -7
- package/dist/models/AdminNoteResource.d.ts +68 -0
- package/dist/models/AdminNoteResource.js +71 -0
- package/dist/models/AdminNoteResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminNoteResourceArrayResponse.js +50 -0
- package/dist/models/AdminOrderResource.d.ts +262 -0
- package/dist/models/AdminOrderResource.js +187 -0
- package/dist/models/AdminOrderResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminOrderResourceArrayResponse.js +50 -0
- package/dist/models/AttachItemOrderRequest.d.ts +44 -0
- package/dist/models/AttachItemOrderRequest.js +57 -0
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +3 -1
- package/dist/models/GetAllAdminNoteRequest.d.ts +102 -0
- package/dist/models/GetAllAdminNoteRequest.js +82 -0
- package/dist/models/GetAllOrderRequest.d.ts +104 -0
- package/dist/models/GetAllOrderRequest.js +84 -0
- package/dist/models/IndexOrderRequest.d.ts +140 -0
- package/dist/models/IndexOrderRequest.js +96 -0
- package/dist/models/LineItemListResource.d.ts +6 -0
- package/dist/models/LineItemListResource.js +2 -0
- package/dist/models/OrderListResource.d.ts +101 -0
- package/dist/models/OrderListResource.js +90 -0
- package/dist/models/OrderListResourceArrayResponse.d.ts +33 -0
- package/dist/models/OrderListResourceArrayResponse.js +50 -0
- package/dist/models/OrderLiteResource.d.ts +62 -0
- package/dist/models/OrderLiteResource.js +67 -0
- package/dist/models/OrderLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/OrderLiteResourceArrayResponse.js +50 -0
- package/dist/models/PaginatedAdminNoteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedAdminNoteResourceResponse.js +57 -0
- package/dist/models/PaginatedOrderListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedOrderListResourceResponse.js +57 -0
- package/dist/models/ProductChildCartLiteResource.d.ts +18 -0
- package/dist/models/ProductChildCartLiteResource.js +12 -0
- package/dist/models/StoreCartRequestShippingAddress.d.ts +2 -2
- package/dist/models/StoreCartRequestShippingAddress.js +2 -2
- package/dist/models/StoreListResource.d.ts +2 -2
- package/dist/models/StoreListResource.js +4 -4
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +1 -3
- package/dist/models/StoreStoreRequestAddress.d.ts +0 -6
- package/dist/models/StoreStoreRequestAddress.js +0 -2
- package/dist/models/UpdateItemOrderRequest.d.ts +38 -0
- package/dist/models/UpdateItemOrderRequest.js +53 -0
- package/dist/models/UpdateOrderRequest.d.ts +111 -0
- package/dist/models/UpdateOrderRequest.js +99 -0
- package/dist/models/UpdateOrderRequestBillingAddress.d.ts +80 -0
- package/dist/models/UpdateOrderRequestBillingAddress.js +67 -0
- package/dist/models/UpdateOrderRequestShippingAddress.d.ts +80 -0
- package/dist/models/UpdateOrderRequestShippingAddress.js +67 -0
- package/dist/models/index.d.ts +18 -0
- package/dist/models/index.js +18 -0
- package/docs/AddressResource.md +2 -2
- package/docs/AdminApi.md +66 -0
- package/docs/AdminNoteResource.md +46 -0
- package/docs/AdminNoteResourceArrayResponse.md +34 -0
- package/docs/AdminOrderResource.md +110 -0
- package/docs/AdminOrderResourceArrayResponse.md +34 -0
- package/docs/AttachItemOrderRequest.md +38 -0
- package/docs/CartsApi.md +66 -0
- package/docs/GetAllAdminNoteRequest.md +52 -0
- package/docs/GetAllOrderRequest.md +52 -0
- package/docs/IndexOrderRequest.md +64 -0
- package/docs/LineItemListResource.md +2 -0
- package/docs/OrderListResource.md +56 -0
- package/docs/OrderListResourceArrayResponse.md +34 -0
- package/docs/OrderLiteResource.md +44 -0
- package/docs/OrderLiteResourceArrayResponse.md +34 -0
- package/docs/OrdersApi.md +675 -0
- package/docs/PaginatedAdminNoteResourceResponse.md +36 -0
- package/docs/PaginatedOrderListResourceResponse.md +36 -0
- package/docs/ProductChildCartLiteResource.md +6 -0
- package/docs/StoreCartRequestShippingAddress.md +2 -2
- package/docs/StoreStoreRequestAddress.md +0 -2
- package/docs/UpdateItemOrderRequest.md +36 -0
- package/docs/UpdateOrderRequest.md +52 -0
- package/docs/UpdateOrderRequestBillingAddress.md +50 -0
- package/docs/UpdateOrderRequestShippingAddress.md +50 -0
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +50 -0
- package/src/apis/CartsApi.ts +52 -0
- package/src/apis/OrdersApi.ts +552 -0
- package/src/apis/index.ts +1 -0
- package/src/models/AddressFrontendResource.ts +3 -2
- package/src/models/AddressResource.ts +9 -9
- package/src/models/AdminNoteResource.ts +118 -0
- package/src/models/AdminNoteResourceArrayResponse.ts +73 -0
- package/src/models/AdminOrderResource.ts +414 -0
- package/src/models/AdminOrderResourceArrayResponse.ts +73 -0
- package/src/models/AttachItemOrderRequest.ts +83 -0
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/GetAllAdminNoteRequest.ts +157 -0
- package/src/models/GetAllOrderRequest.ts +159 -0
- package/src/models/IndexOrderRequest.ts +207 -0
- package/src/models/LineItemListResource.ts +8 -0
- package/src/models/OrderListResource.ts +183 -0
- package/src/models/OrderListResourceArrayResponse.ts +73 -0
- package/src/models/OrderLiteResource.ts +109 -0
- package/src/models/OrderLiteResourceArrayResponse.ts +73 -0
- package/src/models/PaginatedAdminNoteResourceResponse.ts +90 -0
- package/src/models/PaginatedOrderListResourceResponse.ts +90 -0
- package/src/models/ProductChildCartLiteResource.ts +27 -0
- package/src/models/StoreCartRequestShippingAddress.ts +4 -4
- package/src/models/StoreListResource.ts +5 -5
- package/src/models/StoreResource.ts +2 -3
- package/src/models/StoreStoreRequestAddress.ts +0 -8
- package/src/models/UpdateItemOrderRequest.ts +74 -0
- package/src/models/UpdateOrderRequest.ts +183 -0
- package/src/models/UpdateOrderRequestBillingAddress.ts +130 -0
- package/src/models/UpdateOrderRequestShippingAddress.ts +130 -0
- package/src/models/index.ts +18 -0
package/dist/models/index.js
CHANGED
|
@@ -21,6 +21,10 @@ __exportStar(require("./AddressFrontendResourceArrayResponse"), exports);
|
|
|
21
21
|
__exportStar(require("./AddressResource"), exports);
|
|
22
22
|
__exportStar(require("./AddressResourceArrayResponse"), exports);
|
|
23
23
|
__exportStar(require("./AddressType"), exports);
|
|
24
|
+
__exportStar(require("./AdminNoteResource"), exports);
|
|
25
|
+
__exportStar(require("./AdminNoteResourceArrayResponse"), exports);
|
|
26
|
+
__exportStar(require("./AdminOrderResource"), exports);
|
|
27
|
+
__exportStar(require("./AdminOrderResourceArrayResponse"), exports);
|
|
24
28
|
__exportStar(require("./AssetFileForUploadResource"), exports);
|
|
25
29
|
__exportStar(require("./AssetFileForUploadResourceArrayResponse"), exports);
|
|
26
30
|
__exportStar(require("./AssetFrontendResource"), exports);
|
|
@@ -44,6 +48,7 @@ __exportStar(require("./AttachDocumentsProductChildRequest"), exports);
|
|
|
44
48
|
__exportStar(require("./AttachDocumentsProductChildRequestDocumentsInner"), exports);
|
|
45
49
|
__exportStar(require("./AttachDocumentsProductRangeRequest"), exports);
|
|
46
50
|
__exportStar(require("./AttachItemCartRequest"), exports);
|
|
51
|
+
__exportStar(require("./AttachItemOrderRequest"), exports);
|
|
47
52
|
__exportStar(require("./AttachProductTypeAttributeRequest"), exports);
|
|
48
53
|
__exportStar(require("./AttachProductsProductCategoryRequest"), exports);
|
|
49
54
|
__exportStar(require("./AttachStoresSupplierRequest"), exports);
|
|
@@ -117,6 +122,7 @@ __exportStar(require("./ExternalApiLogResourceArrayResponse"), exports);
|
|
|
117
122
|
__exportStar(require("./ExternalApiProvider"), exports);
|
|
118
123
|
__exportStar(require("./ExternalApiSyncStatus"), exports);
|
|
119
124
|
__exportStar(require("./GenericResponse"), exports);
|
|
125
|
+
__exportStar(require("./GetAllAdminNoteRequest"), exports);
|
|
120
126
|
__exportStar(require("./GetAllAttributeRequest"), exports);
|
|
121
127
|
__exportStar(require("./GetAllAttributeValueRequest"), exports);
|
|
122
128
|
__exportStar(require("./GetAllDefinitionRequest"), exports);
|
|
@@ -124,6 +130,7 @@ __exportStar(require("./GetAllDocumentRequest"), exports);
|
|
|
124
130
|
__exportStar(require("./GetAllGoogleCategoryRequest"), exports);
|
|
125
131
|
__exportStar(require("./GetAllMenuItemRequest"), exports);
|
|
126
132
|
__exportStar(require("./GetAllMenuRequest"), exports);
|
|
133
|
+
__exportStar(require("./GetAllOrderRequest"), exports);
|
|
127
134
|
__exportStar(require("./GetAllOverlayTemplateRequest"), exports);
|
|
128
135
|
__exportStar(require("./GetAllProductCategoryRequest"), exports);
|
|
129
136
|
__exportStar(require("./GetAllProductChildRequest"), exports);
|
|
@@ -156,6 +163,7 @@ __exportStar(require("./IndexExternalApiLogRequest"), exports);
|
|
|
156
163
|
__exportStar(require("./IndexLabelRequest"), exports);
|
|
157
164
|
__exportStar(require("./IndexMenuRequest"), exports);
|
|
158
165
|
__exportStar(require("./IndexModelAttributeRequest"), exports);
|
|
166
|
+
__exportStar(require("./IndexOrderRequest"), exports);
|
|
159
167
|
__exportStar(require("./IndexOverlayTemplateRequest"), exports);
|
|
160
168
|
__exportStar(require("./IndexProductCategoryRequest"), exports);
|
|
161
169
|
__exportStar(require("./IndexProductChildRequest"), exports);
|
|
@@ -202,6 +210,10 @@ __exportStar(require("./ModelAttributeListResource"), exports);
|
|
|
202
210
|
__exportStar(require("./ModelAttributeListResourceArrayResponse"), exports);
|
|
203
211
|
__exportStar(require("./ModelAttributeResource"), exports);
|
|
204
212
|
__exportStar(require("./ModelAttributeResourceArrayResponse"), exports);
|
|
213
|
+
__exportStar(require("./OrderListResource"), exports);
|
|
214
|
+
__exportStar(require("./OrderListResourceArrayResponse"), exports);
|
|
215
|
+
__exportStar(require("./OrderLiteResource"), exports);
|
|
216
|
+
__exportStar(require("./OrderLiteResourceArrayResponse"), exports);
|
|
205
217
|
__exportStar(require("./OverlayTemplateAssetFrontendResource"), exports);
|
|
206
218
|
__exportStar(require("./OverlayTemplateAssetFrontendResourceArrayResponse"), exports);
|
|
207
219
|
__exportStar(require("./OverlayTemplateAssetPosition"), exports);
|
|
@@ -213,6 +225,7 @@ __exportStar(require("./OverlayTemplateLiteResource"), exports);
|
|
|
213
225
|
__exportStar(require("./OverlayTemplateLiteResourceArrayResponse"), exports);
|
|
214
226
|
__exportStar(require("./OverlayTemplateResource"), exports);
|
|
215
227
|
__exportStar(require("./OverlayTemplateResourceArrayResponse"), exports);
|
|
228
|
+
__exportStar(require("./PaginatedAdminNoteResourceResponse"), exports);
|
|
216
229
|
__exportStar(require("./PaginatedAttributeListResourceResponse"), exports);
|
|
217
230
|
__exportStar(require("./PaginatedAttributeLiteResourceResponse"), exports);
|
|
218
231
|
__exportStar(require("./PaginatedAttributeProductTypeRelationResourceResponse"), exports);
|
|
@@ -230,6 +243,7 @@ __exportStar(require("./PaginatedGoogleCategoryResourceResponse"), exports);
|
|
|
230
243
|
__exportStar(require("./PaginatedLabelListResourceResponse"), exports);
|
|
231
244
|
__exportStar(require("./PaginatedMenuListResourceResponse"), exports);
|
|
232
245
|
__exportStar(require("./PaginatedModelAttributeListResourceResponse"), exports);
|
|
246
|
+
__exportStar(require("./PaginatedOrderListResourceResponse"), exports);
|
|
233
247
|
__exportStar(require("./PaginatedOverlayTemplateListResourceResponse"), exports);
|
|
234
248
|
__exportStar(require("./PaginatedOverlayTemplateLiteResourceResponse"), exports);
|
|
235
249
|
__exportStar(require("./PaginatedOverlayTemplateResourceResponse"), exports);
|
|
@@ -466,11 +480,15 @@ __exportStar(require("./UpdateDocumentRequest"), exports);
|
|
|
466
480
|
__exportStar(require("./UpdateFilterOrderAttributeRequest"), exports);
|
|
467
481
|
__exportStar(require("./UpdateFilterOrderAttributeRequestValuesInner"), exports);
|
|
468
482
|
__exportStar(require("./UpdateItemCartRequest"), exports);
|
|
483
|
+
__exportStar(require("./UpdateItemOrderRequest"), exports);
|
|
469
484
|
__exportStar(require("./UpdateLabelRequest"), exports);
|
|
470
485
|
__exportStar(require("./UpdateMenuItemRequest"), exports);
|
|
471
486
|
__exportStar(require("./UpdateMenuRequest"), exports);
|
|
472
487
|
__exportStar(require("./UpdateMenuRequestMenuItemOrderInner"), exports);
|
|
473
488
|
__exportStar(require("./UpdateModelAttributeRequest"), exports);
|
|
489
|
+
__exportStar(require("./UpdateOrderRequest"), exports);
|
|
490
|
+
__exportStar(require("./UpdateOrderRequestBillingAddress"), exports);
|
|
491
|
+
__exportStar(require("./UpdateOrderRequestShippingAddress"), exports);
|
|
474
492
|
__exportStar(require("./UpdateOverlayTemplateAssetRequest"), exports);
|
|
475
493
|
__exportStar(require("./UpdateOverlayTemplateRequest"), exports);
|
|
476
494
|
__exportStar(require("./UpdateProductCategoryRequest"), exports);
|
package/docs/AddressResource.md
CHANGED
|
@@ -8,8 +8,8 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
10
|
`sourceAddressId` | number
|
|
11
|
-
`addresseeName` | string
|
|
12
11
|
`company` | string
|
|
12
|
+
`addressee` | string
|
|
13
13
|
`line1` | string
|
|
14
14
|
`line2` | string
|
|
15
15
|
`postcode` | string
|
|
@@ -27,8 +27,8 @@ import type { AddressResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
27
27
|
const example = {
|
|
28
28
|
"id": null,
|
|
29
29
|
"sourceAddressId": null,
|
|
30
|
-
"addresseeName": null,
|
|
31
30
|
"company": null,
|
|
31
|
+
"addressee": null,
|
|
32
32
|
"line1": null,
|
|
33
33
|
"line2": null,
|
|
34
34
|
"postcode": null,
|
package/docs/AdminApi.md
CHANGED
|
@@ -7,6 +7,7 @@ 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 |
|
|
10
11
|
|
|
11
12
|
|
|
12
13
|
|
|
@@ -204,3 +205,68 @@ No authorization required
|
|
|
204
205
|
|
|
205
206
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
206
207
|
|
|
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,46 @@
|
|
|
1
|
+
|
|
2
|
+
# AdminNoteResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`orderId` | number
|
|
11
|
+
`adminId` | number
|
|
12
|
+
`note` | string
|
|
13
|
+
`createdAt` | Date
|
|
14
|
+
`updatedAt` | Date
|
|
15
|
+
`admin` | Array<number>
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { AdminNoteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"id": null,
|
|
25
|
+
"orderId": null,
|
|
26
|
+
"adminId": null,
|
|
27
|
+
"note": null,
|
|
28
|
+
"createdAt": null,
|
|
29
|
+
"updatedAt": null,
|
|
30
|
+
"admin": null,
|
|
31
|
+
} satisfies AdminNoteResource
|
|
32
|
+
|
|
33
|
+
console.log(example)
|
|
34
|
+
|
|
35
|
+
// Convert the instance to a JSON string
|
|
36
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
37
|
+
console.log(exampleJSON)
|
|
38
|
+
|
|
39
|
+
// Parse the JSON string back to an object
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminNoteResource
|
|
41
|
+
console.log(exampleParsed)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
45
|
+
|
|
46
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# AdminNoteResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<AdminNoteResource>](AdminNoteResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AdminNoteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies AdminNoteResourceArrayResponse
|
|
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 AdminNoteResourceArrayResponse
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
|
|
2
|
+
# AdminOrderResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`cartId` | number
|
|
11
|
+
`placedAt` | Date
|
|
12
|
+
`createdAt` | Date
|
|
13
|
+
`updatedAt` | Date
|
|
14
|
+
`source` | string
|
|
15
|
+
`paymentToken` | string
|
|
16
|
+
`shippingType` | string
|
|
17
|
+
`shippingSubtotal` | number
|
|
18
|
+
`overrideShipping` | boolean
|
|
19
|
+
`insuranceAmount` | number
|
|
20
|
+
`overrideInsurance` | boolean
|
|
21
|
+
`useAsBillingAddress` | boolean
|
|
22
|
+
`netsuiteId` | string
|
|
23
|
+
`isNetsuiteLocked` | boolean
|
|
24
|
+
`omnisendId` | string
|
|
25
|
+
`subtotal` | number
|
|
26
|
+
`productDiscountAmount` | number
|
|
27
|
+
`cartDiscountAmount` | number
|
|
28
|
+
`shippingDiscountAmount` | number
|
|
29
|
+
`shippingAmount` | number
|
|
30
|
+
`total` | number
|
|
31
|
+
`discountAmount` | number
|
|
32
|
+
`finalTotalAmount` | number
|
|
33
|
+
`totalAmount` | number
|
|
34
|
+
`totalShipping` | number
|
|
35
|
+
`grandTotal` | number
|
|
36
|
+
`discountPreview` | number
|
|
37
|
+
`shippingEstimate` | number
|
|
38
|
+
`insuranceEstimate` | number
|
|
39
|
+
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
40
|
+
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
41
|
+
`admin` | object
|
|
42
|
+
`status` | Array<number>
|
|
43
|
+
`lineItems` | object
|
|
44
|
+
`coupons` | object
|
|
45
|
+
`shippingAddress` | object
|
|
46
|
+
`billingAddress` | object
|
|
47
|
+
`omnisendSync` | object
|
|
48
|
+
|
|
49
|
+
## Example
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import type { AdminOrderResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
53
|
+
|
|
54
|
+
// TODO: Update the object below with actual values
|
|
55
|
+
const example = {
|
|
56
|
+
"id": null,
|
|
57
|
+
"cartId": null,
|
|
58
|
+
"placedAt": null,
|
|
59
|
+
"createdAt": null,
|
|
60
|
+
"updatedAt": null,
|
|
61
|
+
"source": null,
|
|
62
|
+
"paymentToken": null,
|
|
63
|
+
"shippingType": null,
|
|
64
|
+
"shippingSubtotal": null,
|
|
65
|
+
"overrideShipping": null,
|
|
66
|
+
"insuranceAmount": null,
|
|
67
|
+
"overrideInsurance": null,
|
|
68
|
+
"useAsBillingAddress": null,
|
|
69
|
+
"netsuiteId": null,
|
|
70
|
+
"isNetsuiteLocked": null,
|
|
71
|
+
"omnisendId": null,
|
|
72
|
+
"subtotal": null,
|
|
73
|
+
"productDiscountAmount": null,
|
|
74
|
+
"cartDiscountAmount": null,
|
|
75
|
+
"shippingDiscountAmount": null,
|
|
76
|
+
"shippingAmount": null,
|
|
77
|
+
"total": null,
|
|
78
|
+
"discountAmount": null,
|
|
79
|
+
"finalTotalAmount": null,
|
|
80
|
+
"totalAmount": null,
|
|
81
|
+
"totalShipping": null,
|
|
82
|
+
"grandTotal": null,
|
|
83
|
+
"discountPreview": null,
|
|
84
|
+
"shippingEstimate": null,
|
|
85
|
+
"insuranceEstimate": null,
|
|
86
|
+
"site": null,
|
|
87
|
+
"customer": null,
|
|
88
|
+
"admin": null,
|
|
89
|
+
"status": null,
|
|
90
|
+
"lineItems": null,
|
|
91
|
+
"coupons": null,
|
|
92
|
+
"shippingAddress": null,
|
|
93
|
+
"billingAddress": null,
|
|
94
|
+
"omnisendSync": null,
|
|
95
|
+
} satisfies AdminOrderResource
|
|
96
|
+
|
|
97
|
+
console.log(example)
|
|
98
|
+
|
|
99
|
+
// Convert the instance to a JSON string
|
|
100
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
101
|
+
console.log(exampleJSON)
|
|
102
|
+
|
|
103
|
+
// Parse the JSON string back to an object
|
|
104
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminOrderResource
|
|
105
|
+
console.log(exampleParsed)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
109
|
+
|
|
110
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# AdminOrderResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<AdminOrderResource>](AdminOrderResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AdminOrderResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies AdminOrderResourceArrayResponse
|
|
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 AdminOrderResourceArrayResponse
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# AttachItemOrderRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`productChildId` | number
|
|
10
|
+
`quantity` | number
|
|
11
|
+
`productPrice` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { AttachItemOrderRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"productChildId": null,
|
|
21
|
+
"quantity": null,
|
|
22
|
+
"productPrice": null,
|
|
23
|
+
} satisfies AttachItemOrderRequest
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as AttachItemOrderRequest
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
package/docs/CartsApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
13
13
|
| [**sendPaymentLinkCart**](CartsApi.md#sendpaymentlinkcart) | **POST** /admin-api/carts/{cart}/send-payment-link | Auto-generated: sendPaymentLinkCart |
|
|
14
14
|
| [**showCart**](CartsApi.md#showcart) | **GET** /admin-api/carts/{cart} | Auto-generated: showCart |
|
|
15
15
|
| [**storeCart**](CartsApi.md#storecartoperation) | **POST** /admin-api/carts/create | Auto-generated: storeCart |
|
|
16
|
+
| [**storeFromCartOrder**](CartsApi.md#storefromcartorder) | **POST** /admin-api/carts/{cart}/place-order | Auto-generated: storeFromCartOrder |
|
|
16
17
|
| [**updateCart**](CartsApi.md#updatecartoperation) | **PUT** /admin-api/carts/{cart}/update | Auto-generated: updateCart |
|
|
17
18
|
| [**updateItemCart**](CartsApi.md#updateitemcartoperation) | **PUT** /admin-api/carts/{cart}/items/{lineItem}/update | Auto-generated: updateItemCart |
|
|
18
19
|
|
|
@@ -615,6 +616,71 @@ No authorization required
|
|
|
615
616
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
616
617
|
|
|
617
618
|
|
|
619
|
+
## storeFromCartOrder
|
|
620
|
+
|
|
621
|
+
> AdminOrderResource storeFromCartOrder(cart)
|
|
622
|
+
|
|
623
|
+
Auto-generated: storeFromCartOrder
|
|
624
|
+
|
|
625
|
+
### Example
|
|
626
|
+
|
|
627
|
+
```ts
|
|
628
|
+
import {
|
|
629
|
+
Configuration,
|
|
630
|
+
CartsApi,
|
|
631
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
632
|
+
import type { StoreFromCartOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
633
|
+
|
|
634
|
+
async function example() {
|
|
635
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
636
|
+
const api = new CartsApi();
|
|
637
|
+
|
|
638
|
+
const body = {
|
|
639
|
+
// number | The id of the cart
|
|
640
|
+
cart: 56,
|
|
641
|
+
} satisfies StoreFromCartOrderRequest;
|
|
642
|
+
|
|
643
|
+
try {
|
|
644
|
+
const data = await api.storeFromCartOrder(body);
|
|
645
|
+
console.log(data);
|
|
646
|
+
} catch (error) {
|
|
647
|
+
console.error(error);
|
|
648
|
+
}
|
|
649
|
+
}
|
|
650
|
+
|
|
651
|
+
// Run the test
|
|
652
|
+
example().catch(console.error);
|
|
653
|
+
```
|
|
654
|
+
|
|
655
|
+
### Parameters
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
| Name | Type | Description | Notes |
|
|
659
|
+
|------------- | ------------- | ------------- | -------------|
|
|
660
|
+
| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
|
|
661
|
+
|
|
662
|
+
### Return type
|
|
663
|
+
|
|
664
|
+
[**AdminOrderResource**](AdminOrderResource.md)
|
|
665
|
+
|
|
666
|
+
### Authorization
|
|
667
|
+
|
|
668
|
+
No authorization required
|
|
669
|
+
|
|
670
|
+
### HTTP request headers
|
|
671
|
+
|
|
672
|
+
- **Content-Type**: Not defined
|
|
673
|
+
- **Accept**: `application/json`
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
### HTTP response details
|
|
677
|
+
| Status code | Description | Response headers |
|
|
678
|
+
|-------------|-------------|------------------|
|
|
679
|
+
| **200** | Successful resource response | - |
|
|
680
|
+
|
|
681
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
682
|
+
|
|
683
|
+
|
|
618
684
|
## updateCart
|
|
619
685
|
|
|
620
686
|
> CartResource updateCart(cart, updateCartRequest)
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
|
|
2
|
+
# GetAllAdminNoteRequest
|
|
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
|
+
`adminId` | Array<string>
|
|
15
|
+
`orderId` | Array<string>
|
|
16
|
+
`relatedId` | number
|
|
17
|
+
`relatedType` | string
|
|
18
|
+
`includesRelations` | boolean
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { GetAllAdminNoteRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"search": null,
|
|
28
|
+
"sortBy": null,
|
|
29
|
+
"sortDirection": null,
|
|
30
|
+
"perPage": null,
|
|
31
|
+
"page": null,
|
|
32
|
+
"adminId": null,
|
|
33
|
+
"orderId": null,
|
|
34
|
+
"relatedId": null,
|
|
35
|
+
"relatedType": null,
|
|
36
|
+
"includesRelations": null,
|
|
37
|
+
} satisfies GetAllAdminNoteRequest
|
|
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 GetAllAdminNoteRequest
|
|
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
|
+
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
|
|
2
|
+
# GetAllOrderRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`search` | string
|
|
10
|
+
`sortBy` | string
|
|
11
|
+
`sortDirection` | string
|
|
12
|
+
`relatedId` | number
|
|
13
|
+
`relatedType` | string
|
|
14
|
+
`includesRelations` | boolean
|
|
15
|
+
`siteId` | Array<string>
|
|
16
|
+
`source` | Array<string>
|
|
17
|
+
`statusId` | Array<string>
|
|
18
|
+
`customerId` | Array<string>
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { GetAllOrderRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"search": null,
|
|
28
|
+
"sortBy": null,
|
|
29
|
+
"sortDirection": null,
|
|
30
|
+
"relatedId": null,
|
|
31
|
+
"relatedType": null,
|
|
32
|
+
"includesRelations": null,
|
|
33
|
+
"siteId": null,
|
|
34
|
+
"source": null,
|
|
35
|
+
"statusId": null,
|
|
36
|
+
"customerId": null,
|
|
37
|
+
} satisfies GetAllOrderRequest
|
|
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 GetAllOrderRequest
|
|
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
|
+
|