@digital8/lighting-illusions-ts-sdk 0.0.2340 → 0.0.2342

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 (181) hide show
  1. package/.openapi-generator/FILES +36 -14
  2. package/README.md +25 -9
  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 -1
  6. package/dist/apis/index.js +1 -1
  7. package/dist/models/AddressFrontendResource.d.ts +1 -1
  8. package/dist/models/AddressFrontendResource.js +1 -3
  9. package/dist/models/AddressResource.d.ts +1 -1
  10. package/dist/models/AddressResource.js +1 -3
  11. package/dist/models/AdminOrderResource.d.ts +3 -2
  12. package/dist/models/AdminOrderResource.js +3 -2
  13. package/dist/models/CartCouponResource.d.ts +50 -0
  14. package/dist/models/{AppliedCouponResource.js → CartCouponResource.js} +13 -13
  15. package/dist/models/CartCouponResourceArrayResponse.d.ts +33 -0
  16. package/dist/models/CartCouponResourceArrayResponse.js +50 -0
  17. package/dist/models/CartListResource.d.ts +0 -6
  18. package/dist/models/CartListResource.js +0 -4
  19. package/dist/models/CategoryAutomationFieldType.d.ts +0 -2
  20. package/dist/models/CategoryAutomationFieldType.js +1 -3
  21. package/dist/models/CouponListResource.d.ts +99 -0
  22. package/dist/models/CouponListResource.js +90 -0
  23. package/dist/models/CouponListResourceArrayResponse.d.ts +33 -0
  24. package/dist/models/CouponListResourceArrayResponse.js +50 -0
  25. package/dist/models/CouponLiteResource.d.ts +44 -0
  26. package/dist/models/CouponLiteResource.js +57 -0
  27. package/dist/models/CouponLiteResourceArrayResponse.d.ts +33 -0
  28. package/dist/models/CouponLiteResourceArrayResponse.js +50 -0
  29. package/dist/models/CouponResource.d.ts +169 -0
  30. package/dist/models/CouponResource.js +138 -0
  31. package/dist/models/CouponResourceArrayResponse.d.ts +33 -0
  32. package/dist/models/CouponResourceArrayResponse.js +50 -0
  33. package/dist/models/CouponType.d.ts +26 -0
  34. package/dist/models/CouponType.js +52 -0
  35. package/dist/models/CreateCouponRequest.d.ts +134 -0
  36. package/dist/models/CreateCouponRequest.js +114 -0
  37. package/dist/models/CreateCouponRequestCouponablesInner.d.ts +48 -0
  38. package/dist/models/CreateCouponRequestCouponablesInner.js +61 -0
  39. package/dist/models/CreatePageComponentRequest.d.ts +4 -4
  40. package/dist/models/CreatePageComponentRequest.js +4 -4
  41. package/dist/models/CreateProductCategoryRequestAutomationRulesInner.d.ts +0 -2
  42. package/dist/models/CreateProductCategoryRequestAutomationRulesInner.js +1 -3
  43. package/dist/models/CreateSupplierRequest.d.ts +0 -6
  44. package/dist/models/CreateSupplierRequest.js +0 -2
  45. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  46. package/dist/models/ExternalApiLogResource.js +3 -1
  47. package/dist/models/FrontendCartResource.d.ts +0 -18
  48. package/dist/models/FrontendCartResource.js +0 -12
  49. package/dist/models/FrontendOrderResource.d.ts +3 -3
  50. package/dist/models/FrontendOrderResource.js +3 -3
  51. package/dist/models/OrderFulfillmentResource.d.ts +2 -2
  52. package/dist/models/OrderFulfillmentResource.js +3 -3
  53. package/dist/models/OrderStatusWithCountResource.d.ts +0 -12
  54. package/dist/models/OrderStatusWithCountResource.js +0 -8
  55. package/dist/models/PaginatedCouponListResourceResponse.d.ts +40 -0
  56. package/dist/models/PaginatedCouponListResourceResponse.js +57 -0
  57. package/dist/models/PaginatedCouponLiteResourceResponse.d.ts +40 -0
  58. package/dist/models/PaginatedCouponLiteResourceResponse.js +57 -0
  59. package/dist/models/PaginatedCouponResourceResponse.d.ts +40 -0
  60. package/dist/models/PaginatedCouponResourceResponse.js +57 -0
  61. package/dist/models/ProductClassResource.d.ts +2 -2
  62. package/dist/models/SearchAllCouponsRequest.d.ts +101 -0
  63. package/dist/models/SearchAllCouponsRequest.js +85 -0
  64. package/dist/models/SearchAllOrdersRequest.d.ts +0 -6
  65. package/dist/models/SearchAllOrdersRequest.js +0 -2
  66. package/dist/models/SearchCartsRequest.d.ts +6 -0
  67. package/dist/models/SearchCartsRequest.js +2 -0
  68. package/dist/models/SearchCouponsRequest.d.ts +137 -0
  69. package/dist/models/SearchCouponsRequest.js +97 -0
  70. package/dist/models/SearchOrdersRequest.d.ts +6 -6
  71. package/dist/models/SearchOrdersRequest.js +2 -2
  72. package/dist/models/StoreListResource.d.ts +1 -1
  73. package/dist/models/StoreListResource.js +1 -3
  74. package/dist/models/SupplierFrontendResource.d.ts +0 -6
  75. package/dist/models/SupplierFrontendResource.js +0 -4
  76. package/dist/models/SupplierResource.d.ts +0 -6
  77. package/dist/models/SupplierResource.js +0 -4
  78. package/dist/models/UpdateCouponRequest.d.ts +128 -0
  79. package/dist/models/UpdateCouponRequest.js +110 -0
  80. package/dist/models/UpdatePageComponentRequest.d.ts +4 -4
  81. package/dist/models/UpdatePageComponentRequest.js +4 -4
  82. package/dist/models/UpdateSupplierRequest.d.ts +0 -6
  83. package/dist/models/UpdateSupplierRequest.js +0 -2
  84. package/dist/models/index.d.ts +17 -6
  85. package/dist/models/index.js +17 -6
  86. package/docs/AdminOrderResource.md +1 -1
  87. package/docs/{AppliedCouponResource.md → CartCouponResource.md} +4 -4
  88. package/docs/{AppliedCouponResourceArrayResponse.md → CartCouponResourceArrayResponse.md} +5 -5
  89. package/docs/CartListResource.md +0 -2
  90. package/docs/CouponListResource.md +56 -0
  91. package/docs/{ProductClassLiteResourceArrayResponse.md → CouponListResourceArrayResponse.md} +5 -5
  92. package/docs/{ProductClassLiteResource.md → CouponLiteResource.md} +6 -6
  93. package/docs/CouponLiteResourceArrayResponse.md +34 -0
  94. package/docs/CouponResource.md +78 -0
  95. package/docs/CouponResourceArrayResponse.md +34 -0
  96. package/docs/CouponType.md +32 -0
  97. package/docs/CouponsApi.md +407 -0
  98. package/docs/CreateCouponRequest.md +62 -0
  99. package/docs/CreateCouponRequestCouponablesInner.md +36 -0
  100. package/docs/CreatePageComponentRequest.md +2 -2
  101. package/docs/CreateSupplierRequest.md +0 -2
  102. package/docs/FrontendCartResource.md +0 -6
  103. package/docs/FrontendOrderResource.md +1 -1
  104. package/docs/OrderStatusWithCountResource.md +0 -4
  105. package/docs/{PaginatedProductClassLiteResourceResponse.md → PaginatedCouponListResourceResponse.md} +5 -5
  106. package/docs/PaginatedCouponLiteResourceResponse.md +36 -0
  107. package/docs/PaginatedCouponResourceResponse.md +36 -0
  108. package/docs/ProductClassResource.md +1 -1
  109. package/docs/{SearchAllProductClassesRequest.md → SearchAllCouponsRequest.md} +10 -4
  110. package/docs/SearchAllOrdersRequest.md +0 -2
  111. package/docs/SearchCartsRequest.md +2 -0
  112. package/docs/SearchCouponsRequest.md +62 -0
  113. package/docs/SearchOrdersRequest.md +2 -2
  114. package/docs/SupplierFrontendResource.md +0 -2
  115. package/docs/SupplierResource.md +0 -2
  116. package/docs/UpdateCouponRequest.md +60 -0
  117. package/docs/UpdatePageComponentRequest.md +2 -2
  118. package/docs/UpdateSupplierRequest.md +0 -2
  119. package/package.json +1 -1
  120. package/src/apis/CouponsApi.ts +345 -0
  121. package/src/apis/index.ts +1 -1
  122. package/src/models/AddressFrontendResource.ts +2 -3
  123. package/src/models/AddressResource.ts +2 -3
  124. package/src/models/AdminOrderResource.ts +11 -4
  125. package/src/models/{AppliedCouponResource.ts → CartCouponResource.ts} +14 -14
  126. package/src/models/CartCouponResourceArrayResponse.ts +73 -0
  127. package/src/models/CartListResource.ts +0 -9
  128. package/src/models/CategoryAutomationFieldType.ts +1 -3
  129. package/src/models/CouponListResource.ts +170 -0
  130. package/src/models/CouponListResourceArrayResponse.ts +73 -0
  131. package/src/models/CouponLiteResource.ts +83 -0
  132. package/src/models/CouponLiteResourceArrayResponse.ts +73 -0
  133. package/src/models/CouponResource.ts +297 -0
  134. package/src/models/CouponResourceArrayResponse.ts +73 -0
  135. package/src/models/CouponType.ts +54 -0
  136. package/src/models/CreateCouponRequest.ts +216 -0
  137. package/src/models/CreateCouponRequestCouponablesInner.ts +86 -0
  138. package/src/models/CreatePageComponentRequest.ts +8 -8
  139. package/src/models/CreateProductCategoryRequestAutomationRulesInner.ts +1 -3
  140. package/src/models/CreateSupplierRequest.ts +0 -8
  141. package/src/models/ExternalApiLogResource.ts +3 -2
  142. package/src/models/FrontendCartResource.ts +0 -27
  143. package/src/models/FrontendOrderResource.ts +11 -11
  144. package/src/models/OrderFulfillmentResource.ts +5 -5
  145. package/src/models/OrderStatusWithCountResource.ts +0 -18
  146. package/src/models/PaginatedCouponListResourceResponse.ts +90 -0
  147. package/src/models/PaginatedCouponLiteResourceResponse.ts +90 -0
  148. package/src/models/PaginatedCouponResourceResponse.ts +90 -0
  149. package/src/models/ProductClassResource.ts +2 -2
  150. package/src/models/SearchAllCouponsRequest.ts +154 -0
  151. package/src/models/SearchAllOrdersRequest.ts +0 -8
  152. package/src/models/SearchCartsRequest.ts +8 -0
  153. package/src/models/SearchCouponsRequest.ts +202 -0
  154. package/src/models/SearchOrdersRequest.ts +8 -8
  155. package/src/models/StoreListResource.ts +2 -3
  156. package/src/models/SupplierFrontendResource.ts +0 -9
  157. package/src/models/SupplierResource.ts +0 -9
  158. package/src/models/UpdateCouponRequest.ts +207 -0
  159. package/src/models/UpdatePageComponentRequest.ts +8 -8
  160. package/src/models/UpdateSupplierRequest.ts +0 -8
  161. package/src/models/index.ts +17 -6
  162. package/dist/apis/ProductClassApi.d.ts +0 -34
  163. package/dist/apis/ProductClassApi.js +0 -139
  164. package/dist/models/AppliedCouponResource.d.ts +0 -50
  165. package/dist/models/AppliedCouponResourceArrayResponse.d.ts +0 -33
  166. package/dist/models/AppliedCouponResourceArrayResponse.js +0 -50
  167. package/dist/models/PaginatedProductClassLiteResourceResponse.d.ts +0 -40
  168. package/dist/models/PaginatedProductClassLiteResourceResponse.js +0 -57
  169. package/dist/models/ProductClassLiteResource.d.ts +0 -44
  170. package/dist/models/ProductClassLiteResource.js +0 -57
  171. package/dist/models/ProductClassLiteResourceArrayResponse.d.ts +0 -33
  172. package/dist/models/ProductClassLiteResourceArrayResponse.js +0 -50
  173. package/dist/models/SearchAllProductClassesRequest.d.ts +0 -78
  174. package/dist/models/SearchAllProductClassesRequest.js +0 -74
  175. package/docs/ProductClassApi.md +0 -74
  176. package/src/apis/ProductClassApi.ts +0 -76
  177. package/src/models/AppliedCouponResourceArrayResponse.ts +0 -73
  178. package/src/models/PaginatedProductClassLiteResourceResponse.ts +0 -90
  179. package/src/models/ProductClassLiteResource.ts +0 -83
  180. package/src/models/ProductClassLiteResourceArrayResponse.ts +0 -73
  181. package/src/models/SearchAllProductClassesRequest.ts +0 -125
