@digital8/lighting-illusions-ts-sdk 0.0.2354 → 0.0.2356

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 (250) hide show
  1. package/.openapi-generator/FILES +34 -68
  2. package/README.md +24 -44
  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/AddressResource.d.ts +1 -1
  10. package/dist/models/AddressResource.js +3 -1
  11. package/dist/models/AddressType.d.ts +0 -2
  12. package/dist/models/AddressType.js +1 -3
  13. package/dist/models/AdminOrderResource.d.ts +2 -3
  14. package/dist/models/AdminOrderResource.js +2 -3
  15. package/dist/models/AppliedCouponResource.d.ts +50 -0
  16. package/dist/models/{CartCouponResource.js → AppliedCouponResource.js} +13 -13
  17. package/dist/models/AppliedCouponResourceArrayResponse.d.ts +33 -0
  18. package/dist/models/AppliedCouponResourceArrayResponse.js +50 -0
  19. package/dist/models/CouponListResource.d.ts +99 -0
  20. package/dist/models/CouponListResource.js +90 -0
  21. package/dist/models/CouponListResourceArrayResponse.d.ts +33 -0
  22. package/dist/models/CouponListResourceArrayResponse.js +50 -0
  23. package/dist/models/CouponLiteResource.d.ts +44 -0
  24. package/dist/models/CouponLiteResource.js +57 -0
  25. package/dist/models/CouponLiteResourceArrayResponse.d.ts +33 -0
  26. package/dist/models/CouponLiteResourceArrayResponse.js +50 -0
  27. package/dist/models/CouponResource.d.ts +163 -0
  28. package/dist/models/CouponResource.js +134 -0
  29. package/dist/models/CouponResourceArrayResponse.d.ts +33 -0
  30. package/dist/models/CouponResourceArrayResponse.js +50 -0
  31. package/dist/models/CouponType.d.ts +26 -0
  32. package/dist/models/CouponType.js +52 -0
  33. package/dist/models/CreateCouponRequest.d.ts +134 -0
  34. package/dist/models/CreateCouponRequest.js +114 -0
  35. package/dist/models/CreateCouponRequestCouponablesInner.d.ts +48 -0
  36. package/dist/models/CreateCouponRequestCouponablesInner.js +61 -0
  37. package/dist/models/CreateCustomerRequest.d.ts +6 -18
  38. package/dist/models/CreateCustomerRequest.js +6 -12
  39. package/dist/models/CustomerListResource.d.ts +8 -21
  40. package/dist/models/CustomerListResource.js +13 -20
  41. package/dist/models/CustomerResource.d.ts +9 -34
  42. package/dist/models/CustomerResource.js +16 -27
  43. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  44. package/dist/models/ExternalApiLogResource.js +3 -1
  45. package/dist/models/FrontendOrderResource.d.ts +3 -3
  46. package/dist/models/FrontendOrderResource.js +3 -3
  47. package/dist/models/OrderFulfillmentResource.d.ts +1 -1
  48. package/dist/models/OrderFulfillmentResource.js +3 -1
  49. package/dist/models/PaginatedCouponListResourceResponse.d.ts +40 -0
  50. package/dist/models/PaginatedCouponListResourceResponse.js +57 -0
  51. package/dist/models/PaginatedCouponResourceResponse.d.ts +40 -0
  52. package/dist/models/PaginatedCouponResourceResponse.js +57 -0
  53. package/dist/models/SearchAllCouponsRequest.d.ts +101 -0
  54. package/dist/models/{SearchAllCustomersRequest.js → SearchAllCouponsRequest.js} +25 -27
  55. package/dist/models/SearchCartsRequest.d.ts +6 -0
  56. package/dist/models/SearchCartsRequest.js +2 -0
  57. package/dist/models/SearchCouponsRequest.d.ts +137 -0
  58. package/dist/models/SearchCouponsRequest.js +97 -0
  59. package/dist/models/SearchCustomersRequest.d.ts +3 -31
  60. package/dist/models/SearchCustomersRequest.js +3 -15
  61. package/dist/models/SearchOrdersRequest.d.ts +6 -0
  62. package/dist/models/SearchOrdersRequest.js +2 -0
  63. package/dist/models/StoreListResource.d.ts +1 -1
  64. package/dist/models/StoreListResource.js +3 -1
  65. package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
  66. package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
  67. package/dist/models/UpdateCouponRequest.d.ts +128 -0
  68. package/dist/models/UpdateCouponRequest.js +110 -0
  69. package/dist/models/index.d.ts +16 -33
  70. package/dist/models/index.js +16 -33
  71. package/docs/AdminOrderResource.md +1 -1
  72. package/docs/{CartCouponResource.md → AppliedCouponResource.md} +4 -4
  73. package/docs/{AdminLiteResourceArrayResponse.md → AppliedCouponResourceArrayResponse.md} +5 -5
  74. package/docs/{CustomerFrontendResource.md → CouponListResource.md} +22 -12
  75. package/docs/{CartCouponResourceArrayResponse.md → CouponListResourceArrayResponse.md} +5 -5
  76. package/docs/{RoleLiteResource.md → CouponLiteResource.md} +6 -4
  77. package/docs/{AdminListResourceArrayResponse.md → CouponLiteResourceArrayResponse.md} +5 -5
  78. package/docs/CouponResource.md +76 -0
  79. package/docs/{AdminResourceArrayResponse.md → CouponResourceArrayResponse.md} +5 -5
  80. package/docs/{SignUpType.md → CouponType.md} +4 -4
  81. package/docs/{AdminsApi.md → CouponsApi.md} +82 -82
  82. package/docs/CreateCouponRequest.md +62 -0
  83. package/docs/{AdminLiteResource.md → CreateCouponRequestCouponablesInner.md} +6 -6
  84. package/docs/CreateCustomerRequest.md +4 -8
  85. package/docs/CustomerListResource.md +8 -12
  86. package/docs/CustomerResource.md +9 -17
  87. package/docs/CustomersApi.md +0 -201
  88. package/docs/FrontendOrderResource.md +1 -1
  89. package/docs/{PaginatedAdminListResourceResponse.md → PaginatedCouponListResourceResponse.md} +5 -5
  90. package/docs/{PaginatedRoleLiteResourceResponse.md → PaginatedCouponResourceResponse.md} +5 -5
  91. package/docs/{SearchAllCustomersRequest.md → SearchAllCouponsRequest.md} +8 -8
  92. package/docs/SearchCartsRequest.md +2 -0
  93. package/docs/{SearchAdminUsersRequest.md → SearchCouponsRequest.md} +18 -10
  94. package/docs/SearchCustomersRequest.md +0 -8
  95. package/docs/SearchOrdersRequest.md +2 -0
  96. package/docs/StoreSpecialDateFrontendResource.md +1 -1
  97. package/docs/UpdateCouponRequest.md +60 -0
  98. package/package.json +1 -1
  99. package/src/apis/CouponsApi.ts +345 -0
  100. package/src/apis/CustomersApi.ts +0 -166
  101. package/src/apis/index.ts +1 -1
  102. package/src/models/AddressResource.ts +3 -2
  103. package/src/models/AddressType.ts +1 -3
  104. package/src/models/AdminOrderResource.ts +4 -11
  105. package/src/models/{CartCouponResource.ts → AppliedCouponResource.ts} +14 -14
  106. package/src/models/AppliedCouponResourceArrayResponse.ts +73 -0
  107. package/src/models/CouponListResource.ts +170 -0
  108. package/src/models/CouponListResourceArrayResponse.ts +73 -0
  109. package/src/models/CouponLiteResource.ts +83 -0
  110. package/src/models/CouponLiteResourceArrayResponse.ts +73 -0
  111. package/src/models/CouponResource.ts +288 -0
  112. package/src/models/CouponResourceArrayResponse.ts +73 -0
  113. package/src/models/CouponType.ts +54 -0
  114. package/src/models/CreateCouponRequest.ts +216 -0
  115. package/src/models/CreateCouponRequestCouponablesInner.ts +86 -0
  116. package/src/models/CreateCustomerRequest.ts +11 -28
  117. package/src/models/CustomerListResource.ts +20 -44
  118. package/src/models/CustomerResource.ts +28 -68
  119. package/src/models/ExternalApiLogResource.ts +3 -2
  120. package/src/models/FrontendOrderResource.ts +11 -11
  121. package/src/models/OrderFulfillmentResource.ts +3 -2
  122. package/src/models/PaginatedCouponListResourceResponse.ts +90 -0
  123. package/src/models/PaginatedCouponResourceResponse.ts +90 -0
  124. package/src/models/SearchAllCouponsRequest.ts +154 -0
  125. package/src/models/SearchCartsRequest.ts +8 -0
  126. package/src/models/SearchCouponsRequest.ts +202 -0
  127. package/src/models/SearchCustomersRequest.ts +3 -39
  128. package/src/models/SearchOrdersRequest.ts +8 -0
  129. package/src/models/StoreListResource.ts +3 -2
  130. package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
  131. package/src/models/UpdateCouponRequest.ts +207 -0
  132. package/src/models/index.ts +16 -33
  133. package/dist/apis/AdminsApi.d.ts +0 -116
  134. package/dist/models/AdminListResource.d.ts +0 -52
  135. package/dist/models/AdminListResource.js +0 -61
  136. package/dist/models/AdminListResourceArrayResponse.d.ts +0 -33
  137. package/dist/models/AdminListResourceArrayResponse.js +0 -50
  138. package/dist/models/AdminLiteResource.d.ts +0 -39
  139. package/dist/models/AdminLiteResource.js +0 -54
  140. package/dist/models/AdminLiteResourceArrayResponse.d.ts +0 -33
  141. package/dist/models/AdminLiteResourceArrayResponse.js +0 -50
  142. package/dist/models/AdminResource.d.ts +0 -58
  143. package/dist/models/AdminResource.js +0 -63
  144. package/dist/models/AdminResourceArrayResponse.d.ts +0 -33
  145. package/dist/models/AdminResourceArrayResponse.js +0 -50
  146. package/dist/models/CartCouponResource.d.ts +0 -50
  147. package/dist/models/CartCouponResourceArrayResponse.d.ts +0 -33
  148. package/dist/models/CartCouponResourceArrayResponse.js +0 -50
  149. package/dist/models/CheckEmailFrontendResource.d.ts +0 -38
  150. package/dist/models/CheckEmailFrontendResource.js +0 -53
  151. package/dist/models/CheckEmailFrontendResourceArrayResponse.d.ts +0 -33
  152. package/dist/models/CheckEmailFrontendResourceArrayResponse.js +0 -50
  153. package/dist/models/CreateAdminUserRequest.d.ts +0 -62
  154. package/dist/models/CreateAdminUserRequest.js +0 -69
  155. package/dist/models/CustomerAuthResponseResource.d.ts +0 -39
  156. package/dist/models/CustomerAuthResponseResource.js +0 -56
  157. package/dist/models/CustomerAuthResponseResourceArrayResponse.d.ts +0 -33
  158. package/dist/models/CustomerAuthResponseResourceArrayResponse.js +0 -50
  159. package/dist/models/CustomerFrontendResource.d.ts +0 -70
  160. package/dist/models/CustomerFrontendResource.js +0 -75
  161. package/dist/models/CustomerFrontendResourceArrayResponse.d.ts +0 -33
  162. package/dist/models/CustomerFrontendResourceArrayResponse.js +0 -50
  163. package/dist/models/CustomerSocialLinkableResource.d.ts +0 -38
  164. package/dist/models/CustomerSocialLinkableResource.js +0 -55
  165. package/dist/models/CustomerSocialLinkableResourceArrayResponse.d.ts +0 -33
  166. package/dist/models/CustomerSocialLinkableResourceArrayResponse.js +0 -50
  167. package/dist/models/CustomerType.d.ts +0 -25
  168. package/dist/models/CustomerType.js +0 -51
  169. package/dist/models/PaginatedAdminListResourceResponse.d.ts +0 -40
  170. package/dist/models/PaginatedAdminListResourceResponse.js +0 -57
  171. package/dist/models/PaginatedAdminLiteResourceResponse.d.ts +0 -40
  172. package/dist/models/PaginatedAdminLiteResourceResponse.js +0 -57
  173. package/dist/models/PaginatedRoleLiteResourceResponse.d.ts +0 -40
  174. package/dist/models/PaginatedRoleLiteResourceResponse.js +0 -57
  175. package/dist/models/RoleLiteResource.d.ts +0 -38
  176. package/dist/models/RoleLiteResource.js +0 -53
  177. package/dist/models/RoleLiteResourceArrayResponse.d.ts +0 -33
  178. package/dist/models/RoleLiteResourceArrayResponse.js +0 -50
  179. package/dist/models/SearchAdminUsersRequest.d.ts +0 -112
  180. package/dist/models/SearchAdminUsersRequest.js +0 -88
  181. package/dist/models/SearchAllAdminUsersRequest.d.ts +0 -82
  182. package/dist/models/SearchAllAdminUsersRequest.js +0 -78
  183. package/dist/models/SearchAllCustomersRequest.d.ts +0 -103
  184. package/dist/models/SignUpType.d.ts +0 -29
  185. package/dist/models/SignUpType.js +0 -55
  186. package/dist/models/SocialProvider.d.ts +0 -26
  187. package/dist/models/SocialProvider.js +0 -52
  188. package/dist/models/UpdateAdminUserRequest.d.ts +0 -62
  189. package/dist/models/UpdateAdminUserRequest.js +0 -67
  190. package/dist/models/UpdateCustomerRequest.d.ts +0 -62
  191. package/dist/models/UpdateCustomerRequest.js +0 -65
  192. package/dist/models/UserLiteResource.d.ts +0 -62
  193. package/dist/models/UserLiteResource.js +0 -69
  194. package/dist/models/UserLiteResourceArrayResponse.d.ts +0 -33
  195. package/dist/models/UserLiteResourceArrayResponse.js +0 -50
  196. package/dist/models/UserType.d.ts +0 -25
  197. package/dist/models/UserType.js +0 -51
  198. package/docs/AdminListResource.md +0 -40
  199. package/docs/AdminResource.md +0 -42
  200. package/docs/CheckEmailFrontendResource.md +0 -36
  201. package/docs/CheckEmailFrontendResourceArrayResponse.md +0 -34
  202. package/docs/CreateAdminUserRequest.md +0 -44
  203. package/docs/CustomerAuthResponseResource.md +0 -36
  204. package/docs/CustomerAuthResponseResourceArrayResponse.md +0 -34
  205. package/docs/CustomerFrontendResourceArrayResponse.md +0 -34
  206. package/docs/CustomerSocialLinkableResource.md +0 -36
  207. package/docs/CustomerSocialLinkableResourceArrayResponse.md +0 -34
  208. package/docs/CustomerType.md +0 -32
  209. package/docs/PaginatedAdminLiteResourceResponse.md +0 -36
  210. package/docs/RoleLiteResourceArrayResponse.md +0 -34
  211. package/docs/SearchAllAdminUsersRequest.md +0 -44
  212. package/docs/SocialProvider.md +0 -32
  213. package/docs/UpdateAdminUserRequest.md +0 -44
  214. package/docs/UpdateCustomerRequest.md +0 -44
  215. package/docs/UserLiteResource.md +0 -44
  216. package/docs/UserLiteResourceArrayResponse.md +0 -34
  217. package/docs/UserType.md +0 -32
  218. package/src/apis/AdminsApi.ts +0 -345
  219. package/src/models/AdminListResource.ts +0 -106
  220. package/src/models/AdminListResourceArrayResponse.ts +0 -73
  221. package/src/models/AdminLiteResource.ts +0 -82
  222. package/src/models/AdminLiteResourceArrayResponse.ts +0 -73
  223. package/src/models/AdminResource.ts +0 -114
  224. package/src/models/AdminResourceArrayResponse.ts +0 -73
  225. package/src/models/CartCouponResourceArrayResponse.ts +0 -73
  226. package/src/models/CheckEmailFrontendResource.ts +0 -74
  227. package/src/models/CheckEmailFrontendResourceArrayResponse.ts +0 -73
  228. package/src/models/CreateAdminUserRequest.ts +0 -110
  229. package/src/models/CustomerAuthResponseResource.ts +0 -83
  230. package/src/models/CustomerAuthResponseResourceArrayResponse.ts +0 -73
  231. package/src/models/CustomerFrontendResource.ts +0 -134
  232. package/src/models/CustomerFrontendResourceArrayResponse.ts +0 -73
  233. package/src/models/CustomerSocialLinkableResource.ts +0 -75
  234. package/src/models/CustomerSocialLinkableResourceArrayResponse.ts +0 -73
  235. package/src/models/CustomerType.ts +0 -53
  236. package/src/models/PaginatedAdminListResourceResponse.ts +0 -90
  237. package/src/models/PaginatedAdminLiteResourceResponse.ts +0 -90
  238. package/src/models/PaginatedRoleLiteResourceResponse.ts +0 -90
  239. package/src/models/RoleLiteResource.ts +0 -74
  240. package/src/models/RoleLiteResourceArrayResponse.ts +0 -73
  241. package/src/models/SearchAdminUsersRequest.ts +0 -169
  242. package/src/models/SearchAllAdminUsersRequest.ts +0 -129
  243. package/src/models/SearchAllCustomersRequest.ts +0 -156
  244. package/src/models/SignUpType.ts +0 -57
  245. package/src/models/SocialProvider.ts +0 -54
  246. package/src/models/UpdateAdminUserRequest.ts +0 -109
  247. package/src/models/UpdateCustomerRequest.ts +0 -108
  248. package/src/models/UserLiteResource.ts +0 -110
  249. package/src/models/UserLiteResourceArrayResponse.ts +0 -73
  250. package/src/models/UserType.ts +0 -53
