@digital8/lighting-illusions-ts-sdk 0.0.2363 → 0.0.2364

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.
Files changed (113) hide show
  1. package/.openapi-generator/FILES +34 -4
  2. package/README.md +24 -4
  3. package/dist/apis/CouponsApi.d.ts +116 -0
  4. package/dist/apis/CouponsApi.js +440 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/models/AddressResource.d.ts +1 -1
  8. package/dist/models/AddressResource.js +1 -3
  9. package/dist/models/AdminOrderResource.d.ts +2 -3
  10. package/dist/models/AdminOrderResource.js +2 -3
  11. package/dist/models/AppliedCouponResource.d.ts +50 -0
  12. package/dist/models/{CartCouponResource.js → AppliedCouponResource.js} +13 -13
  13. package/dist/models/AppliedCouponResourceArrayResponse.d.ts +33 -0
  14. package/dist/models/AppliedCouponResourceArrayResponse.js +50 -0
  15. package/dist/models/CouponListResource.d.ts +99 -0
  16. package/dist/models/CouponListResource.js +90 -0
  17. package/dist/models/CouponListResourceArrayResponse.d.ts +33 -0
  18. package/dist/models/CouponListResourceArrayResponse.js +50 -0
  19. package/dist/models/CouponLiteResource.d.ts +44 -0
  20. package/dist/models/CouponLiteResource.js +57 -0
  21. package/dist/models/CouponLiteResourceArrayResponse.d.ts +33 -0
  22. package/dist/models/CouponLiteResourceArrayResponse.js +50 -0
  23. package/dist/models/CouponResource.d.ts +163 -0
  24. package/dist/models/CouponResource.js +134 -0
  25. package/dist/models/CouponResourceArrayResponse.d.ts +33 -0
  26. package/dist/models/CouponResourceArrayResponse.js +50 -0
  27. package/dist/models/CouponType.d.ts +26 -0
  28. package/dist/models/CouponType.js +52 -0
  29. package/dist/models/CreateCouponRequest.d.ts +134 -0
  30. package/dist/models/CreateCouponRequest.js +114 -0
  31. package/dist/models/CreateCouponRequestCouponablesInner.d.ts +48 -0
  32. package/dist/models/CreateCouponRequestCouponablesInner.js +61 -0
  33. package/dist/models/FrontendOrderResource.d.ts +3 -3
  34. package/dist/models/FrontendOrderResource.js +3 -3
  35. package/dist/models/OrderFulfillmentResource.d.ts +1 -1
  36. package/dist/models/OrderFulfillmentResource.js +1 -3
  37. package/dist/models/PaginatedCouponListResourceResponse.d.ts +40 -0
  38. package/dist/models/PaginatedCouponListResourceResponse.js +57 -0
  39. package/dist/models/PaginatedCouponResourceResponse.d.ts +40 -0
  40. package/dist/models/PaginatedCouponResourceResponse.js +57 -0
  41. package/dist/models/SearchAllCouponsRequest.d.ts +101 -0
  42. package/dist/models/SearchAllCouponsRequest.js +85 -0
  43. package/dist/models/SearchCartsRequest.d.ts +6 -0
  44. package/dist/models/SearchCartsRequest.js +2 -0
  45. package/dist/models/SearchCouponsRequest.d.ts +137 -0
  46. package/dist/models/SearchCouponsRequest.js +97 -0
  47. package/dist/models/SearchOrdersRequest.d.ts +6 -0
  48. package/dist/models/SearchOrdersRequest.js +2 -0
  49. package/dist/models/StoreFrontendResource.d.ts +1 -1
  50. package/dist/models/StoreFrontendResource.js +1 -3
  51. package/dist/models/StoreListResource.d.ts +1 -1
  52. package/dist/models/StoreListResource.js +1 -3
  53. package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
  54. package/dist/models/StoreSpecialDateFrontendResource.js +1 -3
  55. package/dist/models/UpdateCouponRequest.d.ts +128 -0
  56. package/dist/models/UpdateCouponRequest.js +110 -0
  57. package/dist/models/index.d.ts +16 -2
  58. package/dist/models/index.js +16 -2
  59. package/docs/AdminOrderResource.md +1 -1
  60. package/docs/{CartCouponResource.md → AppliedCouponResource.md} +4 -4
  61. package/docs/AppliedCouponResourceArrayResponse.md +34 -0
  62. package/docs/CouponListResource.md +56 -0
  63. package/docs/{CartCouponResourceArrayResponse.md → CouponListResourceArrayResponse.md} +5 -5
  64. package/docs/CouponLiteResource.md +38 -0
  65. package/docs/CouponLiteResourceArrayResponse.md +34 -0
  66. package/docs/CouponResource.md +76 -0
  67. package/docs/CouponResourceArrayResponse.md +34 -0
  68. package/docs/CouponType.md +32 -0
  69. package/docs/CouponsApi.md +407 -0
  70. package/docs/CreateCouponRequest.md +62 -0
  71. package/docs/CreateCouponRequestCouponablesInner.md +36 -0
  72. package/docs/FrontendOrderResource.md +1 -1
  73. package/docs/PaginatedCouponListResourceResponse.md +36 -0
  74. package/docs/PaginatedCouponResourceResponse.md +36 -0
  75. package/docs/SearchAllCouponsRequest.md +50 -0
  76. package/docs/SearchCartsRequest.md +2 -0
  77. package/docs/SearchCouponsRequest.md +62 -0
  78. package/docs/SearchOrdersRequest.md +2 -0
  79. package/docs/StoreSpecialDateFrontendResource.md +1 -1
  80. package/docs/UpdateCouponRequest.md +60 -0
  81. package/package.json +1 -1
  82. package/src/apis/CouponsApi.ts +345 -0
  83. package/src/apis/index.ts +1 -0
  84. package/src/models/AddressResource.ts +2 -3
  85. package/src/models/AdminOrderResource.ts +4 -11
  86. package/src/models/{CartCouponResource.ts → AppliedCouponResource.ts} +14 -14
  87. package/src/models/AppliedCouponResourceArrayResponse.ts +73 -0
  88. package/src/models/CouponListResource.ts +170 -0
  89. package/src/models/CouponListResourceArrayResponse.ts +73 -0
  90. package/src/models/CouponLiteResource.ts +83 -0
  91. package/src/models/CouponLiteResourceArrayResponse.ts +73 -0
  92. package/src/models/CouponResource.ts +288 -0
  93. package/src/models/CouponResourceArrayResponse.ts +73 -0
  94. package/src/models/CouponType.ts +54 -0
  95. package/src/models/CreateCouponRequest.ts +216 -0
  96. package/src/models/CreateCouponRequestCouponablesInner.ts +86 -0
  97. package/src/models/FrontendOrderResource.ts +11 -11
  98. package/src/models/OrderFulfillmentResource.ts +2 -3
  99. package/src/models/PaginatedCouponListResourceResponse.ts +90 -0
  100. package/src/models/PaginatedCouponResourceResponse.ts +90 -0
  101. package/src/models/SearchAllCouponsRequest.ts +154 -0
  102. package/src/models/SearchCartsRequest.ts +8 -0
  103. package/src/models/SearchCouponsRequest.ts +202 -0
  104. package/src/models/SearchOrdersRequest.ts +8 -0
  105. package/src/models/StoreFrontendResource.ts +2 -3
  106. package/src/models/StoreListResource.ts +2 -3
  107. package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
  108. package/src/models/UpdateCouponRequest.ts +207 -0
  109. package/src/models/index.ts +16 -2
  110. package/dist/models/CartCouponResource.d.ts +0 -50
  111. package/dist/models/CartCouponResourceArrayResponse.d.ts +0 -33
  112. package/dist/models/CartCouponResourceArrayResponse.js +0 -50
  113. package/src/models/CartCouponResourceArrayResponse.ts +0 -73
