@digital8/lighting-illusions-ts-sdk 0.0.2311 → 0.0.2313

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 (239) hide show
  1. package/.openapi-generator/FILES +32 -64
  2. package/README.md +23 -42
  3. package/dist/apis/CouponsApi.d.ts +116 -0
  4. package/dist/apis/{AdminsApi.js → CouponsApi.js} +85 -85
  5. package/dist/apis/CustomersApi.d.ts +0 -50
  6. package/dist/apis/CustomersApi.js +0 -182
  7. package/dist/apis/index.d.ts +1 -1
  8. package/dist/apis/index.js +1 -1
  9. package/dist/models/AddressFrontendResource.d.ts +1 -1
  10. package/dist/models/AddressFrontendResource.js +1 -3
  11. package/dist/models/AddressResource.d.ts +1 -1
  12. package/dist/models/AddressResource.js +3 -1
  13. package/dist/models/AddressType.d.ts +0 -2
  14. package/dist/models/AddressType.js +1 -3
  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 +169 -0
  24. package/dist/models/CouponResource.js +138 -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/CreateCustomerRequest.d.ts +6 -18
  34. package/dist/models/CreateCustomerRequest.js +6 -12
  35. package/dist/models/CustomerListResource.d.ts +8 -21
  36. package/dist/models/CustomerListResource.js +13 -20
  37. package/dist/models/CustomerResource.d.ts +9 -34
  38. package/dist/models/CustomerResource.js +16 -27
  39. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  40. package/dist/models/ExternalApiLogResource.js +3 -1
  41. package/dist/models/OrderFulfillmentResource.d.ts +2 -2
  42. package/dist/models/OrderFulfillmentResource.js +3 -3
  43. package/dist/models/PaginatedCouponListResourceResponse.d.ts +40 -0
  44. package/dist/models/PaginatedCouponListResourceResponse.js +57 -0
  45. package/dist/models/PaginatedCouponLiteResourceResponse.d.ts +40 -0
  46. package/dist/models/PaginatedCouponLiteResourceResponse.js +57 -0
  47. package/dist/models/PaginatedCouponResourceResponse.d.ts +40 -0
  48. package/dist/models/PaginatedCouponResourceResponse.js +57 -0
  49. package/dist/models/SearchAllCouponsRequest.d.ts +101 -0
  50. package/dist/models/{SearchAllCustomersRequest.js → SearchAllCouponsRequest.js} +25 -27
  51. package/dist/models/SearchCartsRequest.d.ts +6 -0
  52. package/dist/models/SearchCartsRequest.js +2 -0
  53. package/dist/models/SearchCouponsRequest.d.ts +137 -0
  54. package/dist/models/SearchCouponsRequest.js +97 -0
  55. package/dist/models/SearchCustomersRequest.d.ts +3 -31
  56. package/dist/models/SearchCustomersRequest.js +3 -15
  57. package/dist/models/SearchOrdersRequest.d.ts +6 -0
  58. package/dist/models/SearchOrdersRequest.js +2 -0
  59. package/dist/models/StoreFrontendResource.d.ts +1 -1
  60. package/dist/models/StoreFrontendResource.js +3 -1
  61. package/dist/models/StoreResource.d.ts +1 -1
  62. package/dist/models/StoreResource.js +3 -1
  63. package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
  64. package/dist/models/StoreSpecialDateFrontendResource.js +1 -3
  65. package/dist/models/UpdateCouponRequest.d.ts +128 -0
  66. package/dist/models/UpdateCouponRequest.js +110 -0
  67. package/dist/models/index.d.ts +15 -31
  68. package/dist/models/index.js +15 -31
  69. package/docs/{CustomerFrontendResource.md → CouponListResource.md} +22 -12
  70. package/docs/{AdminListResourceArrayResponse.md → CouponListResourceArrayResponse.md} +5 -5
  71. package/docs/{RoleLiteResource.md → CouponLiteResource.md} +6 -4
  72. package/docs/{RoleLiteResourceArrayResponse.md → CouponLiteResourceArrayResponse.md} +5 -5
  73. package/docs/CouponResource.md +78 -0
  74. package/docs/{AdminResourceArrayResponse.md → CouponResourceArrayResponse.md} +5 -5
  75. package/docs/{SignUpType.md → CouponType.md} +4 -4
  76. package/docs/{AdminsApi.md → CouponsApi.md} +82 -82
  77. package/docs/CreateCouponRequest.md +62 -0
  78. package/docs/{AdminLiteResource.md → CreateCouponRequestCouponablesInner.md} +6 -6
  79. package/docs/CreateCustomerRequest.md +4 -8
  80. package/docs/CustomerListResource.md +8 -12
  81. package/docs/CustomerResource.md +9 -17
  82. package/docs/CustomersApi.md +0 -201
  83. package/docs/{PaginatedAdminListResourceResponse.md → PaginatedCouponListResourceResponse.md} +5 -5
  84. package/docs/{PaginatedAdminLiteResourceResponse.md → PaginatedCouponLiteResourceResponse.md} +5 -5
  85. package/docs/{PaginatedRoleLiteResourceResponse.md → PaginatedCouponResourceResponse.md} +5 -5
  86. package/docs/{SearchAllCustomersRequest.md → SearchAllCouponsRequest.md} +8 -8
  87. package/docs/SearchCartsRequest.md +2 -0
  88. package/docs/{SearchAdminUsersRequest.md → SearchCouponsRequest.md} +18 -10
  89. package/docs/SearchCustomersRequest.md +0 -8
  90. package/docs/SearchOrdersRequest.md +2 -0
  91. package/docs/StoreSpecialDateFrontendResource.md +1 -1
  92. package/docs/UpdateCouponRequest.md +60 -0
  93. package/package.json +1 -1
  94. package/src/apis/CouponsApi.ts +345 -0
  95. package/src/apis/CustomersApi.ts +0 -166
  96. package/src/apis/index.ts +1 -1
  97. package/src/models/AddressFrontendResource.ts +2 -3
  98. package/src/models/AddressResource.ts +3 -2
  99. package/src/models/AddressType.ts +1 -3
  100. package/src/models/CouponListResource.ts +170 -0
  101. package/src/models/CouponListResourceArrayResponse.ts +73 -0
  102. package/src/models/CouponLiteResource.ts +83 -0
  103. package/src/models/CouponLiteResourceArrayResponse.ts +73 -0
  104. package/src/models/CouponResource.ts +297 -0
  105. package/src/models/CouponResourceArrayResponse.ts +73 -0
  106. package/src/models/CouponType.ts +54 -0
  107. package/src/models/CreateCouponRequest.ts +216 -0
  108. package/src/models/CreateCouponRequestCouponablesInner.ts +86 -0
  109. package/src/models/CreateCustomerRequest.ts +11 -28
  110. package/src/models/CustomerListResource.ts +20 -44
  111. package/src/models/CustomerResource.ts +28 -68
  112. package/src/models/ExternalApiLogResource.ts +3 -2
  113. package/src/models/OrderFulfillmentResource.ts +5 -5
  114. package/src/models/PaginatedCouponListResourceResponse.ts +90 -0
  115. package/src/models/PaginatedCouponLiteResourceResponse.ts +90 -0
  116. package/src/models/PaginatedCouponResourceResponse.ts +90 -0
  117. package/src/models/SearchAllCouponsRequest.ts +154 -0
  118. package/src/models/SearchCartsRequest.ts +8 -0
  119. package/src/models/SearchCouponsRequest.ts +202 -0
  120. package/src/models/SearchCustomersRequest.ts +3 -39
  121. package/src/models/SearchOrdersRequest.ts +8 -0
  122. package/src/models/StoreFrontendResource.ts +3 -2
  123. package/src/models/StoreResource.ts +3 -2
  124. package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
  125. package/src/models/UpdateCouponRequest.ts +207 -0
  126. package/src/models/index.ts +15 -31
  127. package/dist/apis/AdminsApi.d.ts +0 -116
  128. package/dist/models/AdminListResource.d.ts +0 -52
  129. package/dist/models/AdminListResource.js +0 -61
  130. package/dist/models/AdminListResourceArrayResponse.d.ts +0 -33
  131. package/dist/models/AdminListResourceArrayResponse.js +0 -50
  132. package/dist/models/AdminLiteResource.d.ts +0 -39
  133. package/dist/models/AdminLiteResource.js +0 -54
  134. package/dist/models/AdminLiteResourceArrayResponse.d.ts +0 -33
  135. package/dist/models/AdminLiteResourceArrayResponse.js +0 -50
  136. package/dist/models/AdminResource.d.ts +0 -58
  137. package/dist/models/AdminResource.js +0 -63
  138. package/dist/models/AdminResourceArrayResponse.d.ts +0 -33
  139. package/dist/models/AdminResourceArrayResponse.js +0 -50
  140. package/dist/models/CheckEmailFrontendResource.d.ts +0 -38
  141. package/dist/models/CheckEmailFrontendResource.js +0 -53
  142. package/dist/models/CheckEmailFrontendResourceArrayResponse.d.ts +0 -33
  143. package/dist/models/CheckEmailFrontendResourceArrayResponse.js +0 -50
  144. package/dist/models/CreateAdminUserRequest.d.ts +0 -62
  145. package/dist/models/CreateAdminUserRequest.js +0 -69
  146. package/dist/models/CustomerAuthResponseResource.d.ts +0 -39
  147. package/dist/models/CustomerAuthResponseResource.js +0 -56
  148. package/dist/models/CustomerAuthResponseResourceArrayResponse.d.ts +0 -33
  149. package/dist/models/CustomerAuthResponseResourceArrayResponse.js +0 -50
  150. package/dist/models/CustomerFrontendResource.d.ts +0 -70
  151. package/dist/models/CustomerFrontendResource.js +0 -75
  152. package/dist/models/CustomerFrontendResourceArrayResponse.d.ts +0 -33
  153. package/dist/models/CustomerFrontendResourceArrayResponse.js +0 -50
  154. package/dist/models/CustomerSocialLinkableResource.d.ts +0 -38
  155. package/dist/models/CustomerSocialLinkableResource.js +0 -55
  156. package/dist/models/CustomerSocialLinkableResourceArrayResponse.d.ts +0 -33
  157. package/dist/models/CustomerSocialLinkableResourceArrayResponse.js +0 -50
  158. package/dist/models/CustomerType.d.ts +0 -25
  159. package/dist/models/CustomerType.js +0 -51
  160. package/dist/models/PaginatedAdminListResourceResponse.d.ts +0 -40
  161. package/dist/models/PaginatedAdminListResourceResponse.js +0 -57
  162. package/dist/models/PaginatedAdminLiteResourceResponse.d.ts +0 -40
  163. package/dist/models/PaginatedAdminLiteResourceResponse.js +0 -57
  164. package/dist/models/PaginatedRoleLiteResourceResponse.d.ts +0 -40
  165. package/dist/models/PaginatedRoleLiteResourceResponse.js +0 -57
  166. package/dist/models/RoleLiteResource.d.ts +0 -38
  167. package/dist/models/RoleLiteResource.js +0 -53
  168. package/dist/models/RoleLiteResourceArrayResponse.d.ts +0 -33
  169. package/dist/models/RoleLiteResourceArrayResponse.js +0 -50
  170. package/dist/models/SearchAdminUsersRequest.d.ts +0 -112
  171. package/dist/models/SearchAdminUsersRequest.js +0 -88
  172. package/dist/models/SearchAllAdminUsersRequest.d.ts +0 -82
  173. package/dist/models/SearchAllAdminUsersRequest.js +0 -78
  174. package/dist/models/SearchAllCustomersRequest.d.ts +0 -103
  175. package/dist/models/SignUpType.d.ts +0 -29
  176. package/dist/models/SignUpType.js +0 -55
  177. package/dist/models/SocialProvider.d.ts +0 -26
  178. package/dist/models/SocialProvider.js +0 -52
  179. package/dist/models/UpdateAdminUserRequest.d.ts +0 -62
  180. package/dist/models/UpdateAdminUserRequest.js +0 -67
  181. package/dist/models/UpdateCustomerRequest.d.ts +0 -62
  182. package/dist/models/UpdateCustomerRequest.js +0 -65
  183. package/dist/models/UserLiteResource.d.ts +0 -62
  184. package/dist/models/UserLiteResource.js +0 -69
  185. package/dist/models/UserLiteResourceArrayResponse.d.ts +0 -33
  186. package/dist/models/UserLiteResourceArrayResponse.js +0 -50
  187. package/dist/models/UserType.d.ts +0 -25
  188. package/dist/models/UserType.js +0 -51
  189. package/docs/AdminListResource.md +0 -40
  190. package/docs/AdminLiteResourceArrayResponse.md +0 -34
  191. package/docs/AdminResource.md +0 -42
  192. package/docs/CheckEmailFrontendResource.md +0 -36
  193. package/docs/CheckEmailFrontendResourceArrayResponse.md +0 -34
  194. package/docs/CreateAdminUserRequest.md +0 -44
  195. package/docs/CustomerAuthResponseResource.md +0 -36
  196. package/docs/CustomerAuthResponseResourceArrayResponse.md +0 -34
  197. package/docs/CustomerFrontendResourceArrayResponse.md +0 -34
  198. package/docs/CustomerSocialLinkableResource.md +0 -36
  199. package/docs/CustomerSocialLinkableResourceArrayResponse.md +0 -34
  200. package/docs/CustomerType.md +0 -32
  201. package/docs/SearchAllAdminUsersRequest.md +0 -44
  202. package/docs/SocialProvider.md +0 -32
  203. package/docs/UpdateAdminUserRequest.md +0 -44
  204. package/docs/UpdateCustomerRequest.md +0 -44
  205. package/docs/UserLiteResource.md +0 -44
  206. package/docs/UserLiteResourceArrayResponse.md +0 -34
  207. package/docs/UserType.md +0 -32
  208. package/src/apis/AdminsApi.ts +0 -345
  209. package/src/models/AdminListResource.ts +0 -106
  210. package/src/models/AdminListResourceArrayResponse.ts +0 -73
  211. package/src/models/AdminLiteResource.ts +0 -82
  212. package/src/models/AdminLiteResourceArrayResponse.ts +0 -73
  213. package/src/models/AdminResource.ts +0 -114
  214. package/src/models/AdminResourceArrayResponse.ts +0 -73
  215. package/src/models/CheckEmailFrontendResource.ts +0 -74
  216. package/src/models/CheckEmailFrontendResourceArrayResponse.ts +0 -73
  217. package/src/models/CreateAdminUserRequest.ts +0 -110
  218. package/src/models/CustomerAuthResponseResource.ts +0 -83
  219. package/src/models/CustomerAuthResponseResourceArrayResponse.ts +0 -73
  220. package/src/models/CustomerFrontendResource.ts +0 -134
  221. package/src/models/CustomerFrontendResourceArrayResponse.ts +0 -73
  222. package/src/models/CustomerSocialLinkableResource.ts +0 -75
  223. package/src/models/CustomerSocialLinkableResourceArrayResponse.ts +0 -73
  224. package/src/models/CustomerType.ts +0 -53
  225. package/src/models/PaginatedAdminListResourceResponse.ts +0 -90
  226. package/src/models/PaginatedAdminLiteResourceResponse.ts +0 -90
  227. package/src/models/PaginatedRoleLiteResourceResponse.ts +0 -90
  228. package/src/models/RoleLiteResource.ts +0 -74
  229. package/src/models/RoleLiteResourceArrayResponse.ts +0 -73
  230. package/src/models/SearchAdminUsersRequest.ts +0 -169
  231. package/src/models/SearchAllAdminUsersRequest.ts +0 -129
  232. package/src/models/SearchAllCustomersRequest.ts +0 -156
  233. package/src/models/SignUpType.ts +0 -57
  234. package/src/models/SocialProvider.ts +0 -54
  235. package/src/models/UpdateAdminUserRequest.ts +0 -109
  236. package/src/models/UpdateCustomerRequest.ts +0 -108
  237. package/src/models/UserLiteResource.ts +0 -110
  238. package/src/models/UserLiteResourceArrayResponse.ts +0 -73
  239. package/src/models/UserType.ts +0 -53
