@digital8/lighting-illusions-ts-sdk 0.0.1987 → 0.0.1989
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 +24 -20
- package/README.md +15 -13
- package/dist/apis/AdminApi.d.ts +17 -0
- package/dist/apis/AdminApi.js +60 -0
- package/dist/apis/OrdersApi.d.ts +0 -17
- package/dist/apis/OrdersApi.js +0 -60
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +1 -3
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +1 -3
- 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 +31 -23
- package/dist/models/AdminOrderResource.js +41 -23
- package/dist/models/DiscountResource.d.ts +68 -0
- package/dist/models/DiscountResource.js +73 -0
- package/dist/models/DiscountResourceArrayResponse.d.ts +33 -0
- package/dist/models/DiscountResourceArrayResponse.js +50 -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/LiAdminUserLiteResource.d.ts +50 -0
- package/dist/models/LiAdminUserLiteResource.js +61 -0
- package/dist/models/LiAdminUserLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/LiAdminUserLiteResourceArrayResponse.js +50 -0
- package/dist/models/LineItemListResource.d.ts +8 -1
- package/dist/models/LineItemListResource.js +8 -1
- package/dist/models/OmnisendSyncLiteResource.d.ts +44 -0
- package/dist/models/OmnisendSyncLiteResource.js +59 -0
- package/dist/models/OmnisendSyncLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/OmnisendSyncLiteResourceArrayResponse.js +50 -0
- package/dist/models/OrderListResource.d.ts +5 -4
- package/dist/models/OrderListResource.js +3 -2
- package/dist/models/OrderStatusLiteResource.d.ts +44 -0
- package/dist/models/OrderStatusLiteResource.js +59 -0
- package/dist/models/OrderStatusLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/OrderStatusLiteResourceArrayResponse.js +50 -0
- package/dist/models/PaginatedAdminNoteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedAdminNoteResourceResponse.js +57 -0
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +1 -3
- package/dist/models/StoreResource.d.ts +2 -2
- package/dist/models/StoreResource.js +6 -2
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +1 -3
- package/dist/models/TransactionLiteResource.d.ts +12 -0
- package/dist/models/TransactionLiteResource.js +8 -0
- package/dist/models/UpdateOrderRequest.d.ts +14 -3
- package/dist/models/UpdateOrderRequest.js +6 -5
- package/dist/models/index.d.ts +12 -10
- package/dist/models/index.js +12 -10
- package/docs/AdminApi.md +66 -0
- package/docs/{OrderFulfillmentResource.md → AdminNoteResource.md} +10 -16
- package/docs/{AdminOrderLineItemResourceArrayResponse.md → AdminNoteResourceArrayResponse.md} +5 -5
- package/docs/AdminOrderResource.md +13 -13
- package/docs/{OrderFulfillmentLineItemResource.md → DiscountResource.md} +16 -12
- package/docs/{OrderStatusId.md → DiscountResourceArrayResponse.md} +6 -4
- package/docs/{AllOrderFulfillmentRequest.md → GetAllAdminNoteRequest.md} +6 -12
- package/docs/LiAdminUserLiteResource.md +40 -0
- package/docs/{OrderFulfillmentLineItemResourceArrayResponse.md → LiAdminUserLiteResourceArrayResponse.md} +5 -5
- package/docs/LineItemListResource.md +2 -0
- package/docs/OmnisendSyncLiteResource.md +38 -0
- package/docs/{OrderFulfillmentResourceArrayResponse.md → OmnisendSyncLiteResourceArrayResponse.md} +5 -5
- package/docs/OrderListResource.md +2 -2
- package/docs/OrderStatusLiteResource.md +38 -0
- package/docs/OrderStatusLiteResourceArrayResponse.md +34 -0
- package/docs/OrdersApi.md +0 -66
- package/docs/{PaginatedOrderFulfillmentResourceResponse.md → PaginatedAdminNoteResourceResponse.md} +5 -5
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/TransactionLiteResource.md +4 -0
- package/docs/UpdateOrderRequest.md +5 -1
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +54 -0
- package/src/apis/OrdersApi.ts +0 -54
- package/src/models/AddressFrontendResource.ts +2 -3
- package/src/models/AddressResource.ts +2 -3
- package/src/models/AdminNoteResource.ts +118 -0
- package/src/models/AdminNoteResourceArrayResponse.ts +73 -0
- package/src/models/AdminOrderResource.ts +106 -45
- package/src/models/DiscountResource.ts +119 -0
- package/src/models/DiscountResourceArrayResponse.ts +73 -0
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/GetAllAdminNoteRequest.ts +157 -0
- package/src/models/LiAdminUserLiteResource.ts +92 -0
- package/src/models/LiAdminUserLiteResourceArrayResponse.ts +73 -0
- package/src/models/LineItemListResource.ts +19 -2
- package/src/models/OmnisendSyncLiteResource.ts +84 -0
- package/src/models/OmnisendSyncLiteResourceArrayResponse.ts +73 -0
- package/src/models/OrderListResource.ts +13 -6
- package/src/models/OrderStatusLiteResource.ts +84 -0
- package/src/models/OrderStatusLiteResourceArrayResponse.ts +73 -0
- package/src/models/PaginatedAdminNoteResourceResponse.ts +90 -0
- package/src/models/StoreFrontendResource.ts +2 -3
- package/src/models/StoreResource.ts +6 -4
- package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
- package/src/models/TransactionLiteResource.ts +18 -0
- package/src/models/UpdateOrderRequest.ts +20 -12
- package/src/models/index.ts +12 -10
- package/dist/models/AdminOrderLineItemResource.d.ts +0 -93
- package/dist/models/AdminOrderLineItemResource.js +0 -90
- package/dist/models/AdminOrderLineItemResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminOrderLineItemResourceArrayResponse.js +0 -50
- package/dist/models/AllOrderFulfillmentRequest.d.ts +0 -120
- package/dist/models/AllOrderFulfillmentRequest.js +0 -88
- package/dist/models/OrderFulfillmentLineItemResource.d.ts +0 -56
- package/dist/models/OrderFulfillmentLineItemResource.js +0 -67
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.d.ts +0 -33
- package/dist/models/OrderFulfillmentLineItemResourceArrayResponse.js +0 -50
- package/dist/models/OrderFulfillmentResource.d.ts +0 -86
- package/dist/models/OrderFulfillmentResource.js +0 -83
- 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/UpdateOrderRequestBillingAddress.d.ts +0 -74
- package/dist/models/UpdateOrderRequestBillingAddress.js +0 -65
- package/docs/AdminOrderLineItemResource.md +0 -54
- package/docs/UpdateOrderRequestBillingAddress.md +0 -48
- package/src/models/AdminOrderLineItemResource.ts +0 -163
- package/src/models/AdminOrderLineItemResourceArrayResponse.ts +0 -73
- package/src/models/AllOrderFulfillmentRequest.ts +0 -181
- package/src/models/OrderFulfillmentLineItemResource.ts +0 -102
- package/src/models/OrderFulfillmentLineItemResourceArrayResponse.ts +0 -73
- package/src/models/OrderFulfillmentResource.ts +0 -145
- package/src/models/OrderFulfillmentResourceArrayResponse.ts +0 -73
- package/src/models/OrderStatusId.ts +0 -65
- package/src/models/PaginatedOrderFulfillmentResourceResponse.ts +0 -90
- package/src/models/UpdateOrderRequestBillingAddress.ts +0 -122
package/dist/models/index.js
CHANGED
|
@@ -21,11 +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("./
|
|
25
|
-
__exportStar(require("./
|
|
24
|
+
__exportStar(require("./AdminNoteResource"), exports);
|
|
25
|
+
__exportStar(require("./AdminNoteResourceArrayResponse"), exports);
|
|
26
26
|
__exportStar(require("./AdminOrderResource"), exports);
|
|
27
27
|
__exportStar(require("./AdminOrderResourceArrayResponse"), exports);
|
|
28
|
-
__exportStar(require("./AllOrderFulfillmentRequest"), exports);
|
|
29
28
|
__exportStar(require("./AssetFileForUploadResource"), exports);
|
|
30
29
|
__exportStar(require("./AssetFileForUploadResourceArrayResponse"), exports);
|
|
31
30
|
__exportStar(require("./AssetFrontendResource"), exports);
|
|
@@ -108,6 +107,8 @@ __exportStar(require("./DetachDocumentsProductRangeRequest"), exports);
|
|
|
108
107
|
__exportStar(require("./DetachProductsProductCategoryRequest"), exports);
|
|
109
108
|
__exportStar(require("./DetachStoresSupplierRequest"), exports);
|
|
110
109
|
__exportStar(require("./DetachSuppliersStoreRequest"), exports);
|
|
110
|
+
__exportStar(require("./DiscountResource"), exports);
|
|
111
|
+
__exportStar(require("./DiscountResourceArrayResponse"), exports);
|
|
111
112
|
__exportStar(require("./DiscountType"), exports);
|
|
112
113
|
__exportStar(require("./DiscountValueType"), exports);
|
|
113
114
|
__exportStar(require("./DocumentFileForUploadResource"), exports);
|
|
@@ -125,6 +126,7 @@ __exportStar(require("./ExternalApiLogResourceArrayResponse"), exports);
|
|
|
125
126
|
__exportStar(require("./ExternalApiProvider"), exports);
|
|
126
127
|
__exportStar(require("./ExternalApiSyncStatus"), exports);
|
|
127
128
|
__exportStar(require("./GenericResponse"), exports);
|
|
129
|
+
__exportStar(require("./GetAllAdminNoteRequest"), exports);
|
|
128
130
|
__exportStar(require("./GetAllAttributeRequest"), exports);
|
|
129
131
|
__exportStar(require("./GetAllAttributeValueRequest"), exports);
|
|
130
132
|
__exportStar(require("./GetAllDefinitionRequest"), exports);
|
|
@@ -188,6 +190,8 @@ __exportStar(require("./LabelResource"), exports);
|
|
|
188
190
|
__exportStar(require("./LabelResourceArrayResponse"), exports);
|
|
189
191
|
__exportStar(require("./LiAddressResource"), exports);
|
|
190
192
|
__exportStar(require("./LiAddressResourceArrayResponse"), exports);
|
|
193
|
+
__exportStar(require("./LiAdminUserLiteResource"), exports);
|
|
194
|
+
__exportStar(require("./LiAdminUserLiteResourceArrayResponse"), exports);
|
|
191
195
|
__exportStar(require("./LineItemDiscountResource"), exports);
|
|
192
196
|
__exportStar(require("./LineItemDiscountResourceArrayResponse"), exports);
|
|
193
197
|
__exportStar(require("./LineItemListResource"), exports);
|
|
@@ -213,15 +217,14 @@ __exportStar(require("./ModelAttributeListResource"), exports);
|
|
|
213
217
|
__exportStar(require("./ModelAttributeListResourceArrayResponse"), exports);
|
|
214
218
|
__exportStar(require("./ModelAttributeResource"), exports);
|
|
215
219
|
__exportStar(require("./ModelAttributeResourceArrayResponse"), exports);
|
|
216
|
-
__exportStar(require("./
|
|
217
|
-
__exportStar(require("./
|
|
218
|
-
__exportStar(require("./OrderFulfillmentResource"), exports);
|
|
219
|
-
__exportStar(require("./OrderFulfillmentResourceArrayResponse"), exports);
|
|
220
|
+
__exportStar(require("./OmnisendSyncLiteResource"), exports);
|
|
221
|
+
__exportStar(require("./OmnisendSyncLiteResourceArrayResponse"), exports);
|
|
220
222
|
__exportStar(require("./OrderListResource"), exports);
|
|
221
223
|
__exportStar(require("./OrderListResourceArrayResponse"), exports);
|
|
222
224
|
__exportStar(require("./OrderLiteResource"), exports);
|
|
223
225
|
__exportStar(require("./OrderLiteResourceArrayResponse"), exports);
|
|
224
|
-
__exportStar(require("./
|
|
226
|
+
__exportStar(require("./OrderStatusLiteResource"), exports);
|
|
227
|
+
__exportStar(require("./OrderStatusLiteResourceArrayResponse"), exports);
|
|
225
228
|
__exportStar(require("./OrderStatusWithCountResource"), exports);
|
|
226
229
|
__exportStar(require("./OrderStatusWithCountResourceArrayResponse"), exports);
|
|
227
230
|
__exportStar(require("./OverlayTemplateAssetFrontendResource"), exports);
|
|
@@ -235,6 +238,7 @@ __exportStar(require("./OverlayTemplateLiteResource"), exports);
|
|
|
235
238
|
__exportStar(require("./OverlayTemplateLiteResourceArrayResponse"), exports);
|
|
236
239
|
__exportStar(require("./OverlayTemplateResource"), exports);
|
|
237
240
|
__exportStar(require("./OverlayTemplateResourceArrayResponse"), exports);
|
|
241
|
+
__exportStar(require("./PaginatedAdminNoteResourceResponse"), exports);
|
|
238
242
|
__exportStar(require("./PaginatedAttributeListResourceResponse"), exports);
|
|
239
243
|
__exportStar(require("./PaginatedAttributeLiteResourceResponse"), exports);
|
|
240
244
|
__exportStar(require("./PaginatedAttributeProductTypeRelationResourceResponse"), exports);
|
|
@@ -252,7 +256,6 @@ __exportStar(require("./PaginatedGoogleCategoryResourceResponse"), exports);
|
|
|
252
256
|
__exportStar(require("./PaginatedLabelListResourceResponse"), exports);
|
|
253
257
|
__exportStar(require("./PaginatedMenuListResourceResponse"), exports);
|
|
254
258
|
__exportStar(require("./PaginatedModelAttributeListResourceResponse"), exports);
|
|
255
|
-
__exportStar(require("./PaginatedOrderFulfillmentResourceResponse"), exports);
|
|
256
259
|
__exportStar(require("./PaginatedOrderListResourceResponse"), exports);
|
|
257
260
|
__exportStar(require("./PaginatedOverlayTemplateListResourceResponse"), exports);
|
|
258
261
|
__exportStar(require("./PaginatedOverlayTemplateLiteResourceResponse"), exports);
|
|
@@ -510,7 +513,6 @@ __exportStar(require("./UpdateMenuRequest"), exports);
|
|
|
510
513
|
__exportStar(require("./UpdateMenuRequestMenuItemOrderInner"), exports);
|
|
511
514
|
__exportStar(require("./UpdateModelAttributeRequest"), exports);
|
|
512
515
|
__exportStar(require("./UpdateOrderRequest"), exports);
|
|
513
|
-
__exportStar(require("./UpdateOrderRequestBillingAddress"), exports);
|
|
514
516
|
__exportStar(require("./UpdateOverlayTemplateAssetRequest"), exports);
|
|
515
517
|
__exportStar(require("./UpdateOverlayTemplateRequest"), exports);
|
|
516
518
|
__exportStar(require("./UpdateProductCategoryRequest"), exports);
|
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
|
+
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AdminNoteResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -8,33 +8,27 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
10
|
`orderId` | number
|
|
11
|
-
`
|
|
12
|
-
`
|
|
13
|
-
`trackingUrl` | string
|
|
14
|
-
`trackingCompany` | string
|
|
15
|
-
`docnum` | string
|
|
11
|
+
`adminId` | number
|
|
12
|
+
`note` | string
|
|
16
13
|
`createdAt` | Date
|
|
17
14
|
`updatedAt` | Date
|
|
18
|
-
`
|
|
15
|
+
`admin` | Array<number>
|
|
19
16
|
|
|
20
17
|
## Example
|
|
21
18
|
|
|
22
19
|
```typescript
|
|
23
|
-
import type {
|
|
20
|
+
import type { AdminNoteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
24
21
|
|
|
25
22
|
// TODO: Update the object below with actual values
|
|
26
23
|
const example = {
|
|
27
24
|
"id": null,
|
|
28
25
|
"orderId": null,
|
|
29
|
-
"
|
|
30
|
-
"
|
|
31
|
-
"trackingUrl": null,
|
|
32
|
-
"trackingCompany": null,
|
|
33
|
-
"docnum": null,
|
|
26
|
+
"adminId": null,
|
|
27
|
+
"note": null,
|
|
34
28
|
"createdAt": null,
|
|
35
29
|
"updatedAt": null,
|
|
36
|
-
"
|
|
37
|
-
} satisfies
|
|
30
|
+
"admin": null,
|
|
31
|
+
} satisfies AdminNoteResource
|
|
38
32
|
|
|
39
33
|
console.log(example)
|
|
40
34
|
|
|
@@ -43,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
43
37
|
console.log(exampleJSON)
|
|
44
38
|
|
|
45
39
|
// Parse the JSON string back to an object
|
|
46
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminNoteResource
|
|
47
41
|
console.log(exampleParsed)
|
|
48
42
|
```
|
|
49
43
|
|
package/docs/{AdminOrderLineItemResourceArrayResponse.md → AdminNoteResourceArrayResponse.md}
RENAMED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AdminNoteResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<AdminNoteResource>](AdminNoteResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { AdminNoteResourceArrayResponse } 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 AdminNoteResourceArrayResponse
|
|
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 AdminNoteResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -20,10 +20,10 @@ Name | Type
|
|
|
20
20
|
`includeInsurance` | boolean
|
|
21
21
|
`overrideInsurance` | boolean
|
|
22
22
|
`useAsBillingAddress` | boolean
|
|
23
|
-
`netsuiteId` |
|
|
23
|
+
`netsuiteId` | number
|
|
24
24
|
`isNetsuiteLocked` | boolean
|
|
25
25
|
`isDisabled` | boolean
|
|
26
|
-
`omnisendId` |
|
|
26
|
+
`omnisendId` | number
|
|
27
27
|
`subtotal` | number
|
|
28
28
|
`productDiscountAmount` | number
|
|
29
29
|
`subtotalDiscountAmount` | number
|
|
@@ -42,15 +42,15 @@ Name | Type
|
|
|
42
42
|
`insuranceEstimate` | number
|
|
43
43
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
44
44
|
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
45
|
-
`admin` |
|
|
46
|
-
`status` |
|
|
47
|
-
`
|
|
48
|
-
`
|
|
49
|
-
`
|
|
50
|
-
`
|
|
51
|
-
`shippingAddress` |
|
|
52
|
-
`billingAddress` |
|
|
53
|
-
`omnisendSync` |
|
|
45
|
+
`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
|
|
46
|
+
`status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
|
|
47
|
+
`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
|
|
48
|
+
`coupons` | [Array<CartCouponResource>](CartCouponResource.md)
|
|
49
|
+
`discounts` | [Array<DiscountResource>](DiscountResource.md)
|
|
50
|
+
`transactions` | [Array<TransactionLiteResource>](TransactionLiteResource.md)
|
|
51
|
+
`shippingAddress` | [AddressResource](AddressResource.md)
|
|
52
|
+
`billingAddress` | [AddressResource](AddressResource.md)
|
|
53
|
+
`omnisendSync` | [OmnisendSyncLiteResource](OmnisendSyncLiteResource.md)
|
|
54
54
|
|
|
55
55
|
## Example
|
|
56
56
|
|
|
@@ -97,10 +97,10 @@ const example = {
|
|
|
97
97
|
"customer": null,
|
|
98
98
|
"admin": null,
|
|
99
99
|
"status": null,
|
|
100
|
-
"fulfillmentsCount": null,
|
|
101
|
-
"latestFulfillment": null,
|
|
102
100
|
"lineItems": null,
|
|
103
101
|
"coupons": null,
|
|
102
|
+
"discounts": null,
|
|
103
|
+
"transactions": null,
|
|
104
104
|
"shippingAddress": null,
|
|
105
105
|
"billingAddress": null,
|
|
106
106
|
"omnisendSync": null,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# DiscountResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -7,24 +7,28 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
11
|
-
`
|
|
12
|
-
`
|
|
13
|
-
`
|
|
10
|
+
`discountType` | string
|
|
11
|
+
`discountValueType` | string
|
|
12
|
+
`discountValue` | number
|
|
13
|
+
`itemId` | number
|
|
14
|
+
`name` | string
|
|
15
|
+
`couponCode` | string
|
|
14
16
|
|
|
15
17
|
## Example
|
|
16
18
|
|
|
17
19
|
```typescript
|
|
18
|
-
import type {
|
|
20
|
+
import type { DiscountResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
21
|
|
|
20
22
|
// TODO: Update the object below with actual values
|
|
21
23
|
const example = {
|
|
22
24
|
"id": null,
|
|
23
|
-
"
|
|
24
|
-
"
|
|
25
|
-
"
|
|
26
|
-
"
|
|
27
|
-
|
|
25
|
+
"discountType": null,
|
|
26
|
+
"discountValueType": null,
|
|
27
|
+
"discountValue": null,
|
|
28
|
+
"itemId": null,
|
|
29
|
+
"name": null,
|
|
30
|
+
"couponCode": null,
|
|
31
|
+
} satisfies DiscountResource
|
|
28
32
|
|
|
29
33
|
console.log(example)
|
|
30
34
|
|
|
@@ -33,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
33
37
|
console.log(exampleJSON)
|
|
34
38
|
|
|
35
39
|
// Parse the JSON string back to an object
|
|
36
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as DiscountResource
|
|
37
41
|
console.log(exampleParsed)
|
|
38
42
|
```
|
|
39
43
|
|
|
@@ -1,20 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# DiscountResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`data` | [Array<DiscountResource>](DiscountResource.md)
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
12
13
|
```typescript
|
|
13
|
-
import type {
|
|
14
|
+
import type { DiscountResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
14
15
|
|
|
15
16
|
// TODO: Update the object below with actual values
|
|
16
17
|
const example = {
|
|
17
|
-
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies DiscountResourceArrayResponse
|
|
18
20
|
|
|
19
21
|
console.log(example)
|
|
20
22
|
|
|
@@ -23,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
23
25
|
console.log(exampleJSON)
|
|
24
26
|
|
|
25
27
|
// Parse the JSON string back to an object
|
|
26
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as DiscountResourceArrayResponse
|
|
27
29
|
console.log(exampleParsed)
|
|
28
30
|
```
|
|
29
31
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# GetAllAdminNoteRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -11,11 +11,8 @@ Name | Type
|
|
|
11
11
|
`sortDirection` | string
|
|
12
12
|
`perPage` | number
|
|
13
13
|
`page` | number
|
|
14
|
+
`adminId` | Array<string>
|
|
14
15
|
`orderId` | Array<string>
|
|
15
|
-
`beforeDateShipped` | Date
|
|
16
|
-
`afterDateShipped` | Date
|
|
17
|
-
`beforeCreatedAt` | Date
|
|
18
|
-
`afterCreatedAt` | Date
|
|
19
16
|
`relatedId` | number
|
|
20
17
|
`relatedType` | string
|
|
21
18
|
`includesRelations` | boolean
|
|
@@ -23,7 +20,7 @@ Name | Type
|
|
|
23
20
|
## Example
|
|
24
21
|
|
|
25
22
|
```typescript
|
|
26
|
-
import type {
|
|
23
|
+
import type { GetAllAdminNoteRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
27
24
|
|
|
28
25
|
// TODO: Update the object below with actual values
|
|
29
26
|
const example = {
|
|
@@ -32,15 +29,12 @@ const example = {
|
|
|
32
29
|
"sortDirection": null,
|
|
33
30
|
"perPage": null,
|
|
34
31
|
"page": null,
|
|
32
|
+
"adminId": null,
|
|
35
33
|
"orderId": null,
|
|
36
|
-
"beforeDateShipped": null,
|
|
37
|
-
"afterDateShipped": null,
|
|
38
|
-
"beforeCreatedAt": null,
|
|
39
|
-
"afterCreatedAt": null,
|
|
40
34
|
"relatedId": null,
|
|
41
35
|
"relatedType": null,
|
|
42
36
|
"includesRelations": null,
|
|
43
|
-
} satisfies
|
|
37
|
+
} satisfies GetAllAdminNoteRequest
|
|
44
38
|
|
|
45
39
|
console.log(example)
|
|
46
40
|
|
|
@@ -49,7 +43,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
49
43
|
console.log(exampleJSON)
|
|
50
44
|
|
|
51
45
|
// Parse the JSON string back to an object
|
|
52
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
46
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetAllAdminNoteRequest
|
|
53
47
|
console.log(exampleParsed)
|
|
54
48
|
```
|
|
55
49
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# LiAdminUserLiteResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`firstName` | string
|
|
11
|
+
`lastName` | string
|
|
12
|
+
`email` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { LiAdminUserLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"id": null,
|
|
22
|
+
"firstName": null,
|
|
23
|
+
"lastName": null,
|
|
24
|
+
"email": null,
|
|
25
|
+
} satisfies LiAdminUserLiteResource
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as LiAdminUserLiteResource
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# LiAdminUserLiteResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<LiAdminUserLiteResource>](LiAdminUserLiteResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { LiAdminUserLiteResourceArrayResponse } 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 LiAdminUserLiteResourceArrayResponse
|
|
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 LiAdminUserLiteResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`quantity` | number
|
|
11
11
|
`productPrice` | number
|
|
12
12
|
`labelId` | number
|
|
13
|
+
`label` | [LabelLiteResource](LabelLiteResource.md)
|
|
13
14
|
`productDiscount` | number
|
|
14
15
|
`totalDiscount` | number
|
|
15
16
|
`lineSubtotal` | number
|
|
@@ -27,6 +28,7 @@ const example = {
|
|
|
27
28
|
"quantity": null,
|
|
28
29
|
"productPrice": null,
|
|
29
30
|
"labelId": null,
|
|
31
|
+
"label": null,
|
|
30
32
|
"productDiscount": null,
|
|
31
33
|
"totalDiscount": null,
|
|
32
34
|
"lineSubtotal": null,
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# OmnisendSyncLiteResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`omnisendId` | number
|
|
11
|
+
`syncStatus` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { OmnisendSyncLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"id": null,
|
|
21
|
+
"omnisendId": null,
|
|
22
|
+
"syncStatus": null,
|
|
23
|
+
} satisfies OmnisendSyncLiteResource
|
|
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 OmnisendSyncLiteResource
|
|
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/{OrderFulfillmentResourceArrayResponse.md → OmnisendSyncLiteResourceArrayResponse.md}
RENAMED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# OmnisendSyncLiteResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<OmnisendSyncLiteResource>](OmnisendSyncLiteResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { OmnisendSyncLiteResourceArrayResponse } 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 OmnisendSyncLiteResourceArrayResponse
|
|
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 OmnisendSyncLiteResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -16,10 +16,10 @@ Name | Type
|
|
|
16
16
|
`isNetsuiteLocked` | boolean
|
|
17
17
|
`subtotal` | number
|
|
18
18
|
`finalTotalAmount` | number
|
|
19
|
-
`cartStatusContext` |
|
|
19
|
+
`cartStatusContext` | string
|
|
20
20
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
21
21
|
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
22
|
-
`status` |
|
|
22
|
+
`status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
|
|
23
23
|
`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
|
|
24
24
|
`transactions` | [Array<TransactionLiteResource>](TransactionLiteResource.md)
|
|
25
25
|
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# OrderStatusLiteResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`isOrderNetsuiteSyncable` | boolean
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { OrderStatusLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"id": null,
|
|
21
|
+
"name": null,
|
|
22
|
+
"isOrderNetsuiteSyncable": null,
|
|
23
|
+
} satisfies OrderStatusLiteResource
|
|
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 OrderStatusLiteResource
|
|
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
|
+
|