@@ -0,0 +1,34 @@
1
+
2
+ # AppliedCouponResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<AppliedCouponResource>](AppliedCouponResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { AppliedCouponResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies AppliedCouponResourceArrayResponse
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as AppliedCouponResourceArrayResponse
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,56 @@
1
+
2
+ # CouponListResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `name` | string
11
+ `code` | string
12
+ `type` | string
13
+ `discountType` | string
14
+ `discountAmount` | number
15
+ `startDate` | Date
16
+ `endDate` | Date
17
+ `isAbandonedCart` | boolean
18
+ `site` | [SiteLiteResource](SiteLiteResource.md)
19
+ `ordersCount` | number
20
+ `cartsCount` | number
21
+
22
+ ## Example
23
+
24
+ ```typescript
25
+ import type { CouponListResource } from '@digital8/lighting-illusions-ts-sdk'
26
+
27
+ // TODO: Update the object below with actual values
28
+ const example = {
29
+ "id": null,
30
+ "name": null,
31
+ "code": null,
32
+ "type": null,
33
+ "discountType": null,
34
+ "discountAmount": null,
35
+ "startDate": null,
36
+ "endDate": null,
37
+ "isAbandonedCart": null,
38
+ "site": null,
39
+ "ordersCount": null,
40
+ "cartsCount": null,
41
+ } satisfies CouponListResource
42
+
43
+ console.log(example)
44
+
45
+ // Convert the instance to a JSON string
46
+ const exampleJSON: string = JSON.stringify(example)
47
+ console.log(exampleJSON)
48
+
49
+ // Parse the JSON string back to an object
50
+ const exampleParsed = JSON.parse(exampleJSON) as CouponListResource
51
+ console.log(exampleParsed)
52
+ ```
53
+
54
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
55
+
56
+
@@ -1,22 +1,22 @@
1
1
 
