@digital8/lighting-illusions-ts-sdk 0.0.2303 → 0.0.2304
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 +32 -14
- package/README.md +23 -9
- package/dist/apis/CouponsApi.d.ts +116 -0
- package/dist/apis/CouponsApi.js +440 -0
- package/dist/apis/index.d.ts +1 -1
- package/dist/apis/index.js +1 -1
- 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 +5 -7
- package/dist/models/AdminOrderResource.d.ts +3 -2
- package/dist/models/AdminOrderResource.js +3 -2
- package/dist/models/CartListResource.d.ts +0 -6
- package/dist/models/CartListResource.js +0 -4
- package/dist/models/CategoryAutomationFieldType.d.ts +0 -2
- package/dist/models/CategoryAutomationFieldType.js +1 -3
- package/dist/models/CouponListResource.d.ts +99 -0
- package/dist/models/CouponListResource.js +90 -0
- package/dist/models/CouponListResourceArrayResponse.d.ts +33 -0
- package/dist/models/CouponListResourceArrayResponse.js +50 -0
- package/dist/models/CouponLiteResource.d.ts +44 -0
- package/dist/models/CouponLiteResource.js +57 -0
- package/dist/models/CouponLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/CouponLiteResourceArrayResponse.js +50 -0
- package/dist/models/CouponResource.d.ts +169 -0
- package/dist/models/CouponResource.js +138 -0
- package/dist/models/CouponResourceArrayResponse.d.ts +33 -0
- package/dist/models/CouponResourceArrayResponse.js +50 -0
- package/dist/models/CouponType.d.ts +26 -0
- package/dist/models/CouponType.js +52 -0
- package/dist/models/CreateCouponRequest.d.ts +134 -0
- package/dist/models/CreateCouponRequest.js +114 -0
- package/dist/models/CreateCouponRequestCouponablesInner.d.ts +48 -0
- package/dist/models/CreateCouponRequestCouponablesInner.js +61 -0
- package/dist/models/CreatePageComponentRequest.d.ts +4 -4
- package/dist/models/CreatePageComponentRequest.js +4 -4
- package/dist/models/CreateProductCategoryRequestAutomationRulesInner.d.ts +0 -2
- package/dist/models/CreateProductCategoryRequestAutomationRulesInner.js +1 -3
- package/dist/models/CreateSupplierRequest.d.ts +0 -6
- package/dist/models/CreateSupplierRequest.js +0 -2
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +1 -3
- package/dist/models/FrontendCartResource.d.ts +0 -18
- package/dist/models/FrontendCartResource.js +0 -12
- package/dist/models/OrderFulfillmentResource.d.ts +3 -3
- package/dist/models/OrderFulfillmentResource.js +4 -6
- package/dist/models/OrderStatusWithCountResource.d.ts +0 -12
- package/dist/models/OrderStatusWithCountResource.js +0 -8
- package/dist/models/PaginatedCouponListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedCouponListResourceResponse.js +57 -0
- package/dist/models/PaginatedCouponLiteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedCouponLiteResourceResponse.js +57 -0
- package/dist/models/PaginatedCouponResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedCouponResourceResponse.js +57 -0
- package/dist/models/ProductClassResource.d.ts +2 -2
- package/dist/models/SearchAllCouponsRequest.d.ts +101 -0
- package/dist/models/SearchAllCouponsRequest.js +85 -0
- package/dist/models/SearchAllOrdersRequest.d.ts +0 -6
- package/dist/models/SearchAllOrdersRequest.js +0 -2
- package/dist/models/SearchCartsRequest.d.ts +6 -0
- package/dist/models/SearchCartsRequest.js +2 -0
- package/dist/models/SearchCouponsRequest.d.ts +137 -0
- package/dist/models/SearchCouponsRequest.js +97 -0
- package/dist/models/SearchOrdersRequest.d.ts +6 -6
- package/dist/models/SearchOrdersRequest.js +2 -2
- 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 +4 -4
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
- package/dist/models/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +3 -1
- package/dist/models/SupplierFrontendResource.d.ts +0 -6
- package/dist/models/SupplierFrontendResource.js +0 -4
- package/dist/models/SupplierResource.d.ts +0 -6
- package/dist/models/SupplierResource.js +0 -4
- package/dist/models/UpdateCouponRequest.d.ts +128 -0
- package/dist/models/UpdateCouponRequest.js +110 -0
- package/dist/models/UpdatePageComponentRequest.d.ts +4 -4
- package/dist/models/UpdatePageComponentRequest.js +4 -4
- package/dist/models/UpdateSupplierRequest.d.ts +0 -6
- package/dist/models/UpdateSupplierRequest.js +0 -2
- package/dist/models/index.d.ts +15 -6
- package/dist/models/index.js +15 -6
- package/docs/AdminOrderResource.md +1 -1
- package/docs/CartListResource.md +0 -2
- package/docs/CouponListResource.md +56 -0
- package/docs/{OrderCouponResourceArrayResponse.md → CouponListResourceArrayResponse.md} +5 -5
- package/docs/{OrderCouponResource.md → CouponLiteResource.md} +6 -8
- package/docs/{ProductClassLiteResourceArrayResponse.md → CouponLiteResourceArrayResponse.md} +5 -5
- package/docs/CouponResource.md +78 -0
- package/docs/CouponResourceArrayResponse.md +34 -0
- package/docs/CouponType.md +32 -0
- package/docs/CouponsApi.md +407 -0
- package/docs/CreateCouponRequest.md +62 -0
- package/docs/{ProductClassLiteResource.md → CreateCouponRequestCouponablesInner.md} +6 -8
- package/docs/CreatePageComponentRequest.md +2 -2
- package/docs/CreateSupplierRequest.md +0 -2
- package/docs/FrontendCartResource.md +0 -6
- package/docs/OrderStatusWithCountResource.md +0 -4
- package/docs/{PaginatedProductClassLiteResourceResponse.md → PaginatedCouponListResourceResponse.md} +5 -5
- package/docs/PaginatedCouponLiteResourceResponse.md +36 -0
- package/docs/PaginatedCouponResourceResponse.md +36 -0
- package/docs/ProductClassResource.md +1 -1
- package/docs/{SearchAllProductClassesRequest.md → SearchAllCouponsRequest.md} +10 -4
- package/docs/SearchAllOrdersRequest.md +0 -2
- package/docs/SearchCartsRequest.md +2 -0
- package/docs/SearchCouponsRequest.md +62 -0
- package/docs/SearchOrdersRequest.md +2 -2
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/StoreSpecialDateResource.md +1 -1
- package/docs/SupplierFrontendResource.md +0 -2
- package/docs/SupplierResource.md +0 -2
- package/docs/UpdateCouponRequest.md +60 -0
- package/docs/UpdatePageComponentRequest.md +2 -2
- package/docs/UpdateSupplierRequest.md +0 -2
- package/package.json +1 -1
- package/src/apis/CouponsApi.ts +345 -0
- package/src/apis/index.ts +1 -1
- package/src/models/AddressFrontendResource.ts +3 -2
- package/src/models/AddressResource.ts +7 -8
- package/src/models/AdminOrderResource.ts +11 -4
- package/src/models/CartListResource.ts +0 -9
- package/src/models/CategoryAutomationFieldType.ts +1 -3
- package/src/models/CouponListResource.ts +170 -0
- package/src/models/CouponListResourceArrayResponse.ts +73 -0
- package/src/models/CouponLiteResource.ts +83 -0
- package/src/models/CouponLiteResourceArrayResponse.ts +73 -0
- package/src/models/CouponResource.ts +297 -0
- package/src/models/CouponResourceArrayResponse.ts +73 -0
- package/src/models/CouponType.ts +54 -0
- package/src/models/CreateCouponRequest.ts +216 -0
- package/src/models/CreateCouponRequestCouponablesInner.ts +86 -0
- package/src/models/CreatePageComponentRequest.ts +8 -8
- package/src/models/CreateProductCategoryRequestAutomationRulesInner.ts +1 -3
- package/src/models/CreateSupplierRequest.ts +0 -8
- package/src/models/ExternalApiLogResource.ts +2 -3
- package/src/models/FrontendCartResource.ts +0 -27
- package/src/models/OrderFulfillmentResource.ts +7 -8
- package/src/models/OrderStatusWithCountResource.ts +0 -18
- package/src/models/PaginatedCouponListResourceResponse.ts +90 -0
- package/src/models/PaginatedCouponLiteResourceResponse.ts +90 -0
- package/src/models/PaginatedCouponResourceResponse.ts +90 -0
- package/src/models/ProductClassResource.ts +2 -2
- package/src/models/SearchAllCouponsRequest.ts +154 -0
- package/src/models/SearchAllOrdersRequest.ts +0 -8
- package/src/models/SearchCartsRequest.ts +8 -0
- package/src/models/SearchCouponsRequest.ts +202 -0
- package/src/models/SearchOrdersRequest.ts +8 -8
- package/src/models/StoreFrontendResource.ts +2 -3
- package/src/models/StoreResource.ts +5 -5
- package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
- package/src/models/StoreSpecialDateResource.ts +4 -3
- package/src/models/SupplierFrontendResource.ts +0 -9
- package/src/models/SupplierResource.ts +0 -9
- package/src/models/UpdateCouponRequest.ts +207 -0
- package/src/models/UpdatePageComponentRequest.ts +8 -8
- package/src/models/UpdateSupplierRequest.ts +0 -8
- package/src/models/index.ts +15 -6
- package/dist/apis/ProductClassApi.d.ts +0 -34
- package/dist/apis/ProductClassApi.js +0 -139
- package/dist/models/OrderCouponResource.d.ts +0 -50
- package/dist/models/OrderCouponResource.js +0 -63
- package/dist/models/OrderCouponResourceArrayResponse.d.ts +0 -33
- package/dist/models/OrderCouponResourceArrayResponse.js +0 -50
- package/dist/models/PaginatedProductClassLiteResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedProductClassLiteResourceResponse.js +0 -57
- package/dist/models/ProductClassLiteResource.d.ts +0 -44
- package/dist/models/ProductClassLiteResource.js +0 -57
- package/dist/models/ProductClassLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductClassLiteResourceArrayResponse.js +0 -50
- package/dist/models/SearchAllProductClassesRequest.d.ts +0 -78
- package/dist/models/SearchAllProductClassesRequest.js +0 -74
- package/docs/ProductClassApi.md +0 -74
- package/src/apis/ProductClassApi.ts +0 -76
- package/src/models/OrderCouponResource.ts +0 -93
- package/src/models/OrderCouponResourceArrayResponse.ts +0 -73
- package/src/models/PaginatedProductClassLiteResourceResponse.ts +0 -90
- package/src/models/ProductClassLiteResource.ts +0 -83
- package/src/models/ProductClassLiteResourceArrayResponse.ts +0 -73
- package/src/models/SearchAllProductClassesRequest.ts +0 -125
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateCouponRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`siteId` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`code` | string
|
|
12
|
+
`type` | string
|
|
13
|
+
`discountType` | string
|
|
14
|
+
`discountAmount` | number
|
|
15
|
+
`minAmount` | number
|
|
16
|
+
`minProducts` | number
|
|
17
|
+
`totalUseLimit` | number
|
|
18
|
+
`customerUseLimit` | number
|
|
19
|
+
`startDate` | Date
|
|
20
|
+
`endDate` | Date
|
|
21
|
+
`isForAllProducts` | boolean
|
|
22
|
+
`isForAllCustomers` | boolean
|
|
23
|
+
`couponables` | [Array<CreateCouponRequestCouponablesInner>](CreateCouponRequestCouponablesInner.md)
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import type { CreateCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
29
|
+
|
|
30
|
+
// TODO: Update the object below with actual values
|
|
31
|
+
const example = {
|
|
32
|
+
"siteId": null,
|
|
33
|
+
"name": null,
|
|
34
|
+
"code": null,
|
|
35
|
+
"type": null,
|
|
36
|
+
"discountType": null,
|
|
37
|
+
"discountAmount": null,
|
|
38
|
+
"minAmount": null,
|
|
39
|
+
"minProducts": null,
|
|
40
|
+
"totalUseLimit": null,
|
|
41
|
+
"customerUseLimit": null,
|
|
42
|
+
"startDate": null,
|
|
43
|
+
"endDate": null,
|
|
44
|
+
"isForAllProducts": null,
|
|
45
|
+
"isForAllCustomers": null,
|
|
46
|
+
"couponables": null,
|
|
47
|
+
} satisfies CreateCouponRequest
|
|
48
|
+
|
|
49
|
+
console.log(example)
|
|
50
|
+
|
|
51
|
+
// Convert the instance to a JSON string
|
|
52
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
53
|
+
console.log(exampleJSON)
|
|
54
|
+
|
|
55
|
+
// Parse the JSON string back to an object
|
|
56
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateCouponRequest
|
|
57
|
+
console.log(exampleParsed)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
61
|
+
|
|
62
|
+
|
|
@@ -1,26 +1,24 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# CreateCouponRequestCouponablesInner
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`type` | string
|
|
9
10
|
`id` | number
|
|
10
|
-
`name` | string
|
|
11
|
-
`pathString` | string
|
|
12
11
|
|
|
13
12
|
## Example
|
|
14
13
|
|
|
15
14
|
```typescript
|
|
16
|
-
import type {
|
|
15
|
+
import type { CreateCouponRequestCouponablesInner } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
16
|
|
|
18
17
|
// TODO: Update the object below with actual values
|
|
19
18
|
const example = {
|
|
19
|
+
"type": null,
|
|
20
20
|
"id": null,
|
|
21
|
-
|
|
22
|
-
"pathString": null,
|
|
23
|
-
} satisfies ProductClassLiteResource
|
|
21
|
+
} satisfies CreateCouponRequestCouponablesInner
|
|
24
22
|
|
|
25
23
|
console.log(example)
|
|
26
24
|
|
|
@@ -29,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
29
27
|
console.log(exampleJSON)
|
|
30
28
|
|
|
31
29
|
// Parse the JSON string back to an object
|
|
32
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateCouponRequestCouponablesInner
|
|
33
31
|
console.log(exampleParsed)
|
|
34
32
|
```
|
|
35
33
|
|
|
@@ -11,8 +11,8 @@ Name | Type
|
|
|
11
11
|
`type` | string
|
|
12
12
|
`disabled` | boolean
|
|
13
13
|
`order` | number
|
|
14
|
-
`startDate` |
|
|
15
|
-
`endDate` |
|
|
14
|
+
`startDate` | Date
|
|
15
|
+
`endDate` | Date
|
|
16
16
|
`componentData` | object
|
|
17
17
|
`relations` | [Array<CreatePageComponentRequestRelationsInner>](CreatePageComponentRequestRelationsInner.md)
|
|
18
18
|
|
|
@@ -9,7 +9,6 @@ Name | Type
|
|
|
9
9
|
`name` | string
|
|
10
10
|
`slug` | string
|
|
11
11
|
`supplierEta` | number
|
|
12
|
-
`productEnquiriesOnly` | boolean
|
|
13
12
|
`seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
|
|
14
13
|
`altText` | string
|
|
15
14
|
`mimeType` | string
|
|
@@ -28,7 +27,6 @@ const example = {
|
|
|
28
27
|
"name": null,
|
|
29
28
|
"slug": null,
|
|
30
29
|
"supplierEta": null,
|
|
31
|
-
"productEnquiriesOnly": null,
|
|
32
30
|
"seo": null,
|
|
33
31
|
"altText": null,
|
|
34
32
|
"mimeType": null,
|
|
@@ -18,14 +18,11 @@ Name | Type
|
|
|
18
18
|
`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
19
19
|
`coupons` | [Array<FrontendCartResourceCouponsInner>](FrontendCartResourceCouponsInner.md)
|
|
20
20
|
`subtotal` | number
|
|
21
|
-
`subtotalAfterDiscounts` | number
|
|
22
21
|
`promotionalDiscount` | number
|
|
23
22
|
`couponSubtotalDiscount` | number
|
|
24
23
|
`couponShippingDiscount` | number
|
|
25
24
|
`shipping` | number
|
|
26
25
|
`transitInsurance` | number
|
|
27
|
-
`deliveryShippingQuote` | number
|
|
28
|
-
`transitInsuranceQuote` | number
|
|
29
26
|
`gst` | number
|
|
30
27
|
`grandTotal` | number
|
|
31
28
|
|
|
@@ -48,14 +45,11 @@ const example = {
|
|
|
48
45
|
"lineItems": null,
|
|
49
46
|
"coupons": null,
|
|
50
47
|
"subtotal": null,
|
|
51
|
-
"subtotalAfterDiscounts": null,
|
|
52
48
|
"promotionalDiscount": null,
|
|
53
49
|
"couponSubtotalDiscount": null,
|
|
54
50
|
"couponShippingDiscount": null,
|
|
55
51
|
"shipping": null,
|
|
56
52
|
"transitInsurance": null,
|
|
57
|
-
"deliveryShippingQuote": null,
|
|
58
|
-
"transitInsuranceQuote": null,
|
|
59
53
|
"gst": null,
|
|
60
54
|
"grandTotal": null,
|
|
61
55
|
} satisfies FrontendCartResource
|
|
@@ -8,8 +8,6 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
10
|
`name` | string
|
|
11
|
-
`shortName` | string
|
|
12
|
-
`displayOrder` | number
|
|
13
11
|
`isOrderNetsuiteSyncable` | boolean
|
|
14
12
|
`ordersCount` | number
|
|
15
13
|
|
|
@@ -22,8 +20,6 @@ import type { OrderStatusWithCountResource } from '@digital8/lighting-illusions-
|
|
|
22
20
|
const example = {
|
|
23
21
|
"id": null,
|
|
24
22
|
"name": null,
|
|
25
|
-
"shortName": null,
|
|
26
|
-
"displayOrder": null,
|
|
27
23
|
"isOrderNetsuiteSyncable": null,
|
|
28
24
|
"ordersCount": null,
|
|
29
25
|
} satisfies OrderStatusWithCountResource
|
package/docs/{PaginatedProductClassLiteResourceResponse.md → PaginatedCouponListResourceResponse.md}
RENAMED
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# PaginatedCouponListResourceResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<CouponListResource>](CouponListResource.md)
|
|
10
10
|
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import type {
|
|
15
|
+
import type { PaginatedCouponListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
16
|
|
|
17
17
|
// TODO: Update the object below with actual values
|
|
18
18
|
const example = {
|
|
19
19
|
"data": null,
|
|
20
20
|
"meta": null,
|
|
21
|
-
} satisfies
|
|
21
|
+
} satisfies PaginatedCouponListResourceResponse
|
|
22
22
|
|
|
23
23
|
console.log(example)
|
|
24
24
|
|
|
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
27
27
|
console.log(exampleJSON)
|
|
28
28
|
|
|
29
29
|
// Parse the JSON string back to an object
|
|
30
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedCouponListResourceResponse
|
|
31
31
|
console.log(exampleParsed)
|
|
32
32
|
```
|
|
33
33
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedCouponLiteResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<CouponLiteResource>](CouponLiteResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedCouponLiteResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"meta": null,
|
|
21
|
+
} satisfies PaginatedCouponLiteResourceResponse
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedCouponLiteResourceResponse
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedCouponResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<CouponResource>](CouponResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedCouponResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"meta": null,
|
|
21
|
+
} satisfies PaginatedCouponResourceResponse
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedCouponResourceResponse
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# SearchAllCouponsRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -12,11 +12,14 @@ Name | Type
|
|
|
12
12
|
`relatedId` | number
|
|
13
13
|
`relatedType` | string
|
|
14
14
|
`includesRelations` | boolean
|
|
15
|
+
`type` | Array<string>
|
|
16
|
+
`siteId` | Array<string>
|
|
17
|
+
`isAbandonedCart` | Array<string>
|
|
15
18
|
|
|
16
19
|
## Example
|
|
17
20
|
|
|
18
21
|
```typescript
|
|
19
|
-
import type {
|
|
22
|
+
import type { SearchAllCouponsRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
20
23
|
|
|
21
24
|
// TODO: Update the object below with actual values
|
|
22
25
|
const example = {
|
|
@@ -26,7 +29,10 @@ const example = {
|
|
|
26
29
|
"relatedId": null,
|
|
27
30
|
"relatedType": null,
|
|
28
31
|
"includesRelations": null,
|
|
29
|
-
|
|
32
|
+
"type": null,
|
|
33
|
+
"siteId": null,
|
|
34
|
+
"isAbandonedCart": null,
|
|
35
|
+
} satisfies SearchAllCouponsRequest
|
|
30
36
|
|
|
31
37
|
console.log(example)
|
|
32
38
|
|
|
@@ -35,7 +41,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
35
41
|
console.log(exampleJSON)
|
|
36
42
|
|
|
37
43
|
// Parse the JSON string back to an object
|
|
38
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as SearchAllCouponsRequest
|
|
39
45
|
console.log(exampleParsed)
|
|
40
46
|
```
|
|
41
47
|
|
|
@@ -16,7 +16,6 @@ Name | Type
|
|
|
16
16
|
`source` | Array<string>
|
|
17
17
|
`statusId` | Array<string>
|
|
18
18
|
`customerId` | Array<string>
|
|
19
|
-
`lineItemsLabelId` | Array<string>
|
|
20
19
|
|
|
21
20
|
## Example
|
|
22
21
|
|
|
@@ -35,7 +34,6 @@ const example = {
|
|
|
35
34
|
"source": null,
|
|
36
35
|
"statusId": null,
|
|
37
36
|
"customerId": null,
|
|
38
|
-
"lineItemsLabelId": null,
|
|
39
37
|
} satisfies SearchAllOrdersRequest
|
|
40
38
|
|
|
41
39
|
console.log(example)
|
|
@@ -23,6 +23,7 @@ Name | Type
|
|
|
23
23
|
`relatedId` | number
|
|
24
24
|
`relatedType` | string
|
|
25
25
|
`includesRelations` | boolean
|
|
26
|
+
`couponId` | number
|
|
26
27
|
|
|
27
28
|
## Example
|
|
28
29
|
|
|
@@ -48,6 +49,7 @@ const example = {
|
|
|
48
49
|
"relatedId": null,
|
|
49
50
|
"relatedType": null,
|
|
50
51
|
"includesRelations": null,
|
|
52
|
+
"couponId": null,
|
|
51
53
|
} satisfies SearchCartsRequest
|
|
52
54
|
|
|
53
55
|
console.log(example)
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
|
|
2
|
+
# SearchCouponsRequest
|
|
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
|
+
`type` | Array<string>
|
|
15
|
+
`siteId` | Array<string>
|
|
16
|
+
`isAbandonedCart` | Array<string>
|
|
17
|
+
`beforeStartDate` | Date
|
|
18
|
+
`afterStartDate` | Date
|
|
19
|
+
`beforeEndDate` | Date
|
|
20
|
+
`afterEndDate` | Date
|
|
21
|
+
`relatedId` | number
|
|
22
|
+
`relatedType` | string
|
|
23
|
+
`includesRelations` | boolean
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import type { SearchCouponsRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
29
|
+
|
|
30
|
+
// TODO: Update the object below with actual values
|
|
31
|
+
const example = {
|
|
32
|
+
"search": null,
|
|
33
|
+
"sortBy": null,
|
|
34
|
+
"sortDirection": null,
|
|
35
|
+
"perPage": null,
|
|
36
|
+
"page": null,
|
|
37
|
+
"type": null,
|
|
38
|
+
"siteId": null,
|
|
39
|
+
"isAbandonedCart": null,
|
|
40
|
+
"beforeStartDate": null,
|
|
41
|
+
"afterStartDate": null,
|
|
42
|
+
"beforeEndDate": null,
|
|
43
|
+
"afterEndDate": null,
|
|
44
|
+
"relatedId": null,
|
|
45
|
+
"relatedType": null,
|
|
46
|
+
"includesRelations": null,
|
|
47
|
+
} satisfies SearchCouponsRequest
|
|
48
|
+
|
|
49
|
+
console.log(example)
|
|
50
|
+
|
|
51
|
+
// Convert the instance to a JSON string
|
|
52
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
53
|
+
console.log(exampleJSON)
|
|
54
|
+
|
|
55
|
+
// Parse the JSON string back to an object
|
|
56
|
+
const exampleParsed = JSON.parse(exampleJSON) as SearchCouponsRequest
|
|
57
|
+
console.log(exampleParsed)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
61
|
+
|
|
62
|
+
|
|
@@ -15,7 +15,6 @@ Name | Type
|
|
|
15
15
|
`source` | Array<string>
|
|
16
16
|
`statusId` | Array<string>
|
|
17
17
|
`customerId` | Array<string>
|
|
18
|
-
`lineItemsLabelId` | Array<string>
|
|
19
18
|
`beforeCreatedAt` | Date
|
|
20
19
|
`afterCreatedAt` | Date
|
|
21
20
|
`beforePlacedAt` | Date
|
|
@@ -25,6 +24,7 @@ Name | Type
|
|
|
25
24
|
`relatedId` | number
|
|
26
25
|
`relatedType` | string
|
|
27
26
|
`includesRelations` | boolean
|
|
27
|
+
`couponId` | number
|
|
28
28
|
|
|
29
29
|
## Example
|
|
30
30
|
|
|
@@ -42,7 +42,6 @@ const example = {
|
|
|
42
42
|
"source": null,
|
|
43
43
|
"statusId": null,
|
|
44
44
|
"customerId": null,
|
|
45
|
-
"lineItemsLabelId": null,
|
|
46
45
|
"beforeCreatedAt": null,
|
|
47
46
|
"afterCreatedAt": null,
|
|
48
47
|
"beforePlacedAt": null,
|
|
@@ -52,6 +51,7 @@ const example = {
|
|
|
52
51
|
"relatedId": null,
|
|
53
52
|
"relatedType": null,
|
|
54
53
|
"includesRelations": null,
|
|
54
|
+
"couponId": null,
|
|
55
55
|
} satisfies SearchOrdersRequest
|
|
56
56
|
|
|
57
57
|
console.log(example)
|
|
@@ -11,7 +11,6 @@ Name | Type
|
|
|
11
11
|
`slug` | string
|
|
12
12
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
|
-
`productEnquiriesOnly` | boolean
|
|
15
14
|
`seo` | object
|
|
16
15
|
`description` | [DescriptionResource](DescriptionResource.md)
|
|
17
16
|
|
|
@@ -27,7 +26,6 @@ const example = {
|
|
|
27
26
|
"slug": null,
|
|
28
27
|
"thumbnail": null,
|
|
29
28
|
"supplierEta": null,
|
|
30
|
-
"productEnquiriesOnly": null,
|
|
31
29
|
"seo": null,
|
|
32
30
|
"description": null,
|
|
33
31
|
} satisfies SupplierFrontendResource
|
package/docs/SupplierResource.md
CHANGED
|
@@ -11,7 +11,6 @@ Name | Type
|
|
|
11
11
|
`slug` | string
|
|
12
12
|
`thumbnail` | [AssetResource](AssetResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
|
-
`productEnquiriesOnly` | boolean
|
|
15
14
|
`seo` | [Array<SEOResource>](SEOResource.md)
|
|
16
15
|
`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
|
|
17
16
|
|
|
@@ -27,7 +26,6 @@ const example = {
|
|
|
27
26
|
"slug": null,
|
|
28
27
|
"thumbnail": null,
|
|
29
28
|
"supplierEta": null,
|
|
30
|
-
"productEnquiriesOnly": null,
|
|
31
29
|
"seo": null,
|
|
32
30
|
"descriptions": null,
|
|
33
31
|
} satisfies SupplierResource
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateCouponRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`name` | string
|
|
10
|
+
`code` | string
|
|
11
|
+
`type` | string
|
|
12
|
+
`discountType` | string
|
|
13
|
+
`discountAmount` | number
|
|
14
|
+
`minAmount` | number
|
|
15
|
+
`minProducts` | number
|
|
16
|
+
`totalUseLimit` | number
|
|
17
|
+
`customerUseLimit` | number
|
|
18
|
+
`startDate` | Date
|
|
19
|
+
`endDate` | Date
|
|
20
|
+
`isForAllProducts` | boolean
|
|
21
|
+
`isForAllCustomers` | boolean
|
|
22
|
+
`couponables` | [Array<CreateCouponRequestCouponablesInner>](CreateCouponRequestCouponablesInner.md)
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import type { UpdateCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
28
|
+
|
|
29
|
+
// TODO: Update the object below with actual values
|
|
30
|
+
const example = {
|
|
31
|
+
"name": null,
|
|
32
|
+
"code": null,
|
|
33
|
+
"type": null,
|
|
34
|
+
"discountType": null,
|
|
35
|
+
"discountAmount": null,
|
|
36
|
+
"minAmount": null,
|
|
37
|
+
"minProducts": null,
|
|
38
|
+
"totalUseLimit": null,
|
|
39
|
+
"customerUseLimit": null,
|
|
40
|
+
"startDate": null,
|
|
41
|
+
"endDate": null,
|
|
42
|
+
"isForAllProducts": null,
|
|
43
|
+
"isForAllCustomers": null,
|
|
44
|
+
"couponables": null,
|
|
45
|
+
} satisfies UpdateCouponRequest
|
|
46
|
+
|
|
47
|
+
console.log(example)
|
|
48
|
+
|
|
49
|
+
// Convert the instance to a JSON string
|
|
50
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
51
|
+
console.log(exampleJSON)
|
|
52
|
+
|
|
53
|
+
// Parse the JSON string back to an object
|
|
54
|
+
const exampleParsed = JSON.parse(exampleJSON) as UpdateCouponRequest
|
|
55
|
+
console.log(exampleParsed)
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
59
|
+
|
|
60
|
+
|
|
@@ -9,8 +9,8 @@ Name | Type
|
|
|
9
9
|
`type` | string
|
|
10
10
|
`disabled` | boolean
|
|
11
11
|
`order` | number
|
|
12
|
-
`startDate` |
|
|
13
|
-
`endDate` |
|
|
12
|
+
`startDate` | Date
|
|
13
|
+
`endDate` | Date
|
|
14
14
|
`componentData` | object
|
|
15
15
|
`relations` | [Array<CreatePageComponentRequestRelationsInner>](CreatePageComponentRequestRelationsInner.md)
|
|
16
16
|
|
|
@@ -9,7 +9,6 @@ Name | Type
|
|
|
9
9
|
`name` | string
|
|
10
10
|
`slug` | string
|
|
11
11
|
`supplierEta` | number
|
|
12
|
-
`productEnquiriesOnly` | boolean
|
|
13
12
|
`seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
|
|
14
13
|
`altText` | string
|
|
15
14
|
`mimeType` | string
|
|
@@ -28,7 +27,6 @@ const example = {
|
|
|
28
27
|
"name": null,
|
|
29
28
|
"slug": null,
|
|
30
29
|
"supplierEta": null,
|
|
31
|
-
"productEnquiriesOnly": null,
|
|
32
30
|
"seo": null,
|
|
33
31
|
"altText": null,
|
|
34
32
|
"mimeType": null,
|