@digital8/lighting-illusions-ts-sdk 0.0.2377 → 0.0.2378
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 +30 -0
- package/README.md +22 -2
- package/dist/apis/CouponsApi.d.ts +116 -0
- package/dist/apis/CouponsApi.js +440 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +1 -3
- package/dist/models/AddressResource.d.ts +3 -3
- package/dist/models/AddressResource.js +6 -4
- 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 +163 -0
- package/dist/models/CouponResource.js +134 -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/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 +3 -1
- package/dist/models/OrderFulfillmentResource.d.ts +3 -3
- package/dist/models/OrderFulfillmentResource.js +4 -6
- package/dist/models/PaginatedCouponListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedCouponListResourceResponse.js +57 -0
- package/dist/models/PaginatedCouponResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedCouponResourceResponse.js +57 -0
- package/dist/models/ProductCategoryLiteResource.d.ts +6 -0
- package/dist/models/ProductCategoryLiteResource.js +4 -0
- package/dist/models/ProductChildListResource.d.ts +6 -0
- package/dist/models/ProductChildListResource.js +4 -0
- package/dist/models/SearchAllCouponsRequest.d.ts +101 -0
- package/dist/models/SearchAllCouponsRequest.js +85 -0
- 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 -0
- package/dist/models/SearchOrdersRequest.js +2 -0
- package/dist/models/StoreFrontendResource.d.ts +2 -2
- package/dist/models/StoreFrontendResource.js +2 -6
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +1 -3
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +3 -1
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.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/UpdateSupplierRequest.d.ts +0 -6
- package/dist/models/UpdateSupplierRequest.js +0 -2
- package/dist/models/index.d.ts +14 -0
- package/dist/models/index.js +14 -0
- package/docs/CouponListResource.md +56 -0
- package/docs/CouponListResourceArrayResponse.md +34 -0
- package/docs/CouponLiteResource.md +38 -0
- package/docs/CouponLiteResourceArrayResponse.md +34 -0
- package/docs/CouponResource.md +76 -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/CreateCouponRequestCouponablesInner.md +36 -0
- package/docs/CreateSupplierRequest.md +0 -2
- package/docs/PaginatedCouponListResourceResponse.md +36 -0
- package/docs/PaginatedCouponResourceResponse.md +36 -0
- package/docs/ProductCategoryLiteResource.md +2 -0
- package/docs/ProductChildListResource.md +2 -0
- package/docs/SearchAllCouponsRequest.md +50 -0
- package/docs/SearchCartsRequest.md +2 -0
- package/docs/SearchCouponsRequest.md +62 -0
- package/docs/SearchOrdersRequest.md +2 -0
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/SupplierFrontendResource.md +0 -2
- package/docs/SupplierResource.md +0 -2
- package/docs/UpdateCouponRequest.md +60 -0
- package/docs/UpdateSupplierRequest.md +0 -2
- package/package.json +1 -1
- package/src/apis/CouponsApi.ts +345 -0
- package/src/apis/index.ts +1 -0
- package/src/models/AddressFrontendResource.ts +2 -3
- package/src/models/AddressResource.ts +8 -7
- 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 +288 -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/CreateSupplierRequest.ts +0 -8
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/OrderFulfillmentResource.ts +7 -8
- package/src/models/PaginatedCouponListResourceResponse.ts +90 -0
- package/src/models/PaginatedCouponResourceResponse.ts +90 -0
- package/src/models/ProductCategoryLiteResource.ts +9 -0
- package/src/models/ProductChildListResource.ts +9 -0
- package/src/models/SearchAllCouponsRequest.ts +154 -0
- package/src/models/SearchCartsRequest.ts +8 -0
- package/src/models/SearchCouponsRequest.ts +202 -0
- package/src/models/SearchOrdersRequest.ts +8 -0
- package/src/models/StoreFrontendResource.ts +4 -6
- package/src/models/StoreListResource.ts +2 -3
- package/src/models/StoreResource.ts +3 -2
- package/src/models/StoreSpecialDateFrontendResource.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/UpdateSupplierRequest.ts +0 -8
- package/src/models/index.ts +14 -0
|
@@ -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` | string
|
|
20
|
+
`endDate` | string
|
|
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
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateCouponRequestCouponablesInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`type` | string
|
|
10
|
+
`id` | number
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { CreateCouponRequestCouponablesInner } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"type": null,
|
|
20
|
+
"id": null,
|
|
21
|
+
} satisfies CreateCouponRequestCouponablesInner
|
|
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 CreateCouponRequestCouponablesInner
|
|
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
|
+
|
|
@@ -10,7 +10,6 @@ Name | Type
|
|
|
10
10
|
`slug` | string
|
|
11
11
|
`supplierEta` | number
|
|
12
12
|
`productEnquiriesOnly` | boolean
|
|
13
|
-
`showReturnsBanner` | boolean
|
|
14
13
|
`seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
|
|
15
14
|
`altText` | string
|
|
16
15
|
`mimeType` | string
|
|
@@ -30,7 +29,6 @@ const example = {
|
|
|
30
29
|
"slug": null,
|
|
31
30
|
"supplierEta": null,
|
|
32
31
|
"productEnquiriesOnly": null,
|
|
33
|
-
"showReturnsBanner": null,
|
|
34
32
|
"seo": null,
|
|
35
33
|
"altText": null,
|
|
36
34
|
"mimeType": null,
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedCouponListResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<CouponListResource>](CouponListResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedCouponListResourceResponse } 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 PaginatedCouponListResourceResponse
|
|
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 PaginatedCouponListResourceResponse
|
|
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
|
+
|
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`name` | string
|
|
11
11
|
`siteId` | number
|
|
12
12
|
`isAutomated` | boolean
|
|
13
|
+
`isParent` | boolean
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,6 +23,7 @@ const example = {
|
|
|
22
23
|
"name": null,
|
|
23
24
|
"siteId": null,
|
|
24
25
|
"isAutomated": null,
|
|
26
|
+
"isParent": null,
|
|
25
27
|
} satisfies ProductCategoryLiteResource
|
|
26
28
|
|
|
27
29
|
console.log(example)
|
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`parentId` | string
|
|
11
11
|
`sku` | number
|
|
12
12
|
`name` | string
|
|
13
|
+
`fullName` | string
|
|
13
14
|
`model` | string
|
|
14
15
|
`stock` | number
|
|
15
16
|
`isDisabled` | string
|
|
@@ -30,6 +31,7 @@ const example = {
|
|
|
30
31
|
"parentId": null,
|
|
31
32
|
"sku": null,
|
|
32
33
|
"name": null,
|
|
34
|
+
"fullName": null,
|
|
33
35
|
"model": null,
|
|
34
36
|
"stock": null,
|
|
35
37
|
"isDisabled": null,
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
|
|
2
|
+
# SearchAllCouponsRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`search` | string
|
|
10
|
+
`sortBy` | string
|
|
11
|
+
`sortDirection` | string
|
|
12
|
+
`relatedId` | number
|
|
13
|
+
`relatedType` | string
|
|
14
|
+
`includesRelations` | boolean
|
|
15
|
+
`type` | Array<string>
|
|
16
|
+
`siteId` | Array<string>
|
|
17
|
+
`isAbandonedCart` | Array<string>
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { SearchAllCouponsRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"search": null,
|
|
27
|
+
"sortBy": null,
|
|
28
|
+
"sortDirection": null,
|
|
29
|
+
"relatedId": null,
|
|
30
|
+
"relatedType": null,
|
|
31
|
+
"includesRelations": null,
|
|
32
|
+
"type": null,
|
|
33
|
+
"siteId": null,
|
|
34
|
+
"isAbandonedCart": null,
|
|
35
|
+
} satisfies SearchAllCouponsRequest
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as SearchAllCouponsRequest
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|
|
@@ -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
|
+
|
|
@@ -25,6 +25,7 @@ Name | Type
|
|
|
25
25
|
`relatedId` | number
|
|
26
26
|
`relatedType` | string
|
|
27
27
|
`includesRelations` | boolean
|
|
28
|
+
`couponId` | number
|
|
28
29
|
|
|
29
30
|
## Example
|
|
30
31
|
|
|
@@ -52,6 +53,7 @@ const example = {
|
|
|
52
53
|
"relatedId": null,
|
|
53
54
|
"relatedType": null,
|
|
54
55
|
"includesRelations": null,
|
|
56
|
+
"couponId": null,
|
|
55
57
|
} satisfies SearchOrdersRequest
|
|
56
58
|
|
|
57
59
|
console.log(example)
|
|
@@ -12,7 +12,6 @@ Name | Type
|
|
|
12
12
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
14
|
`productEnquiriesOnly` | boolean
|
|
15
|
-
`showReturnsBanner` | boolean
|
|
16
15
|
`seo` | object
|
|
17
16
|
`description` | [DescriptionResource](DescriptionResource.md)
|
|
18
17
|
|
|
@@ -29,7 +28,6 @@ const example = {
|
|
|
29
28
|
"thumbnail": null,
|
|
30
29
|
"supplierEta": null,
|
|
31
30
|
"productEnquiriesOnly": null,
|
|
32
|
-
"showReturnsBanner": null,
|
|
33
31
|
"seo": null,
|
|
34
32
|
"description": null,
|
|
35
33
|
} satisfies SupplierFrontendResource
|
package/docs/SupplierResource.md
CHANGED
|
@@ -12,7 +12,6 @@ Name | Type
|
|
|
12
12
|
`thumbnail` | [AssetResource](AssetResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
14
|
`productEnquiriesOnly` | boolean
|
|
15
|
-
`showReturnsBanner` | boolean
|
|
16
15
|
`seo` | [Array<SEOResource>](SEOResource.md)
|
|
17
16
|
`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
|
|
18
17
|
|
|
@@ -29,7 +28,6 @@ const example = {
|
|
|
29
28
|
"thumbnail": null,
|
|
30
29
|
"supplierEta": null,
|
|
31
30
|
"productEnquiriesOnly": null,
|
|
32
|
-
"showReturnsBanner": null,
|
|
33
31
|
"seo": null,
|
|
34
32
|
"descriptions": null,
|
|
35
33
|
} 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` | string
|
|
19
|
+
`endDate` | string
|
|
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
|
+
|
|
@@ -10,7 +10,6 @@ Name | Type
|
|
|
10
10
|
`slug` | string
|
|
11
11
|
`supplierEta` | number
|
|
12
12
|
`productEnquiriesOnly` | boolean
|
|
13
|
-
`showReturnsBanner` | boolean
|
|
14
13
|
`seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
|
|
15
14
|
`altText` | string
|
|
16
15
|
`mimeType` | string
|
|
@@ -30,7 +29,6 @@ const example = {
|
|
|
30
29
|
"slug": null,
|
|
31
30
|
"supplierEta": null,
|
|
32
31
|
"productEnquiriesOnly": null,
|
|
33
|
-
"showReturnsBanner": null,
|
|
34
32
|
"seo": null,
|
|
35
33
|
"altText": null,
|
|
36
34
|
"mimeType": null,
|