2
- # CartCouponResourceArrayResponse
2
+ # CouponListResourceArrayResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `data` | [Array<CartCouponResource>](CartCouponResource.md)
9
+ `data` | [Array<CouponListResource>](CouponListResource.md)
10
10
 
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import type { CartCouponResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
14
+ import type { CouponListResourceArrayResponse } 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 CartCouponResourceArrayResponse
19
+ } satisfies CouponListResourceArrayResponse
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 CartCouponResourceArrayResponse
28
+ const exampleParsed = JSON.parse(exampleJSON) as CouponListResourceArrayResponse
29
29
  console.log(exampleParsed)
30
30
  ```
31
31
 
@@ -0,0 +1,38 @@
1
+
2
+ # CouponLiteResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `name` | string
11
+ `code` | string
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { CouponLiteResource } 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
+ "code": null,
23
+ } satisfies CouponLiteResource
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 CouponLiteResource
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
+
@@ -0,0 +1,34 @@
1
+
2
+ # CouponLiteResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<CouponLiteResource>](CouponLiteResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { CouponLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies CouponLiteResourceArrayResponse
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as CouponLiteResourceArrayResponse
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,76 @@
1
+
2
+ # CouponResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | 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
+ `isAbandonedCart` | boolean
20
+ `isForAllProducts` | boolean
21
+ `isForAllCustomers` | boolean
22
+ `startDate` | Date
23
+ `endDate` | Date
24
+ `site` | [SiteLiteResource](SiteLiteResource.md)
25
+ `productChildren` | [Array<ProductChildLiteResource>](ProductChildLiteResource.md)
26
+ `categories` | [Array<ProductCategoryListResource>](ProductCategoryListResource.md)
27
+ `suppliers` | [Array<SupplierListResource>](SupplierListResource.md)
28
+ `customers` | [Array<CustomerListResource>](CustomerListResource.md)
29
+ `ordersCount` | number
30
+ `cartsCount` | number
31
+
32
+ ## Example
33
+
34
+ ```typescript
35
+ import type { CouponResource } from '@digital8/lighting-illusions-ts-sdk'
36
+
37
+ // TODO: Update the object below with actual values
38
+ const example = {
39
+ "id": null,
40
+ "name": null,
41
+ "code": null,
42
+ "type": null,
43
+ "discountType": null,
44
+ "discountAmount": null,
45
+ "minAmount": null,
46
+ "minProducts": null,
47
+ "totalUseLimit": null,
48
+ "customerUseLimit": null,
49
+ "isAbandonedCart": null,
50
+ "isForAllProducts": null,
51
+ "isForAllCustomers": null,
52
+ "startDate": null,
53
+ "endDate": null,
54
+ "site": null,
55
+ "productChildren": null,
56
+ "categories": null,
57
+ "suppliers": null,
58
+ "customers": null,
59
+ "ordersCount": null,
60
+ "cartsCount": null,
61
+ } satisfies CouponResource
62
+
63
+ console.log(example)
64
+
65
+ // Convert the instance to a JSON string
66
+ const exampleJSON: string = JSON.stringify(example)
67
+ console.log(exampleJSON)
68
+
69
+ // Parse the JSON string back to an object
70
+ const exampleParsed = JSON.parse(exampleJSON) as CouponResource
71
+ console.log(exampleParsed)
72
+ ```
73
+
74
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
75
+
76
+
@@ -0,0 +1,34 @@
1
+
2
+ # CouponResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<CouponResource>](CouponResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { CouponResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies CouponResourceArrayResponse
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as CouponResourceArrayResponse
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,32 @@
1
+
2
+ # CouponType
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import type { CouponType } from '@digital8/lighting-illusions-ts-sdk'
14
+
15
+ // TODO: Update the object below with actual values
16
+ const example = {
17
+ } satisfies CouponType
18
+
19
+ console.log(example)
20
+
21
+ // Convert the instance to a JSON string
22
+ const exampleJSON: string = JSON.stringify(example)
23
+ console.log(exampleJSON)
24
+
25
+ // Parse the JSON string back to an object
26
+ const exampleParsed = JSON.parse(exampleJSON) as CouponType
27
+ console.log(exampleParsed)
28
+ ```
29
+
30
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
31
+
32
+