@@ -4,145 +4,12 @@ All URIs are relative to *http://localhost/api*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
- | [**destroyCustomer**](CustomersApi.md#destroycustomer) | **DELETE** /admin-api/customers/{customer}/delete | Auto-generated: destroyCustomer |
8
- | [**getAllCustomer**](CustomersApi.md#getallcustomer) | **POST** /admin-api/customers/all | Auto-generated: getAllCustomer |
9
7
  | [**indexCustomer**](CustomersApi.md#indexcustomer) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
10
8
  | [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
11
9
  | [**storeCustomer**](CustomersApi.md#storecustomer) | **POST** /admin-api/customers/create | Auto-generated: storeCustomer |
12
- | [**updateCustomer**](CustomersApi.md#updatecustomeroperation) | **PUT** /admin-api/customers/{customer}/update | Auto-generated: updateCustomer |
13
10
 
14
11
 
15
12
 
16
- ## destroyCustomer
17
-
18
- > GenericResponse destroyCustomer(customer)
19
-
20
- Auto-generated: destroyCustomer
21
-
22
- ### Example
23
-
24
- ```ts
25
- import {
26
- Configuration,
27
- CustomersApi,
28
- } from '@digital8/lighting-illusions-ts-sdk';
29
- import type { DestroyCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
30
-
31
- async function example() {
32
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
33
- const api = new CustomersApi();
34
-
35
- const body = {
36
- // number | The id of the customer
37
- customer: 56,
38
- } satisfies DestroyCustomerRequest;
39
-
40
- try {
41
- const data = await api.destroyCustomer(body);
42
- console.log(data);
43
- } catch (error) {
44
- console.error(error);
45
- }
46
- }
47
-
48
- // Run the test
49
- example().catch(console.error);
50
- ```
51
-
52
- ### Parameters
53
-
54
-
55
- | Name | Type | Description | Notes |
56
- |------------- | ------------- | ------------- | -------------|
57
- | **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
58
-
59
- ### Return type
60
-
61
- [**GenericResponse**](GenericResponse.md)
62
-
63
- ### Authorization
64
-
65
- No authorization required
66
-
67
- ### HTTP request headers
68
-
69
- - **Content-Type**: Not defined
70
- - **Accept**: `application/json`
71
-
72
-
73
- ### HTTP response details
74
- | Status code | Description | Response headers |
75
- |-------------|-------------|------------------|
76
- | **200** | Generic JSON success | - |
77
-
78
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
79
-
80
-
81
- ## getAllCustomer
82
-
83
- > CustomerLiteResourceArrayResponse getAllCustomer(searchAllCustomersRequest)
84
-
85
- Auto-generated: getAllCustomer
86
-
87
- ### Example
88
-
89
- ```ts
90
- import {
91
- Configuration,
92
- CustomersApi,
93
- } from '@digital8/lighting-illusions-ts-sdk';
94
- import type { GetAllCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
95
-
96
- async function example() {
97
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
98
- const api = new CustomersApi();
99
-
100
- const body = {
101
- // SearchAllCustomersRequest (optional)
102
- searchAllCustomersRequest: ...,
103
- } satisfies GetAllCustomerRequest;
104
-
105
- try {
106
- const data = await api.getAllCustomer(body);
107
- console.log(data);
108
- } catch (error) {
109
- console.error(error);
110
- }
111
- }
112
-
113
- // Run the test
114
- example().catch(console.error);
115
- ```
116
-
117
- ### Parameters
118
-
119
-
120
- | Name | Type | Description | Notes |
121
- |------------- | ------------- | ------------- | -------------|
122
- | **searchAllCustomersRequest** | [SearchAllCustomersRequest](SearchAllCustomersRequest.md) | | [Optional] |
123
-
124
- ### Return type
125
-
126
- [**CustomerLiteResourceArrayResponse**](CustomerLiteResourceArrayResponse.md)
127
-
128
- ### Authorization
129
-
130
- No authorization required
131
-
132
- ### HTTP request headers
133
-
134
- - **Content-Type**: `application/json`
135
- - **Accept**: `application/json`
136
-
137
-
138
- ### HTTP response details
139
- | Status code | Description | Response headers |
140
- |-------------|-------------|------------------|
141
- | **200** | Successful resource response | - |
142
-
143
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
144
-
145
-
146
13
  ## indexCustomer
147
14
 
148
15
  > PaginatedCustomerListResourceResponse indexCustomer(searchCustomersRequest)
@@ -337,71 +204,3 @@ No authorization required
337
204
 
338
205
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
339
206
 
340
-
341
- ## updateCustomer
342
-
343
- > CustomerResource updateCustomer(customer, updateCustomerRequest)
344
-
345
- Auto-generated: updateCustomer
346
-
347
- ### Example
348
-
349
- ```ts
350
- import {
351
- Configuration,
352
- CustomersApi,
353
- } from '@digital8/lighting-illusions-ts-sdk';
354
- import type { UpdateCustomerOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
355
-
356
- async function example() {
357
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
358
- const api = new CustomersApi();
359
-
360
- const body = {
361
- // number | The id of the customer
362
- customer: 56,
363
- // UpdateCustomerRequest (optional)
364
- updateCustomerRequest: ...,
365
- } satisfies UpdateCustomerOperationRequest;
366
-
367
- try {
368
- const data = await api.updateCustomer(body);
369
- console.log(data);
370
- } catch (error) {
371
- console.error(error);
372
- }
373
- }
374
-
375
- // Run the test
376
- example().catch(console.error);
377
- ```
378
-
379
- ### Parameters
380
-
381
-
382
- | Name | Type | Description | Notes |
383
- |------------- | ------------- | ------------- | -------------|
384
- | **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
385
- | **updateCustomerRequest** | [UpdateCustomerRequest](UpdateCustomerRequest.md) | | [Optional] |
386
-
387
- ### Return type
388
-
389
- [**CustomerResource**](CustomerResource.md)
390
-
391
- ### Authorization
392
-
393
- No authorization required
394
-
395
- ### HTTP request headers
396
-
397
- - **Content-Type**: `application/json`
398
- - **Accept**: `application/json`
399
-
400
-
401
- ### HTTP response details
402
- | Status code | Description | Response headers |
403
- |-------------|-------------|------------------|
404
- | **200** | Successful resource response | - |
405
-
406
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
407
-
@@ -1,24 +1,24 @@
1
1
 
2
- # PaginatedAdminListResourceResponse
2
+ # PaginatedCouponListResourceResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `data` | [Array<AdminListResource>](AdminListResource.md)
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 { PaginatedAdminListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
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 PaginatedAdminListResourceResponse
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 PaginatedAdminListResourceResponse
30
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedCouponListResourceResponse
31
31
  console.log(exampleParsed)
32
32
  ```
33
33
 
@@ -1,24 +1,24 @@
1
1
 
2
- # PaginatedAdminLiteResourceResponse
2
+ # PaginatedCouponLiteResourceResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `data` | [Array<AdminLiteResource>](AdminLiteResource.md)
9
+ `data` | [Array<CouponLiteResource>](CouponLiteResource.md)
10
10
  `meta` | [PagingMetadata](PagingMetadata.md)
11
11
 
12
12
  ## Example
13
13
 
14
14
  ```typescript
15
- import type { PaginatedAdminLiteResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+ import type { PaginatedCouponLiteResourceResponse } 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 PaginatedAdminLiteResourceResponse
21
+ } satisfies PaginatedCouponLiteResourceResponse
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 PaginatedAdminLiteResourceResponse
30
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedCouponLiteResourceResponse
31
31
  console.log(exampleParsed)
32
32
  ```
33
33
 
@@ -1,24 +1,24 @@
1
1
 
2
- # PaginatedRoleLiteResourceResponse
2
+ # PaginatedCouponResourceResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `data` | [Array<RoleLiteResource>](RoleLiteResource.md)
9
+ `data` | [Array<CouponResource>](CouponResource.md)
10
10
  `meta` | [PagingMetadata](PagingMetadata.md)
11
11
 
12
12
  ## Example
13
13
 
14
14
  ```typescript
15
- import type { PaginatedRoleLiteResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+ import type { PaginatedCouponResourceResponse } 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 PaginatedRoleLiteResourceResponse
21
+ } satisfies PaginatedCouponResourceResponse
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 PaginatedRoleLiteResourceResponse
30
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedCouponResourceResponse
31
31
  console.log(exampleParsed)
32
32
  ```
33
33
 
@@ -1,5 +1,5 @@
1
1
 
2
- # SearchAllCustomersRequest
2
+ # SearchAllCouponsRequest
3
3
 
4
4
 
5
5
  ## Properties
@@ -12,14 +12,14 @@ Name | Type
12
12
  `relatedId` | number
13
13
  `relatedType` | string
14
14
  `includesRelations` | boolean
15
- `siteId` | Array<string>
16
15
  `type` | Array<string>
17
- `signUpType` | Array<string>
16
+ `siteId` | Array<string>
17
+ `isAbandonedCart` | Array<string>
18
18
 
19
19
  ## Example
20
20
 
21
21
  ```typescript
22
- import type { SearchAllCustomersRequest } from '@digital8/lighting-illusions-ts-sdk'
22
+ import type { SearchAllCouponsRequest } from '@digital8/lighting-illusions-ts-sdk'
23
23
 
24
24
  // TODO: Update the object below with actual values
25
25
  const example = {
@@ -29,10 +29,10 @@ const example = {
29
29
  "relatedId": null,
30
30
  "relatedType": null,
31
31
  "includesRelations": null,
32
- "siteId": null,
33
32
  "type": null,
34
- "signUpType": null,
35
- } satisfies SearchAllCustomersRequest
33
+ "siteId": null,
34
+ "isAbandonedCart": null,
35
+ } satisfies SearchAllCouponsRequest
36
36
 
37
37
  console.log(example)
38
38
 
@@ -41,7 +41,7 @@ const exampleJSON: string = JSON.stringify(example)
41
41
  console.log(exampleJSON)
42
42
 
43
43
  // Parse the JSON string back to an object
44
- const exampleParsed = JSON.parse(exampleJSON) as SearchAllCustomersRequest
44
+ const exampleParsed = JSON.parse(exampleJSON) as SearchAllCouponsRequest
45
45
  console.log(exampleParsed)
46
46
  ```
47
47
 
@@ -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)
@@ -1,5 +1,5 @@
1
1
 
2
- # SearchAdminUsersRequest
2
+ # SearchCouponsRequest
3
3
 
4
4
 
5
5
  ## Properties
@@ -11,9 +11,13 @@ Name | Type
11
11
  `sortDirection` | string
12
12
  `perPage` | number
13
13
  `page` | number
14
- `roleId` | Array<string>
15
- `beforeCreatedAt` | Date
16
- `afterCreatedAt` | Date
14
+ `type` | Array<string>
15
+ `siteId` | Array<string>
16
+ `isAbandonedCart` | Array<string>
17
+ `beforeStartDate` | Date
18
+ `afterStartDate` | Date
19
+ `beforeEndDate` | Date
20
+ `afterEndDate` | Date
17
21
  `relatedId` | number
18
22
  `relatedType` | string
19
23
  `includesRelations` | boolean
@@ -21,7 +25,7 @@ Name | Type
21
25
  ## Example
22
26
 
23
27
  ```typescript
24
- import type { SearchAdminUsersRequest } from '@digital8/lighting-illusions-ts-sdk'
28
+ import type { SearchCouponsRequest } from '@digital8/lighting-illusions-ts-sdk'
25
29
 
26
30
  // TODO: Update the object below with actual values
27
31
  const example = {
@@ -30,13 +34,17 @@ const example = {
30
34
  "sortDirection": null,
31
35
  "perPage": null,
32
36
  "page": null,
33
- "roleId": null,
34
- "beforeCreatedAt": null,
35
- "afterCreatedAt": null,
37
+ "type": null,
38
+ "siteId": null,
39
+ "isAbandonedCart": null,
40
+ "beforeStartDate": null,
41
+ "afterStartDate": null,
42
+ "beforeEndDate": null,
43
+ "afterEndDate": null,
36
44
  "relatedId": null,
37
45
  "relatedType": null,
38
46
  "includesRelations": null,
39
- } satisfies SearchAdminUsersRequest
47
+ } satisfies SearchCouponsRequest
40
48
 
41
49
  console.log(example)
42
50
 
@@ -45,7 +53,7 @@ const exampleJSON: string = JSON.stringify(example)
45
53
  console.log(exampleJSON)
46
54
 
47
55
  // Parse the JSON string back to an object
48
- const exampleParsed = JSON.parse(exampleJSON) as SearchAdminUsersRequest
56
+ const exampleParsed = JSON.parse(exampleJSON) as SearchCouponsRequest
49
57
  console.log(exampleParsed)
50
58
  ```
51
59
 
@@ -12,10 +12,6 @@ Name | Type
12
12
  `perPage` | number
13
13
  `page` | number
14
14
  `siteId` | Array<string>
15
- `type` | Array<string>
16
- `signUpType` | Array<string>
17
- `beforeCreatedAt` | Date
18
- `afterCreatedAt` | Date
19
15
  `relatedId` | number
20
16
  `relatedType` | string
21
17
  `includesRelations` | boolean
@@ -33,10 +29,6 @@ const example = {
33
29
  "perPage": null,
34
30
  "page": null,
35
31
  "siteId": null,
36
- "type": null,
37
- "signUpType": null,
38
- "beforeCreatedAt": null,
39
- "afterCreatedAt": null,
40
32
  "relatedId": null,
41
33
  "relatedType": null,
42
34
  "includesRelations": null,
@@ -24,6 +24,7 @@ Name | Type
24
24
  `relatedId` | number
25
25
  `relatedType` | string
26
26
  `includesRelations` | boolean
27
+ `couponId` | number
27
28
 
28
29
  ## Example
29
30
 
@@ -50,6 +51,7 @@ const example = {
50
51
  "relatedId": null,
51
52
  "relatedType": null,
52
53
  "includesRelations": null,
54
+ "couponId": null,
53
55
  } satisfies SearchOrdersRequest
54
56
 
55
57
  console.log(example)
@@ -9,7 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `name` | string
11
11
  `hours` | string
12
- `date` | object
12
+ `date` | string
13
13
  `closed` | boolean
14
14
  `displayStartDate` | object
15
15
  `displayEndDate` | object
@@ -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
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/lighting-illusions-ts-sdk",
3
- "version": "0.0.2311",
3
+ "version": "0.0.2313",
4
4
  "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {