@digital8/lighting-illusions-ts-sdk 0.0.1932 → 0.0.1933
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 +8 -8
- package/README.md +7 -8
- package/dist/apis/AdminApi.d.ts +17 -0
- package/dist/apis/AdminApi.js +60 -0
- package/dist/apis/OrdersApi.d.ts +2 -37
- package/dist/apis/OrdersApi.js +1 -126
- package/dist/models/AddressResource.d.ts +0 -6
- package/dist/models/AddressResource.js +0 -4
- 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 +4 -16
- package/dist/models/AdminOrderResource.js +7 -15
- package/dist/models/CartListResource.d.ts +0 -6
- package/dist/models/CartListResource.js +0 -4
- package/dist/models/CartResource.d.ts +3 -15
- package/dist/models/CartResource.js +6 -12
- 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 +0 -1
- package/dist/models/GetAllOrderRequest.js +1 -2
- package/dist/models/IndexOrderRequest.d.ts +0 -1
- package/dist/models/IndexOrderRequest.js +1 -2
- package/dist/models/OrderListResource.d.ts +0 -18
- package/dist/models/OrderListResource.js +0 -10
- package/dist/models/PaginatedAdminNoteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedAdminNoteResourceResponse.js +57 -0
- package/dist/models/StoreCartRequest.d.ts +0 -6
- package/dist/models/StoreCartRequest.js +0 -2
- package/dist/models/StoreCartRequestShippingAddress.d.ts +0 -6
- package/dist/models/StoreCartRequestShippingAddress.js +0 -2
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +1 -3
- package/dist/models/StoreStoreRequestAddress.d.ts +0 -6
- package/dist/models/StoreStoreRequestAddress.js +0 -2
- package/dist/models/UpdateCartRequest.d.ts +0 -6
- package/dist/models/UpdateCartRequest.js +0 -2
- package/dist/models/UpdateOrderRequest.d.ts +0 -6
- package/dist/models/UpdateOrderRequest.js +0 -2
- package/dist/models/UpdateOrderRequestBillingAddress.d.ts +7 -1
- package/dist/models/UpdateOrderRequestBillingAddress.js +5 -3
- package/dist/models/UpdateOrderRequestShippingAddress.d.ts +7 -1
- package/dist/models/UpdateOrderRequestShippingAddress.js +6 -2
- package/dist/models/index.d.ts +4 -4
- package/dist/models/index.js +4 -4
- package/docs/AddressResource.md +0 -2
- package/docs/AdminApi.md +66 -0
- package/docs/{OrderStatusWithCountResource.md → AdminNoteResource.md} +16 -10
- package/docs/{AttachCouponOrderRequest.md → AdminNoteResourceArrayResponse.md} +6 -6
- package/docs/AdminOrderResource.md +3 -7
- package/docs/CartListResource.md +0 -2
- package/docs/CartResource.md +4 -8
- package/docs/GetAllAdminNoteRequest.md +52 -0
- package/docs/OrderListResource.md +0 -6
- package/docs/OrdersApi.md +3 -141
- package/docs/{OrderStatusWithCountResourceArrayResponse.md → PaginatedAdminNoteResourceResponse.md} +7 -5
- package/docs/StoreCartRequest.md +0 -2
- package/docs/StoreCartRequestShippingAddress.md +0 -2
- package/docs/StoreStoreRequestAddress.md +0 -2
- package/docs/UpdateCartRequest.md +0 -2
- package/docs/UpdateOrderRequest.md +0 -2
- package/docs/UpdateOrderRequestBillingAddress.md +4 -2
- package/docs/UpdateOrderRequestShippingAddress.md +4 -2
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +54 -0
- package/src/apis/OrdersApi.ts +3 -124
- package/src/models/AddressResource.ts +0 -9
- package/src/models/AdminNoteResource.ts +118 -0
- package/src/models/AdminNoteResourceArrayResponse.ts +73 -0
- package/src/models/AdminOrderResource.ts +10 -28
- package/src/models/CartListResource.ts +0 -9
- package/src/models/CartResource.ts +9 -26
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/GetAllAdminNoteRequest.ts +157 -0
- package/src/models/GetAllOrderRequest.ts +1 -2
- package/src/models/IndexOrderRequest.ts +1 -2
- package/src/models/OrderListResource.ts +0 -26
- package/src/models/PaginatedAdminNoteResourceResponse.ts +90 -0
- package/src/models/StoreCartRequest.ts +0 -8
- package/src/models/StoreCartRequestShippingAddress.ts +0 -8
- package/src/models/StoreListResource.ts +2 -3
- package/src/models/StoreStoreRequestAddress.ts +0 -8
- package/src/models/UpdateCartRequest.ts +0 -8
- package/src/models/UpdateOrderRequest.ts +0 -8
- package/src/models/UpdateOrderRequestBillingAddress.ts +12 -4
- package/src/models/UpdateOrderRequestShippingAddress.ts +12 -3
- package/src/models/index.ts +4 -4
- package/dist/models/AttachCouponOrderRequest.d.ts +0 -32
- package/dist/models/AttachCouponOrderRequest.js +0 -51
- package/dist/models/DetachCouponOrderRequest.d.ts +0 -32
- package/dist/models/DetachCouponOrderRequest.js +0 -51
- package/dist/models/OrderStatusWithCountResource.d.ts +0 -50
- package/dist/models/OrderStatusWithCountResource.js +0 -63
- package/dist/models/OrderStatusWithCountResourceArrayResponse.d.ts +0 -33
- package/dist/models/OrderStatusWithCountResourceArrayResponse.js +0 -50
- package/docs/DetachCouponOrderRequest.md +0 -34
- package/src/models/AttachCouponOrderRequest.ts +0 -66
- package/src/models/DetachCouponOrderRequest.ts +0 -66
- package/src/models/OrderStatusWithCountResource.ts +0 -93
- package/src/models/OrderStatusWithCountResourceArrayResponse.ts +0 -73
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
|
|
@@ -7,22 +7,28 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
11
|
-
`
|
|
12
|
-
`
|
|
10
|
+
`orderId` | number
|
|
11
|
+
`adminId` | number
|
|
12
|
+
`note` | string
|
|
13
|
+
`createdAt` | Date
|
|
14
|
+
`updatedAt` | Date
|
|
15
|
+
`admin` | Array<number>
|
|
13
16
|
|
|
14
17
|
## Example
|
|
15
18
|
|
|
16
19
|
```typescript
|
|
17
|
-
import type {
|
|
20
|
+
import type { AdminNoteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
18
21
|
|
|
19
22
|
// TODO: Update the object below with actual values
|
|
20
23
|
const example = {
|
|
21
24
|
"id": null,
|
|
22
|
-
"
|
|
23
|
-
"
|
|
24
|
-
"
|
|
25
|
-
|
|
25
|
+
"orderId": null,
|
|
26
|
+
"adminId": null,
|
|
27
|
+
"note": null,
|
|
28
|
+
"createdAt": null,
|
|
29
|
+
"updatedAt": null,
|
|
30
|
+
"admin": null,
|
|
31
|
+
} satisfies AdminNoteResource
|
|
26
32
|
|
|
27
33
|
console.log(example)
|
|
28
34
|
|
|
@@ -31,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
31
37
|
console.log(exampleJSON)
|
|
32
38
|
|
|
33
39
|
// Parse the JSON string back to an object
|
|
34
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminNoteResource
|
|
35
41
|
console.log(exampleParsed)
|
|
36
42
|
```
|
|
37
43
|
|
|
@@ -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
|
-
`
|
|
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
|
-
"
|
|
19
|
-
} satisfies
|
|
18
|
+
"data": null,
|
|
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
|
|
|
@@ -17,16 +17,14 @@ Name | Type
|
|
|
17
17
|
`shippingSubtotal` | number
|
|
18
18
|
`overrideShipping` | boolean
|
|
19
19
|
`insuranceAmount` | number
|
|
20
|
-
`includeInsurance` | boolean
|
|
21
20
|
`overrideInsurance` | boolean
|
|
22
21
|
`useAsBillingAddress` | boolean
|
|
23
22
|
`netsuiteId` | string
|
|
24
23
|
`isNetsuiteLocked` | boolean
|
|
25
|
-
`isDisabled` | boolean
|
|
26
24
|
`omnisendId` | string
|
|
27
25
|
`subtotal` | number
|
|
28
26
|
`productDiscountAmount` | number
|
|
29
|
-
`
|
|
27
|
+
`cartDiscountAmount` | number
|
|
30
28
|
`shippingDiscountAmount` | number
|
|
31
29
|
`shippingAmount` | number
|
|
32
30
|
`total` | number
|
|
@@ -46,7 +44,7 @@ Name | Type
|
|
|
46
44
|
`coupons` | object
|
|
47
45
|
`shippingAddress` | object
|
|
48
46
|
`billingAddress` | object
|
|
49
|
-
`omnisendSync` |
|
|
47
|
+
`omnisendSync` | object
|
|
50
48
|
|
|
51
49
|
## Example
|
|
52
50
|
|
|
@@ -66,16 +64,14 @@ const example = {
|
|
|
66
64
|
"shippingSubtotal": null,
|
|
67
65
|
"overrideShipping": null,
|
|
68
66
|
"insuranceAmount": null,
|
|
69
|
-
"includeInsurance": null,
|
|
70
67
|
"overrideInsurance": null,
|
|
71
68
|
"useAsBillingAddress": null,
|
|
72
69
|
"netsuiteId": null,
|
|
73
70
|
"isNetsuiteLocked": null,
|
|
74
|
-
"isDisabled": null,
|
|
75
71
|
"omnisendId": null,
|
|
76
72
|
"subtotal": null,
|
|
77
73
|
"productDiscountAmount": null,
|
|
78
|
-
"
|
|
74
|
+
"cartDiscountAmount": null,
|
|
79
75
|
"shippingDiscountAmount": null,
|
|
80
76
|
"shippingAmount": null,
|
|
81
77
|
"total": null,
|
package/docs/CartListResource.md
CHANGED
|
@@ -13,7 +13,6 @@ Name | Type
|
|
|
13
13
|
`shippingSubtotal` | number
|
|
14
14
|
`overrideShipping` | boolean
|
|
15
15
|
`insuranceAmount` | number
|
|
16
|
-
`includeInsurance` | boolean
|
|
17
16
|
`overrideInsurance` | boolean
|
|
18
17
|
`useAsBillingAddress` | boolean
|
|
19
18
|
`expiryDate` | Date
|
|
@@ -39,7 +38,6 @@ const example = {
|
|
|
39
38
|
"shippingSubtotal": null,
|
|
40
39
|
"overrideShipping": null,
|
|
41
40
|
"insuranceAmount": null,
|
|
42
|
-
"includeInsurance": null,
|
|
43
41
|
"overrideInsurance": null,
|
|
44
42
|
"useAsBillingAddress": null,
|
|
45
43
|
"expiryDate": null,
|
package/docs/CartResource.md
CHANGED
|
@@ -18,8 +18,7 @@ Name | Type
|
|
|
18
18
|
`shippingType` | string
|
|
19
19
|
`shippingSubtotal` | number
|
|
20
20
|
`overrideShipping` | boolean
|
|
21
|
-
`
|
|
22
|
-
`includeInsurance` | boolean
|
|
21
|
+
`insuranceAmount` | number
|
|
23
22
|
`overrideInsurance` | boolean
|
|
24
23
|
`useAsBillingAddress` | boolean
|
|
25
24
|
`admin` | object
|
|
@@ -32,12 +31,11 @@ Name | Type
|
|
|
32
31
|
`discountPreview` | number
|
|
33
32
|
`subtotal` | number
|
|
34
33
|
`shippingAmount` | number
|
|
35
|
-
`insuranceAmount` | number
|
|
36
34
|
`total` | number
|
|
37
35
|
`discountAmount` | number
|
|
38
36
|
`productDiscountAmount` | number
|
|
39
37
|
`shippingDiscountAmount` | number
|
|
40
|
-
`
|
|
38
|
+
`cartDiscountAmount` | number
|
|
41
39
|
`finalTotalAmount` | number
|
|
42
40
|
`status` | string
|
|
43
41
|
|
|
@@ -60,8 +58,7 @@ const example = {
|
|
|
60
58
|
"shippingType": null,
|
|
61
59
|
"shippingSubtotal": null,
|
|
62
60
|
"overrideShipping": null,
|
|
63
|
-
"
|
|
64
|
-
"includeInsurance": null,
|
|
61
|
+
"insuranceAmount": null,
|
|
65
62
|
"overrideInsurance": null,
|
|
66
63
|
"useAsBillingAddress": null,
|
|
67
64
|
"admin": null,
|
|
@@ -74,12 +71,11 @@ const example = {
|
|
|
74
71
|
"discountPreview": null,
|
|
75
72
|
"subtotal": null,
|
|
76
73
|
"shippingAmount": null,
|
|
77
|
-
"insuranceAmount": null,
|
|
78
74
|
"total": null,
|
|
79
75
|
"discountAmount": null,
|
|
80
76
|
"productDiscountAmount": null,
|
|
81
77
|
"shippingDiscountAmount": null,
|
|
82
|
-
"
|
|
78
|
+
"cartDiscountAmount": null,
|
|
83
79
|
"finalTotalAmount": null,
|
|
84
80
|
"status": null,
|
|
85
81
|
} satisfies CartResource
|
|
@@ -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
|
+
|
|
@@ -11,9 +11,6 @@ Name | Type
|
|
|
11
11
|
`placedAt` | Date
|
|
12
12
|
`createdAt` | Date
|
|
13
13
|
`updatedAt` | Date
|
|
14
|
-
`source` | string
|
|
15
|
-
`netsuiteId` | string
|
|
16
|
-
`isNetsuiteLocked` | boolean
|
|
17
14
|
`subtotal` | number
|
|
18
15
|
`finalTotalAmount` | number
|
|
19
16
|
`cartStatusContext` | object
|
|
@@ -34,9 +31,6 @@ const example = {
|
|
|
34
31
|
"placedAt": null,
|
|
35
32
|
"createdAt": null,
|
|
36
33
|
"updatedAt": null,
|
|
37
|
-
"source": null,
|
|
38
|
-
"netsuiteId": null,
|
|
39
|
-
"isNetsuiteLocked": null,
|
|
40
34
|
"subtotal": null,
|
|
41
35
|
"finalTotalAmount": null,
|
|
42
36
|
"cartStatusContext": null,
|
package/docs/OrdersApi.md
CHANGED
|
@@ -4,10 +4,8 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**attachCouponOrder**](OrdersApi.md#attachcouponorderoperation) | **POST** /admin-api/orders/{order}/coupon/attach | Auto-generated: attachCouponOrder |
|
|
8
7
|
| [**attachItemOrder**](OrdersApi.md#attachitemorderoperation) | **POST** /admin-api/orders/{order}/line-items/attach | Auto-generated: attachItemOrder |
|
|
9
8
|
| [**destroyOrder**](OrdersApi.md#destroyorder) | **DELETE** /admin-api/orders/{order}/delete | Auto-generated: destroyOrder |
|
|
10
|
-
| [**detachCouponOrder**](OrdersApi.md#detachcouponorderoperation) | **DELETE** /admin-api/orders/{order}/coupon/detach | Auto-generated: detachCouponOrder |
|
|
11
9
|
| [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
|
|
12
10
|
| [**getAllOrder**](OrdersApi.md#getallorderoperation) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
|
|
13
11
|
| [**indexOrder**](OrdersApi.md#indexorderoperation) | **POST** /admin-api/orders/list | Auto-generated: indexOrder |
|
|
@@ -19,74 +17,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
19
17
|
|
|
20
18
|
|
|
21
19
|
|
|
22
|
-
## attachCouponOrder
|
|
23
|
-
|
|
24
|
-
> AdminOrderResource attachCouponOrder(order, attachCouponOrderRequest)
|
|
25
|
-
|
|
26
|
-
Auto-generated: attachCouponOrder
|
|
27
|
-
|
|
28
|
-
### Example
|
|
29
|
-
|
|
30
|
-
```ts
|
|
31
|
-
import {
|
|
32
|
-
Configuration,
|
|
33
|
-
OrdersApi,
|
|
34
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
35
|
-
import type { AttachCouponOrderOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
36
|
-
|
|
37
|
-
async function example() {
|
|
38
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
39
|
-
const api = new OrdersApi();
|
|
40
|
-
|
|
41
|
-
const body = {
|
|
42
|
-
// number | The id of the order
|
|
43
|
-
order: 56,
|
|
44
|
-
// AttachCouponOrderRequest (optional)
|
|
45
|
-
attachCouponOrderRequest: ...,
|
|
46
|
-
} satisfies AttachCouponOrderOperationRequest;
|
|
47
|
-
|
|
48
|
-
try {
|
|
49
|
-
const data = await api.attachCouponOrder(body);
|
|
50
|
-
console.log(data);
|
|
51
|
-
} catch (error) {
|
|
52
|
-
console.error(error);
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
// Run the test
|
|
57
|
-
example().catch(console.error);
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
### Parameters
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
| Name | Type | Description | Notes |
|
|
64
|
-
|------------- | ------------- | ------------- | -------------|
|
|
65
|
-
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
66
|
-
| **attachCouponOrderRequest** | [AttachCouponOrderRequest](AttachCouponOrderRequest.md) | | [Optional] |
|
|
67
|
-
|
|
68
|
-
### Return type
|
|
69
|
-
|
|
70
|
-
[**AdminOrderResource**](AdminOrderResource.md)
|
|
71
|
-
|
|
72
|
-
### Authorization
|
|
73
|
-
|
|
74
|
-
No authorization required
|
|
75
|
-
|
|
76
|
-
### HTTP request headers
|
|
77
|
-
|
|
78
|
-
- **Content-Type**: `application/json`
|
|
79
|
-
- **Accept**: `application/json`
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
### HTTP response details
|
|
83
|
-
| Status code | Description | Response headers |
|
|
84
|
-
|-------------|-------------|------------------|
|
|
85
|
-
| **200** | Successful resource response | - |
|
|
86
|
-
|
|
87
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
88
|
-
|
|
89
|
-
|
|
90
20
|
## attachItemOrder
|
|
91
21
|
|
|
92
22
|
> GenericResponse attachItemOrder(order, attachItemOrderRequest)
|
|
@@ -220,74 +150,6 @@ No authorization required
|
|
|
220
150
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
221
151
|
|
|
222
152
|
|
|
223
|
-
## detachCouponOrder
|
|
224
|
-
|
|
225
|
-
> AdminOrderResource detachCouponOrder(order, detachCouponOrderRequest)
|
|
226
|
-
|
|
227
|
-
Auto-generated: detachCouponOrder
|
|
228
|
-
|
|
229
|
-
### Example
|
|
230
|
-
|
|
231
|
-
```ts
|
|
232
|
-
import {
|
|
233
|
-
Configuration,
|
|
234
|
-
OrdersApi,
|
|
235
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
236
|
-
import type { DetachCouponOrderOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
237
|
-
|
|
238
|
-
async function example() {
|
|
239
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
240
|
-
const api = new OrdersApi();
|
|
241
|
-
|
|
242
|
-
const body = {
|
|
243
|
-
// number | The id of the order
|
|
244
|
-
order: 56,
|
|
245
|
-
// DetachCouponOrderRequest (optional)
|
|
246
|
-
detachCouponOrderRequest: ...,
|
|
247
|
-
} satisfies DetachCouponOrderOperationRequest;
|
|
248
|
-
|
|
249
|
-
try {
|
|
250
|
-
const data = await api.detachCouponOrder(body);
|
|
251
|
-
console.log(data);
|
|
252
|
-
} catch (error) {
|
|
253
|
-
console.error(error);
|
|
254
|
-
}
|
|
255
|
-
}
|
|
256
|
-
|
|
257
|
-
// Run the test
|
|
258
|
-
example().catch(console.error);
|
|
259
|
-
```
|
|
260
|
-
|
|
261
|
-
### Parameters
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
| Name | Type | Description | Notes |
|
|
265
|
-
|------------- | ------------- | ------------- | -------------|
|
|
266
|
-
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
267
|
-
| **detachCouponOrderRequest** | [DetachCouponOrderRequest](DetachCouponOrderRequest.md) | | [Optional] |
|
|
268
|
-
|
|
269
|
-
### Return type
|
|
270
|
-
|
|
271
|
-
[**AdminOrderResource**](AdminOrderResource.md)
|
|
272
|
-
|
|
273
|
-
### Authorization
|
|
274
|
-
|
|
275
|
-
No authorization required
|
|
276
|
-
|
|
277
|
-
### HTTP request headers
|
|
278
|
-
|
|
279
|
-
- **Content-Type**: `application/json`
|
|
280
|
-
- **Accept**: `application/json`
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
### HTTP response details
|
|
284
|
-
| Status code | Description | Response headers |
|
|
285
|
-
|-------------|-------------|------------------|
|
|
286
|
-
| **200** | Successful resource response | - |
|
|
287
|
-
|
|
288
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
289
|
-
|
|
290
|
-
|
|
291
153
|
## detachItemOrder
|
|
292
154
|
|
|
293
155
|
> GenericResponse detachItemOrder(order, lineItem)
|
|
@@ -618,7 +480,7 @@ No authorization required
|
|
|
618
480
|
|
|
619
481
|
## statusesAllOrder
|
|
620
482
|
|
|
621
|
-
>
|
|
483
|
+
> GenericResponse statusesAllOrder()
|
|
622
484
|
|
|
623
485
|
Auto-generated: statusesAllOrder
|
|
624
486
|
|
|
@@ -653,7 +515,7 @@ This endpoint does not need any parameter.
|
|
|
653
515
|
|
|
654
516
|
### Return type
|
|
655
517
|
|
|
656
|
-
[**
|
|
518
|
+
[**GenericResponse**](GenericResponse.md)
|
|
657
519
|
|
|
658
520
|
### Authorization
|
|
659
521
|
|
|
@@ -668,7 +530,7 @@ No authorization required
|
|
|
668
530
|
### HTTP response details
|
|
669
531
|
| Status code | Description | Response headers |
|
|
670
532
|
|-------------|-------------|------------------|
|
|
671
|
-
| **200** |
|
|
533
|
+
| **200** | Generic JSON success | - |
|
|
672
534
|
|
|
673
535
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
674
536
|
|
package/docs/{OrderStatusWithCountResourceArrayResponse.md → PaginatedAdminNoteResourceResponse.md}
RENAMED
|
@@ -1,22 +1,24 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# PaginatedAdminNoteResourceResponse
|
|
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
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
13
14
|
```typescript
|
|
14
|
-
import type {
|
|
15
|
+
import type { PaginatedAdminNoteResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
16
|
|
|
16
17
|
// TODO: Update the object below with actual values
|
|
17
18
|
const example = {
|
|
18
19
|
"data": null,
|
|
19
|
-
|
|
20
|
+
"meta": null,
|
|
21
|
+
} satisfies PaginatedAdminNoteResourceResponse
|
|
20
22
|
|
|
21
23
|
console.log(example)
|
|
22
24
|
|
|
@@ -25,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
27
|
console.log(exampleJSON)
|
|
26
28
|
|
|
27
29
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedAdminNoteResourceResponse
|
|
29
31
|
console.log(exampleParsed)
|
|
30
32
|
```
|
|
31
33
|
|
package/docs/StoreCartRequest.md
CHANGED
|
@@ -18,7 +18,6 @@ Name | Type
|
|
|
18
18
|
`shippingSubtotal` | number
|
|
19
19
|
`overrideShipping` | boolean
|
|
20
20
|
`insuranceAmount` | number
|
|
21
|
-
`includeInsurance` | boolean
|
|
22
21
|
`overrideInsurance` | boolean
|
|
23
22
|
`useAsBillingAddress` | boolean
|
|
24
23
|
`shippingAddressId` | number
|
|
@@ -45,7 +44,6 @@ const example = {
|
|
|
45
44
|
"shippingSubtotal": null,
|
|
46
45
|
"overrideShipping": null,
|
|
47
46
|
"insuranceAmount": null,
|
|
48
|
-
"includeInsurance": null,
|
|
49
47
|
"overrideInsurance": null,
|
|
50
48
|
"useAsBillingAddress": null,
|
|
51
49
|
"shippingAddressId": null,
|
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`addresseeName` | string
|
|
10
9
|
`company` | string
|
|
11
10
|
`addressee` | string
|
|
12
11
|
`line1` | string
|
|
@@ -23,7 +22,6 @@ import type { StoreCartRequestShippingAddress } from '@digital8/lighting-illusio
|
|
|
23
22
|
|
|
24
23
|
// TODO: Update the object below with actual values
|
|
25
24
|
const example = {
|
|
26
|
-
"addresseeName": null,
|
|
27
25
|
"company": null,
|
|
28
26
|
"addressee": null,
|
|
29
27
|
"line1": null,
|
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`addresseeName` | string
|
|
10
9
|
`company` | string
|
|
11
10
|
`line1` | string
|
|
12
11
|
`line2` | string
|
|
@@ -22,7 +21,6 @@ import type { StoreStoreRequestAddress } from '@digital8/lighting-illusions-ts-s
|
|
|
22
21
|
|
|
23
22
|
// TODO: Update the object below with actual values
|
|
24
23
|
const example = {
|
|
25
|
-
"addresseeName": null,
|
|
26
24
|
"company": null,
|
|
27
25
|
"line1": null,
|
|
28
26
|
"line2": null,
|
|
@@ -14,7 +14,6 @@ Name | Type
|
|
|
14
14
|
`shippingSubtotal` | number
|
|
15
15
|
`overrideShipping` | boolean
|
|
16
16
|
`insuranceAmount` | number
|
|
17
|
-
`includeInsurance` | boolean
|
|
18
17
|
`overrideInsurance` | boolean
|
|
19
18
|
`useAsBillingAddress` | boolean
|
|
20
19
|
`shippingAddressId` | number
|
|
@@ -37,7 +36,6 @@ const example = {
|
|
|
37
36
|
"shippingSubtotal": null,
|
|
38
37
|
"overrideShipping": null,
|
|
39
38
|
"insuranceAmount": null,
|
|
40
|
-
"includeInsurance": null,
|
|
41
39
|
"overrideInsurance": null,
|
|
42
40
|
"useAsBillingAddress": null,
|
|
43
41
|
"shippingAddressId": null,
|
|
@@ -13,7 +13,6 @@ Name | Type
|
|
|
13
13
|
`shippingSubtotal` | number
|
|
14
14
|
`overrideShipping` | boolean
|
|
15
15
|
`insuranceAmount` | number
|
|
16
|
-
`includeInsurance` | boolean
|
|
17
16
|
`overrideInsurance` | boolean
|
|
18
17
|
`shippingAddress` | [UpdateOrderRequestShippingAddress](UpdateOrderRequestShippingAddress.md)
|
|
19
18
|
`billingAddress` | [UpdateOrderRequestBillingAddress](UpdateOrderRequestBillingAddress.md)
|
|
@@ -32,7 +31,6 @@ const example = {
|
|
|
32
31
|
"shippingSubtotal": null,
|
|
33
32
|
"overrideShipping": null,
|
|
34
33
|
"insuranceAmount": null,
|
|
35
|
-
"includeInsurance": null,
|
|
36
34
|
"overrideInsurance": null,
|
|
37
35
|
"shippingAddress": null,
|
|
38
36
|
"billingAddress": null,
|
|
@@ -6,7 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
9
|
+
`adresseeName` | string
|
|
10
|
+
`addressee` | string
|
|
10
11
|
`company` | string
|
|
11
12
|
`line1` | string
|
|
12
13
|
`line2` | string
|
|
@@ -22,7 +23,8 @@ import type { UpdateOrderRequestBillingAddress } from '@digital8/lighting-illusi
|
|
|
22
23
|
|
|
23
24
|
// TODO: Update the object below with actual values
|
|
24
25
|
const example = {
|
|
25
|
-
"
|
|
26
|
+
"adresseeName": null,
|
|
27
|
+
"addressee": null,
|
|
26
28
|
"company": null,
|
|
27
29
|
"line1": null,
|
|
28
30
|
"line2": null,
|