@@ -1,34 +0,0 @@
1
-
2
- # CheckEmailFrontendResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<CheckEmailFrontendResource>](CheckEmailFrontendResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { CheckEmailFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies CheckEmailFrontendResourceArrayResponse
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 CheckEmailFrontendResourceArrayResponse
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
-
@@ -1,44 +0,0 @@
1
-
2
- # CreateAdminUserRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `firstName` | string
10
- `lastName` | string
11
- `phone` | string
12
- `password` | string
13
- `email` | string
14
- `roleIds` | Array<number>
15
-
16
- ## Example
17
-
18
- ```typescript
19
- import type { CreateAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "firstName": null,
24
- "lastName": null,
25
- "phone": null,
26
- "password": null,
27
- "email": null,
28
- "roleIds": null,
29
- } satisfies CreateAdminUserRequest
30
-
31
- console.log(example)
32
-
33
- // Convert the instance to a JSON string
34
- const exampleJSON: string = JSON.stringify(example)
35
- console.log(exampleJSON)
36
-
37
- // Parse the JSON string back to an object
38
- const exampleParsed = JSON.parse(exampleJSON) as CreateAdminUserRequest
39
- console.log(exampleParsed)
40
- ```
41
-
42
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
-
44
-
@@ -1,36 +0,0 @@
1
-
2
- # CustomerAuthResponseResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `token` | string
10
- `customer` | [CustomerFrontendResource](CustomerFrontendResource.md)
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import type { CustomerAuthResponseResource } from '@digital8/lighting-illusions-ts-sdk'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "token": null,
20
- "customer": null,
21
- } satisfies CustomerAuthResponseResource
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 CustomerAuthResponseResource
31
- console.log(exampleParsed)
32
- ```
33
-
34
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
-
36
-
@@ -1,34 +0,0 @@
1
-
2
- # CustomerAuthResponseResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<CustomerAuthResponseResource>](CustomerAuthResponseResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { CustomerAuthResponseResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies CustomerAuthResponseResourceArrayResponse
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 CustomerAuthResponseResourceArrayResponse
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
-
@@ -1,34 +0,0 @@
1
-
2
- # CustomerFrontendResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<CustomerFrontendResource>](CustomerFrontendResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { CustomerFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies CustomerFrontendResourceArrayResponse
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 CustomerFrontendResourceArrayResponse
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
-
@@ -1,36 +0,0 @@
1
-
2
- # CustomerSocialLinkableResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `linkable` | boolean
10
- `customer` | object
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import type { CustomerSocialLinkableResource } from '@digital8/lighting-illusions-ts-sdk'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "linkable": null,
20
- "customer": null,
21
- } satisfies CustomerSocialLinkableResource
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 CustomerSocialLinkableResource
31
- console.log(exampleParsed)
32
- ```
33
-
34
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
-
36
-
@@ -1,34 +0,0 @@
1
-
2
- # CustomerSocialLinkableResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<CustomerSocialLinkableResource>](CustomerSocialLinkableResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { CustomerSocialLinkableResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies CustomerSocialLinkableResourceArrayResponse
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 CustomerSocialLinkableResourceArrayResponse
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
-
@@ -1,32 +0,0 @@
1
-
2
- # CustomerType
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import type { CustomerType } from '@digital8/lighting-illusions-ts-sdk'
14
-
15
- // TODO: Update the object below with actual values
16
- const example = {
17
- } satisfies CustomerType
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 CustomerType
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
-
@@ -1,36 +0,0 @@
1
-
2
- # PaginatedAdminLiteResourceResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<AdminLiteResource>](AdminLiteResource.md)
10
- `meta` | [PagingMetadata](PagingMetadata.md)
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import type { PaginatedAdminLiteResourceResponse } 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 PaginatedAdminLiteResourceResponse
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 PaginatedAdminLiteResourceResponse
31
- console.log(exampleParsed)
32
- ```
33
-
34
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
-
36
-
@@ -1,34 +0,0 @@
1
-
2
- # RoleLiteResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<RoleLiteResource>](RoleLiteResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { RoleLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies RoleLiteResourceArrayResponse
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 RoleLiteResourceArrayResponse
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
-
@@ -1,44 +0,0 @@
1
-
2
- # SearchAllAdminUsersRequest
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
-
16
- ## Example
17
-
18
- ```typescript
19
- import type { SearchAllAdminUsersRequest } from '@digital8/lighting-illusions-ts-sdk'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "search": null,
24
- "sortBy": null,
25
- "sortDirection": null,
26
- "relatedId": null,
27
- "relatedType": null,
28
- "includesRelations": null,
29
- } satisfies SearchAllAdminUsersRequest
30
-
31
- console.log(example)
32
-
33
- // Convert the instance to a JSON string
34
- const exampleJSON: string = JSON.stringify(example)
35
- console.log(exampleJSON)
36
-
37
- // Parse the JSON string back to an object
38
- const exampleParsed = JSON.parse(exampleJSON) as SearchAllAdminUsersRequest
39
- console.log(exampleParsed)
40
- ```
41
-
42
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
-
44
-
@@ -1,32 +0,0 @@
1
-
2
- # SocialProvider
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import type { SocialProvider } from '@digital8/lighting-illusions-ts-sdk'
14
-
15
- // TODO: Update the object below with actual values
16
- const example = {
17
- } satisfies SocialProvider
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 SocialProvider
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
-
@@ -1,44 +0,0 @@
1
-
2
- # UpdateAdminUserRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `firstName` | string
10
- `lastName` | string
11
- `phone` | string
12
- `password` | string
13
- `email` | string
14
- `roleIds` | Array<number>
15
-
16
- ## Example
17
-
18
- ```typescript
19
- import type { UpdateAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "firstName": null,
24
- "lastName": null,
25
- "phone": null,
26
- "password": null,
27
- "email": null,
28
- "roleIds": null,
29
- } satisfies UpdateAdminUserRequest
30
-
31
- console.log(example)
32
-
33
- // Convert the instance to a JSON string
34
- const exampleJSON: string = JSON.stringify(example)
35
- console.log(exampleJSON)
36
-
37
- // Parse the JSON string back to an object
38
- const exampleParsed = JSON.parse(exampleJSON) as UpdateAdminUserRequest
39
- console.log(exampleParsed)
40
- ```
41
-
42
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
-
44
-
@@ -1,44 +0,0 @@
1
-
2
- # UpdateCustomerRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `firstName` | string
10
- `lastName` | string
11
- `phone` | string
12
- `password` | string
13
- `email` | string
14
- `subscribedToNewsletter` | boolean
15
-
16
- ## Example
17
-
18
- ```typescript
19
- import type { UpdateCustomerRequest } from '@digital8/lighting-illusions-ts-sdk'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "firstName": null,
24
- "lastName": null,
25
- "phone": null,
26
- "password": null,
27
- "email": null,
28
- "subscribedToNewsletter": null,
29
- } satisfies UpdateCustomerRequest
30
-
31
- console.log(example)
32
-
33
- // Convert the instance to a JSON string
34
- const exampleJSON: string = JSON.stringify(example)
35
- console.log(exampleJSON)
36
-
37
- // Parse the JSON string back to an object
38
- const exampleParsed = JSON.parse(exampleJSON) as UpdateCustomerRequest
39
- console.log(exampleParsed)
40
- ```
41
-
42
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
-
44
-
@@ -1,44 +0,0 @@
1
-
2
- # UserLiteResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | number
10
- `firstName` | string
11
- `lastName` | string
12
- `email` | string
13
- `phone` | string
14
- `fullName` | string
15
-
16
- ## Example
17
-
18
- ```typescript
19
- import type { UserLiteResource } from '@digital8/lighting-illusions-ts-sdk'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "id": null,
24
- "firstName": null,
25
- "lastName": null,
26
- "email": null,
27
- "phone": null,
28
- "fullName": null,
29
- } satisfies UserLiteResource
30
-
31
- console.log(example)
32
-
33
- // Convert the instance to a JSON string
34
- const exampleJSON: string = JSON.stringify(example)
35
- console.log(exampleJSON)
36
-
37
- // Parse the JSON string back to an object
38
- const exampleParsed = JSON.parse(exampleJSON) as UserLiteResource
39
- console.log(exampleParsed)
40
- ```
41
-
42
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
-
44
-
@@ -1,34 +0,0 @@
1
-
2
- # UserLiteResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<UserLiteResource>](UserLiteResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { UserLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies UserLiteResourceArrayResponse
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 UserLiteResourceArrayResponse
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
-
package/docs/UserType.md DELETED
@@ -1,32 +0,0 @@
1
-
2
- # UserType
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import type { UserType } from '@digital8/lighting-illusions-ts-sdk'
14
-
15
- // TODO: Update the object below with actual values
16
- const example = {
17
- } satisfies UserType
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 UserType
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
-