@@ -9,7 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `netsuiteId` | string
11
11
  `name` | string
12
- `parentId` | number
12
+ `parentId` | string
13
13
 
14
14
  ## Example
15
15
 
@@ -1,5 +1,5 @@
1
1
 
2
- # SearchAllProductClassesRequest
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 { SearchAllProductClassesRequest } from '@digital8/lighting-illusions-ts-sdk'
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
- } satisfies SearchAllProductClassesRequest
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 SearchAllProductClassesRequest
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
@@ -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` | 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
+
@@ -9,8 +9,8 @@ Name | Type
9
9
  `type` | string
10
10
  `disabled` | boolean
11
11
  `order` | number
12
- `startDate` | string
13
- `endDate` | string
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,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/lighting-illusions-ts-sdk",
3
- "version": "0.0.2340",
3
+ "version": "0.0.2342",
4
4
  "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -0,0 +1,345 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * My API
5
+ * API documentation for my Laravel app
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import * as runtime from '../runtime';
16
+ import {
17
+ type CouponLiteResourceArrayResponse,
18
+ CouponLiteResourceArrayResponseFromJSON,
19
+ CouponLiteResourceArrayResponseToJSON,
20
+ } from '../models/CouponLiteResourceArrayResponse';
21
+ import {
22
+ type CouponResource,
23
+ CouponResourceFromJSON,
24
+ CouponResourceToJSON,
25
+ } from '../models/CouponResource';
26
+ import {
27
+ type CreateCouponRequest,
28
+ CreateCouponRequestFromJSON,
29
+ CreateCouponRequestToJSON,
30
+ } from '../models/CreateCouponRequest';
31
+ import {
32
+ type GenericResponse,
33
+ GenericResponseFromJSON,
34
+ GenericResponseToJSON,
35
+ } from '../models/GenericResponse';
36
+ import {
37
+ type PaginatedCouponListResourceResponse,
38
+ PaginatedCouponListResourceResponseFromJSON,
39
+ PaginatedCouponListResourceResponseToJSON,
40
+ } from '../models/PaginatedCouponListResourceResponse';
41
+ import {
42
+ type SearchAllCouponsRequest,
43
+ SearchAllCouponsRequestFromJSON,
44
+ SearchAllCouponsRequestToJSON,
45
+ } from '../models/SearchAllCouponsRequest';
46
+ import {
47
+ type SearchCouponsRequest,
48
+ SearchCouponsRequestFromJSON,
49
+ SearchCouponsRequestToJSON,
50
+ } from '../models/SearchCouponsRequest';
51
+ import {
52
+ type UpdateCouponRequest,
53
+ UpdateCouponRequestFromJSON,
54
+ UpdateCouponRequestToJSON,
55
+ } from '../models/UpdateCouponRequest';
56
+
57
+ export interface DestroyCouponRequest {
58
+ coupon: number;
59
+ }
60
+
61
+ export interface GetAllCouponRequest {
62
+ searchAllCouponsRequest?: SearchAllCouponsRequest;
63
+ }
64
+
65
+ export interface IndexCouponRequest {
66
+ searchCouponsRequest?: SearchCouponsRequest;
67
+ }
68
+
69
+ export interface ShowCouponRequest {
70
+ coupon: number;
71
+ }
72
+
73
+ export interface StoreCouponRequest {
74
+ createCouponRequest?: CreateCouponRequest;
75
+ }
76
+
77
+ export interface UpdateCouponOperationRequest {
78
+ coupon: number;
79
+ updateCouponRequest?: UpdateCouponRequest;
80
+ }
81
+
82
+ /**
83
+ *
84
+ */
85
+ export class CouponsApi extends runtime.BaseAPI {
86
+
87
+ /**
88
+ * Creates request options for destroyCoupon without sending the request
89
+ */
90
+ async destroyCouponRequestOpts(requestParameters: DestroyCouponRequest): Promise<runtime.RequestOpts> {
91
+ if (requestParameters['coupon'] == null) {
92
+ throw new runtime.RequiredError(
93
+ 'coupon',
94
+ 'Required parameter "coupon" was null or undefined when calling destroyCoupon().'
95
+ );
96
+ }
97
+
98
+ const queryParameters: any = {};
99
+
100
+ const headerParameters: runtime.HTTPHeaders = {};
101
+
102
+
103
+ let urlPath = `/admin-api/coupons/{coupon}/delete`;
104
+ urlPath = urlPath.replace('{coupon}', encodeURIComponent(String(requestParameters['coupon'])));
105
+
106
+ return {
107
+ path: urlPath,
108
+ method: 'DELETE',
109
+ headers: headerParameters,
110
+ query: queryParameters,
111
+ };
112
+ }
113
+
114
+ /**
115
+ * Auto-generated: destroyCoupon
116
+ */
117
+ async destroyCouponRaw(requestParameters: DestroyCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
118
+ const requestOptions = await this.destroyCouponRequestOpts(requestParameters);
119
+ const response = await this.request(requestOptions, initOverrides);
120
+
121
+ return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
122
+ }
123
+
124
+ /**
125
+ * Auto-generated: destroyCoupon
126
+ */
127
+ async destroyCoupon(requestParameters: DestroyCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
128
+ const response = await this.destroyCouponRaw(requestParameters, initOverrides);
129
+ return await response.value();
130
+ }
131
+
132
+ /**
133
+ * Creates request options for getAllCoupon without sending the request
134
+ */
135
+ async getAllCouponRequestOpts(requestParameters: GetAllCouponRequest): Promise<runtime.RequestOpts> {
136
+ const queryParameters: any = {};
137
+
138
+ const headerParameters: runtime.HTTPHeaders = {};
139
+
140
+ headerParameters['Content-Type'] = 'application/json';
141
+
142
+
143
+ let urlPath = `/admin-api/coupons/all`;
144
+
145
+ return {
146
+ path: urlPath,
147
+ method: 'POST',
148
+ headers: headerParameters,
149
+ query: queryParameters,
150
+ body: SearchAllCouponsRequestToJSON(requestParameters['searchAllCouponsRequest']),
151
+ };
152
+ }
153
+
154
+ /**
155
+ * Auto-generated: getAllCoupon
156
+ */
157
+ async getAllCouponRaw(requestParameters: GetAllCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CouponLiteResourceArrayResponse>> {
158
+ const requestOptions = await this.getAllCouponRequestOpts(requestParameters);
159
+ const response = await this.request(requestOptions, initOverrides);
160
+
161
+ return new runtime.JSONApiResponse(response, (jsonValue) => CouponLiteResourceArrayResponseFromJSON(jsonValue));
162
+ }
163
+
164
+ /**
165
+ * Auto-generated: getAllCoupon
166
+ */
167
+ async getAllCoupon(requestParameters: GetAllCouponRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CouponLiteResourceArrayResponse> {
168
+ const response = await this.getAllCouponRaw(requestParameters, initOverrides);
169
+ return await response.value();
170
+ }
171
+
172
+ /**
173
+ * Creates request options for indexCoupon without sending the request
174
+ */
175
+ async indexCouponRequestOpts(requestParameters: IndexCouponRequest): Promise<runtime.RequestOpts> {
176
+ const queryParameters: any = {};
177
+
178
+ const headerParameters: runtime.HTTPHeaders = {};
179
+
180
+ headerParameters['Content-Type'] = 'application/json';
181
+
182
+
183
+ let urlPath = `/admin-api/coupons/list`;
184
+
185
+ return {
186
+ path: urlPath,
187
+ method: 'POST',
188
+ headers: headerParameters,
189
+ query: queryParameters,
190
+ body: SearchCouponsRequestToJSON(requestParameters['searchCouponsRequest']),
191
+ };
192
+ }
193
+
194
+ /**
195
+ * Auto-generated: indexCoupon
196
+ */
197
+ async indexCouponRaw(requestParameters: IndexCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedCouponListResourceResponse>> {
198
+ const requestOptions = await this.indexCouponRequestOpts(requestParameters);
199
+ const response = await this.request(requestOptions, initOverrides);
200
+
201
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedCouponListResourceResponseFromJSON(jsonValue));
202
+ }
203
+
204
+ /**
205
+ * Auto-generated: indexCoupon
206
+ */
207
+ async indexCoupon(requestParameters: IndexCouponRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedCouponListResourceResponse> {
208
+ const response = await this.indexCouponRaw(requestParameters, initOverrides);
209
+ return await response.value();
210
+ }
211
+
212
+ /**
213
+ * Creates request options for showCoupon without sending the request
214
+ */
215
+ async showCouponRequestOpts(requestParameters: ShowCouponRequest): Promise<runtime.RequestOpts> {
216
+ if (requestParameters['coupon'] == null) {
217
+ throw new runtime.RequiredError(
218
+ 'coupon',
219
+ 'Required parameter "coupon" was null or undefined when calling showCoupon().'
220
+ );
221
+ }
222
+
223
+ const queryParameters: any = {};
224
+
225
+ const headerParameters: runtime.HTTPHeaders = {};
226
+
227
+
228
+ let urlPath = `/admin-api/coupons/{coupon}`;
229
+ urlPath = urlPath.replace('{coupon}', encodeURIComponent(String(requestParameters['coupon'])));
230
+
231
+ return {
232
+ path: urlPath,
233
+ method: 'GET',
234
+ headers: headerParameters,
235
+ query: queryParameters,
236
+ };
237
+ }
238
+
239
+ /**
240
+ * Auto-generated: showCoupon
241
+ */
242
+ async showCouponRaw(requestParameters: ShowCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CouponResource>> {
243
+ const requestOptions = await this.showCouponRequestOpts(requestParameters);
244
+ const response = await this.request(requestOptions, initOverrides);
245
+
246
+ return new runtime.JSONApiResponse(response, (jsonValue) => CouponResourceFromJSON(jsonValue));
247
+ }
248
+
249
+ /**
250
+ * Auto-generated: showCoupon
251
+ */
252
+ async showCoupon(requestParameters: ShowCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CouponResource> {
253
+ const response = await this.showCouponRaw(requestParameters, initOverrides);
254
+ return await response.value();
255
+ }
256
+
257
+ /**
258
+ * Creates request options for storeCoupon without sending the request
259
+ */
260
+ async storeCouponRequestOpts(requestParameters: StoreCouponRequest): Promise<runtime.RequestOpts> {
261
+ const queryParameters: any = {};
262
+
263
+ const headerParameters: runtime.HTTPHeaders = {};
264
+
265
+ headerParameters['Content-Type'] = 'application/json';
266
+
267
+
268
+ let urlPath = `/admin-api/coupons/create`;
269
+
270
+ return {
271
+ path: urlPath,
272
+ method: 'POST',
273
+ headers: headerParameters,
274
+ query: queryParameters,
275
+ body: CreateCouponRequestToJSON(requestParameters['createCouponRequest']),
276
+ };
277
+ }
278
+
279
+ /**
280
+ * Auto-generated: storeCoupon
281
+ */
282
+ async storeCouponRaw(requestParameters: StoreCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CouponResource>> {
283
+ const requestOptions = await this.storeCouponRequestOpts(requestParameters);
284
+ const response = await this.request(requestOptions, initOverrides);
285
+
286
+ return new runtime.JSONApiResponse(response, (jsonValue) => CouponResourceFromJSON(jsonValue));
287
+ }
288
+
289
+ /**
290
+ * Auto-generated: storeCoupon
291
+ */
292
+ async storeCoupon(requestParameters: StoreCouponRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CouponResource> {
293
+ const response = await this.storeCouponRaw(requestParameters, initOverrides);
294
+ return await response.value();
295
+ }
296
+
297
+ /**
298
+ * Creates request options for updateCoupon without sending the request
299
+ */
300
+ async updateCouponRequestOpts(requestParameters: UpdateCouponOperationRequest): Promise<runtime.RequestOpts> {
301
+ if (requestParameters['coupon'] == null) {
302
+ throw new runtime.RequiredError(
303
+ 'coupon',
304
+ 'Required parameter "coupon" was null or undefined when calling updateCoupon().'
305
+ );
306
+ }
307
+
308
+ const queryParameters: any = {};
309
+
310
+ const headerParameters: runtime.HTTPHeaders = {};
311
+
312
+ headerParameters['Content-Type'] = 'application/json';
313
+
314
+
315
+ let urlPath = `/admin-api/coupons/{coupon}/update`;
316
+ urlPath = urlPath.replace('{coupon}', encodeURIComponent(String(requestParameters['coupon'])));
317
+
318
+ return {
319
+ path: urlPath,
320
+ method: 'PUT',
321
+ headers: headerParameters,
322
+ query: queryParameters,
323
+ body: UpdateCouponRequestToJSON(requestParameters['updateCouponRequest']),
324
+ };
325
+ }
326
+
327
+ /**
328
+ * Auto-generated: updateCoupon
329
+ */
330
+ async updateCouponRaw(requestParameters: UpdateCouponOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CouponResource>> {
331
+ const requestOptions = await this.updateCouponRequestOpts(requestParameters);
332
+ const response = await this.request(requestOptions, initOverrides);
333
+
334
+ return new runtime.JSONApiResponse(response, (jsonValue) => CouponResourceFromJSON(jsonValue));
335
+ }
336
+
337
+ /**
338
+ * Auto-generated: updateCoupon
339
+ */
340
+ async updateCoupon(requestParameters: UpdateCouponOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CouponResource> {
341
+ const response = await this.updateCouponRaw(requestParameters, initOverrides);
342
+ return await response.value();
343
+ }
344
+
345
+ }
package/src/apis/index.ts CHANGED
@@ -5,6 +5,7 @@ export * from './AssetApi';
5
5
  export * from './AttributeApi';
6
6
  export * from './BlogCategoryApi';
7
7
  export * from './CartsApi';
8
+ export * from './CouponsApi';
8
9
  export * from './CustomersApi';
9
10
  export * from './DefinitionApi';
10
11
  export * from './DocumentApi';
@@ -20,7 +21,6 @@ export * from './PageApi';
20
21
  export * from './PageComponentApi';
21
22
  export * from './ProductApi';
22
23
  export * from './ProductCategoryApi';
23
- export * from './ProductClassApi';
24
24
  export * from './ProductRangeApi';
25
25
  export * from './ProductRegistrationApi';
26
26
  export * from './ProductTypeApi';