@digital8/lighting-illusions-ts-sdk 0.0.1528 → 0.0.1529

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 (197) hide show
  1. package/.openapi-generator/FILES +40 -56
  2. package/README.md +25 -41
  3. package/dist/apis/ProductRegistrationApi.d.ts +79 -0
  4. package/dist/apis/{MenuApi.js → ProductRegistrationApi.js} +57 -174
  5. package/dist/apis/index.d.ts +1 -2
  6. package/dist/apis/index.js +1 -2
  7. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  8. package/dist/models/ExternalApiLogResource.js +3 -1
  9. package/dist/models/GetAllProductRegistrationRequest.d.ts +88 -0
  10. package/dist/models/{GetAllMenuRequest.js → GetAllProductRegistrationRequest.js} +21 -22
  11. package/dist/models/IndexProductChildRequest.d.ts +1 -0
  12. package/dist/models/IndexProductChildRequest.js +1 -0
  13. package/dist/models/IndexProductRegistrationRequest.d.ts +131 -0
  14. package/dist/models/IndexProductRegistrationRequest.js +98 -0
  15. package/dist/models/ListAssetsProductRegistrationRequest.d.ts +103 -0
  16. package/dist/models/{IndexMenuRequest.js → ListAssetsProductRegistrationRequest.js} +22 -24
  17. package/dist/models/PaginatedProductRegistrationAssetResourceResponse.d.ts +40 -0
  18. package/dist/models/PaginatedProductRegistrationAssetResourceResponse.js +57 -0
  19. package/dist/models/PaginatedProductRegistrationListResourceResponse.d.ts +40 -0
  20. package/dist/models/PaginatedProductRegistrationListResourceResponse.js +57 -0
  21. package/dist/models/PaginatedProductRegistrationResourceResponse.d.ts +40 -0
  22. package/dist/models/PaginatedProductRegistrationResourceResponse.js +57 -0
  23. package/dist/models/ProductRegistrationAssetResource.d.ts +45 -0
  24. package/dist/models/ProductRegistrationAssetResource.js +58 -0
  25. package/dist/models/ProductRegistrationAssetResourceArrayResponse.d.ts +33 -0
  26. package/dist/models/ProductRegistrationAssetResourceArrayResponse.js +50 -0
  27. package/dist/models/ProductRegistrationAssetType.d.ts +25 -0
  28. package/dist/models/ProductRegistrationAssetType.js +51 -0
  29. package/dist/models/ProductRegistrationCustomerResource.d.ts +62 -0
  30. package/dist/models/ProductRegistrationCustomerResource.js +65 -0
  31. package/dist/models/ProductRegistrationCustomerResourceArrayResponse.d.ts +33 -0
  32. package/dist/models/ProductRegistrationCustomerResourceArrayResponse.js +50 -0
  33. package/dist/models/ProductRegistrationListResource.d.ts +57 -0
  34. package/dist/models/ProductRegistrationListResource.js +64 -0
  35. package/dist/models/ProductRegistrationListResourceArrayResponse.d.ts +33 -0
  36. package/dist/models/ProductRegistrationListResourceArrayResponse.js +50 -0
  37. package/dist/models/ProductRegistrationLiteResource.d.ts +38 -0
  38. package/dist/models/ProductRegistrationLiteResource.js +53 -0
  39. package/dist/models/ProductRegistrationLiteResourceArrayResponse.d.ts +33 -0
  40. package/dist/models/ProductRegistrationLiteResourceArrayResponse.js +50 -0
  41. package/dist/models/ProductRegistrationProductChildResource.d.ts +50 -0
  42. package/dist/models/ProductRegistrationProductChildResource.js +63 -0
  43. package/dist/models/ProductRegistrationProductChildResourceArrayResponse.d.ts +33 -0
  44. package/dist/models/ProductRegistrationProductChildResourceArrayResponse.js +50 -0
  45. package/dist/models/ProductRegistrationResource.d.ts +90 -0
  46. package/dist/models/ProductRegistrationResource.js +81 -0
  47. package/dist/models/ProductRegistrationResourceArrayResponse.d.ts +33 -0
  48. package/dist/models/ProductRegistrationResourceArrayResponse.js +50 -0
  49. package/dist/models/StoreAssetForAssetableRequest.d.ts +0 -2
  50. package/dist/models/StoreAssetForAssetableRequest.js +1 -3
  51. package/dist/models/StoreSpecialDateResource.d.ts +2 -2
  52. package/dist/models/StoreSpecialDateResource.js +1 -3
  53. package/dist/models/index.d.ts +19 -26
  54. package/dist/models/index.js +19 -26
  55. package/docs/{GetAllMenuRequest.md → GetAllProductRegistrationRequest.md} +4 -6
  56. package/docs/{GetAllMenuItemRequest.md → IndexProductRegistrationRequest.md} +18 -8
  57. package/docs/{IndexMenuRequest.md → ListAssetsProductRegistrationRequest.md} +8 -8
  58. package/docs/PaginatedProductRegistrationAssetResourceResponse.md +36 -0
  59. package/docs/PaginatedProductRegistrationListResourceResponse.md +36 -0
  60. package/docs/{PaginatedMenuListResourceResponse.md → PaginatedProductRegistrationResourceResponse.md} +5 -5
  61. package/docs/ProductRegistrationApi.md +275 -0
  62. package/docs/{MenuItemLiteResource.md → ProductRegistrationAssetResource.md} +6 -12
  63. package/docs/{MenuItemHierarchyResourceArrayResponse.md → ProductRegistrationAssetResourceArrayResponse.md} +5 -5
  64. package/docs/{MenuItemType.md → ProductRegistrationAssetType.md} +4 -4
  65. package/docs/{MenuItemLinkResource.md → ProductRegistrationCustomerResource.md} +12 -14
  66. package/docs/ProductRegistrationCustomerResourceArrayResponse.md +34 -0
  67. package/docs/{MenuListResource.md → ProductRegistrationListResource.md} +12 -14
  68. package/docs/{MenuItemLinkResourceArrayResponse.md → ProductRegistrationListResourceArrayResponse.md} +5 -5
  69. package/docs/{UpdateMenuRequestMenuItemOrderInner.md → ProductRegistrationLiteResource.md} +6 -8
  70. package/docs/{MenuItemResourceArrayResponse.md → ProductRegistrationLiteResourceArrayResponse.md} +5 -5
  71. package/docs/{MenuResource.md → ProductRegistrationProductChildResource.md} +8 -12
  72. package/docs/ProductRegistrationProductChildResourceArrayResponse.md +34 -0
  73. package/docs/ProductRegistrationResource.md +52 -0
  74. package/docs/{MenuItemLiteResourceArrayResponse.md → ProductRegistrationResourceArrayResponse.md} +5 -5
  75. package/docs/StoreSpecialDateResource.md +1 -1
  76. package/package.json +1 -1
  77. package/src/apis/ProductRegistrationApi.ts +238 -0
  78. package/src/apis/index.ts +1 -2
  79. package/src/models/ExternalApiLogResource.ts +3 -2
  80. package/src/models/GetAllProductRegistrationRequest.ts +137 -0
  81. package/src/models/IndexProductChildRequest.ts +1 -0
  82. package/src/models/IndexProductRegistrationRequest.ts +193 -0
  83. package/src/models/ListAssetsProductRegistrationRequest.ts +158 -0
  84. package/src/models/PaginatedProductRegistrationAssetResourceResponse.ts +90 -0
  85. package/src/models/PaginatedProductRegistrationListResourceResponse.ts +90 -0
  86. package/src/models/PaginatedProductRegistrationResourceResponse.ts +90 -0
  87. package/src/models/ProductRegistrationAssetResource.ts +91 -0
  88. package/src/models/ProductRegistrationAssetResourceArrayResponse.ts +73 -0
  89. package/src/models/ProductRegistrationAssetType.ts +53 -0
  90. package/src/models/ProductRegistrationCustomerResource.ts +108 -0
  91. package/src/models/ProductRegistrationCustomerResourceArrayResponse.ts +73 -0
  92. package/src/models/ProductRegistrationListResource.ts +108 -0
  93. package/src/models/ProductRegistrationListResourceArrayResponse.ts +73 -0
  94. package/src/models/ProductRegistrationLiteResource.ts +74 -0
  95. package/src/models/ProductRegistrationLiteResourceArrayResponse.ts +73 -0
  96. package/src/models/ProductRegistrationProductChildResource.ts +93 -0
  97. package/src/models/ProductRegistrationProductChildResourceArrayResponse.ts +73 -0
  98. package/src/models/ProductRegistrationResource.ts +171 -0
  99. package/src/models/ProductRegistrationResourceArrayResponse.ts +73 -0
  100. package/src/models/StoreAssetForAssetableRequest.ts +1 -3
  101. package/src/models/StoreSpecialDateResource.ts +3 -4
  102. package/src/models/index.ts +19 -26
  103. package/dist/apis/MenuApi.d.ts +0 -109
  104. package/dist/apis/MenuItemsApi.d.ts +0 -124
  105. package/dist/apis/MenuItemsApi.js +0 -491
  106. package/dist/models/GetAllMenuItemRequest.d.ts +0 -93
  107. package/dist/models/GetAllMenuItemRequest.js +0 -81
  108. package/dist/models/GetAllMenuRequest.d.ts +0 -93
  109. package/dist/models/GetHierarchyMenuItemRequest.d.ts +0 -32
  110. package/dist/models/GetHierarchyMenuItemRequest.js +0 -51
  111. package/dist/models/IndexMenuRequest.d.ts +0 -105
  112. package/dist/models/MenuItemHierarchyResource.d.ts +0 -81
  113. package/dist/models/MenuItemHierarchyResource.js +0 -80
  114. package/dist/models/MenuItemHierarchyResourceArrayResponse.d.ts +0 -33
  115. package/dist/models/MenuItemHierarchyResourceArrayResponse.js +0 -50
  116. package/dist/models/MenuItemLinkResource.d.ts +0 -68
  117. package/dist/models/MenuItemLinkResource.js +0 -67
  118. package/dist/models/MenuItemLinkResourceArrayResponse.d.ts +0 -33
  119. package/dist/models/MenuItemLinkResourceArrayResponse.js +0 -50
  120. package/dist/models/MenuItemLiteResource.d.ts +0 -62
  121. package/dist/models/MenuItemLiteResource.js +0 -67
  122. package/dist/models/MenuItemLiteResourceArrayResponse.d.ts +0 -33
  123. package/dist/models/MenuItemLiteResourceArrayResponse.js +0 -50
  124. package/dist/models/MenuItemResource.d.ts +0 -106
  125. package/dist/models/MenuItemResource.js +0 -91
  126. package/dist/models/MenuItemResourceArrayResponse.d.ts +0 -33
  127. package/dist/models/MenuItemResourceArrayResponse.js +0 -50
  128. package/dist/models/MenuItemType.d.ts +0 -27
  129. package/dist/models/MenuItemType.js +0 -53
  130. package/dist/models/MenuListResource.d.ts +0 -64
  131. package/dist/models/MenuListResource.js +0 -73
  132. package/dist/models/MenuListResourceArrayResponse.d.ts +0 -33
  133. package/dist/models/MenuListResourceArrayResponse.js +0 -50
  134. package/dist/models/MenuPosition.d.ts +0 -27
  135. package/dist/models/MenuPosition.js +0 -53
  136. package/dist/models/MenuResource.d.ts +0 -63
  137. package/dist/models/MenuResource.js +0 -70
  138. package/dist/models/MenuResourceArrayResponse.d.ts +0 -33
  139. package/dist/models/MenuResourceArrayResponse.js +0 -50
  140. package/dist/models/PaginatedMenuListResourceResponse.d.ts +0 -40
  141. package/dist/models/PaginatedMenuListResourceResponse.js +0 -57
  142. package/dist/models/SearchLinkablesMenuItemRequest.d.ts +0 -54
  143. package/dist/models/SearchLinkablesMenuItemRequest.js +0 -65
  144. package/dist/models/StoreMenuItemRequest.d.ts +0 -97
  145. package/dist/models/StoreMenuItemRequest.js +0 -84
  146. package/dist/models/StoreMenuItemRequestMenuItemLink.d.ts +0 -60
  147. package/dist/models/StoreMenuItemRequestMenuItemLink.js +0 -65
  148. package/dist/models/StoreMenuRequest.d.ts +0 -54
  149. package/dist/models/StoreMenuRequest.js +0 -69
  150. package/dist/models/UpdateMenuItemRequest.d.ts +0 -97
  151. package/dist/models/UpdateMenuItemRequest.js +0 -78
  152. package/dist/models/UpdateMenuRequest.d.ts +0 -61
  153. package/dist/models/UpdateMenuRequest.js +0 -66
  154. package/dist/models/UpdateMenuRequestMenuItemOrderInner.d.ts +0 -44
  155. package/dist/models/UpdateMenuRequestMenuItemOrderInner.js +0 -53
  156. package/docs/GetHierarchyMenuItemRequest.md +0 -34
  157. package/docs/MenuApi.md +0 -407
  158. package/docs/MenuItemHierarchyResource.md +0 -50
  159. package/docs/MenuItemResource.md +0 -58
  160. package/docs/MenuItemsApi.md +0 -473
  161. package/docs/MenuListResourceArrayResponse.md +0 -34
  162. package/docs/MenuPosition.md +0 -32
  163. package/docs/MenuResourceArrayResponse.md +0 -34
  164. package/docs/SearchLinkablesMenuItemRequest.md +0 -38
  165. package/docs/StoreMenuItemRequest.md +0 -52
  166. package/docs/StoreMenuItemRequestMenuItemLink.md +0 -40
  167. package/docs/StoreMenuRequest.md +0 -38
  168. package/docs/UpdateMenuItemRequest.md +0 -52
  169. package/docs/UpdateMenuRequest.md +0 -40
  170. package/src/apis/MenuApi.ts +0 -334
  171. package/src/apis/MenuItemsApi.ts +0 -381
  172. package/src/models/GetAllMenuItemRequest.ts +0 -144
  173. package/src/models/GetAllMenuRequest.ts +0 -144
  174. package/src/models/GetHierarchyMenuItemRequest.ts +0 -66
  175. package/src/models/IndexMenuRequest.ts +0 -160
  176. package/src/models/MenuItemHierarchyResource.ts +0 -144
  177. package/src/models/MenuItemHierarchyResourceArrayResponse.ts +0 -73
  178. package/src/models/MenuItemLinkResource.ts +0 -116
  179. package/src/models/MenuItemLinkResourceArrayResponse.ts +0 -73
  180. package/src/models/MenuItemLiteResource.ts +0 -109
  181. package/src/models/MenuItemLiteResourceArrayResponse.ts +0 -73
  182. package/src/models/MenuItemResource.ts +0 -184
  183. package/src/models/MenuItemResourceArrayResponse.ts +0 -73
  184. package/src/models/MenuItemType.ts +0 -55
  185. package/src/models/MenuListResource.ts +0 -126
  186. package/src/models/MenuListResourceArrayResponse.ts +0 -73
  187. package/src/models/MenuPosition.ts +0 -55
  188. package/src/models/MenuResource.ts +0 -118
  189. package/src/models/MenuResourceArrayResponse.ts +0 -73
  190. package/src/models/PaginatedMenuListResourceResponse.ts +0 -90
  191. package/src/models/SearchLinkablesMenuItemRequest.ts +0 -95
  192. package/src/models/StoreMenuItemRequest.ts +0 -161
  193. package/src/models/StoreMenuItemRequestMenuItemLink.ts +0 -102
  194. package/src/models/StoreMenuRequest.ts +0 -97
  195. package/src/models/UpdateMenuItemRequest.ts +0 -158
  196. package/src/models/UpdateMenuRequest.ts +0 -110
  197. package/src/models/UpdateMenuRequestMenuItemOrderInner.ts +0 -81
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedProductRegistrationListResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRegistrationListResource>](ProductRegistrationListResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRegistrationListResourceResponse } 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 PaginatedProductRegistrationListResourceResponse
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 PaginatedProductRegistrationListResourceResponse
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,24 +1,24 @@
1
1
 
2
- # PaginatedMenuListResourceResponse
2
+ # PaginatedProductRegistrationResourceResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `data` | [Array<MenuListResource>](MenuListResource.md)
9
+ `data` | [Array<ProductRegistrationResource>](ProductRegistrationResource.md)
10
10
  `meta` | [PagingMetadata](PagingMetadata.md)
11
11
 
12
12
  ## Example
13
13
 
14
14
  ```typescript
15
- import type { PaginatedMenuListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+ import type { PaginatedProductRegistrationResourceResponse } 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 PaginatedMenuListResourceResponse
21
+ } satisfies PaginatedProductRegistrationResourceResponse
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 PaginatedMenuListResourceResponse
30
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedProductRegistrationResourceResponse
31
31
  console.log(exampleParsed)
32
32
  ```
33
33
 
@@ -0,0 +1,275 @@
1
+ # ProductRegistrationApi
2
+
3
+ All URIs are relative to *http://localhost/api*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**getAllProductRegistration**](ProductRegistrationApi.md#getallproductregistrationoperation) | **POST** /admin-api/product-registration/all | Auto-generated: getAllProductRegistration |
8
+ | [**indexProductRegistration**](ProductRegistrationApi.md#indexproductregistrationoperation) | **POST** /admin-api/product-registration/list | Auto-generated: indexProductRegistration |
9
+ | [**listAssetsProductRegistration**](ProductRegistrationApi.md#listassetsproductregistrationoperation) | **POST** /admin-api/product-registration/{productRegistration}/assets | Auto-generated: listAssetsProductRegistration |
10
+ | [**showProductRegistration**](ProductRegistrationApi.md#showproductregistration) | **GET** /admin-api/product-registration/{productRegistration} | Auto-generated: showProductRegistration |
11
+
12
+
13
+
14
+ ## getAllProductRegistration
15
+
16
+ > ProductRegistrationLiteResourceArrayResponse getAllProductRegistration(getAllProductRegistrationRequest)
17
+
18
+ Auto-generated: getAllProductRegistration
19
+
20
+ ### Example
21
+
22
+ ```ts
23
+ import {
24
+ Configuration,
25
+ ProductRegistrationApi,
26
+ } from '@digital8/lighting-illusions-ts-sdk';
27
+ import type { GetAllProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
28
+
29
+ async function example() {
30
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
31
+ const api = new ProductRegistrationApi();
32
+
33
+ const body = {
34
+ // GetAllProductRegistrationRequest (optional)
35
+ getAllProductRegistrationRequest: ...,
36
+ } satisfies GetAllProductRegistrationOperationRequest;
37
+
38
+ try {
39
+ const data = await api.getAllProductRegistration(body);
40
+ console.log(data);
41
+ } catch (error) {
42
+ console.error(error);
43
+ }
44
+ }
45
+
46
+ // Run the test
47
+ example().catch(console.error);
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+
53
+ | Name | Type | Description | Notes |
54
+ |------------- | ------------- | ------------- | -------------|
55
+ | **getAllProductRegistrationRequest** | [GetAllProductRegistrationRequest](GetAllProductRegistrationRequest.md) | | [Optional] |
56
+
57
+ ### Return type
58
+
59
+ [**ProductRegistrationLiteResourceArrayResponse**](ProductRegistrationLiteResourceArrayResponse.md)
60
+
61
+ ### Authorization
62
+
63
+ No authorization required
64
+
65
+ ### HTTP request headers
66
+
67
+ - **Content-Type**: `application/json`
68
+ - **Accept**: `application/json`
69
+
70
+
71
+ ### HTTP response details
72
+ | Status code | Description | Response headers |
73
+ |-------------|-------------|------------------|
74
+ | **200** | Successful resource response | - |
75
+
76
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
77
+
78
+
79
+ ## indexProductRegistration
80
+
81
+ > PaginatedProductRegistrationListResourceResponse indexProductRegistration(indexProductRegistrationRequest)
82
+
83
+ Auto-generated: indexProductRegistration
84
+
85
+ ### Example
86
+
87
+ ```ts
88
+ import {
89
+ Configuration,
90
+ ProductRegistrationApi,
91
+ } from '@digital8/lighting-illusions-ts-sdk';
92
+ import type { IndexProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
93
+
94
+ async function example() {
95
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
96
+ const api = new ProductRegistrationApi();
97
+
98
+ const body = {
99
+ // IndexProductRegistrationRequest (optional)
100
+ indexProductRegistrationRequest: ...,
101
+ } satisfies IndexProductRegistrationOperationRequest;
102
+
103
+ try {
104
+ const data = await api.indexProductRegistration(body);
105
+ console.log(data);
106
+ } catch (error) {
107
+ console.error(error);
108
+ }
109
+ }
110
+
111
+ // Run the test
112
+ example().catch(console.error);
113
+ ```
114
+
115
+ ### Parameters
116
+
117
+
118
+ | Name | Type | Description | Notes |
119
+ |------------- | ------------- | ------------- | -------------|
120
+ | **indexProductRegistrationRequest** | [IndexProductRegistrationRequest](IndexProductRegistrationRequest.md) | | [Optional] |
121
+
122
+ ### Return type
123
+
124
+ [**PaginatedProductRegistrationListResourceResponse**](PaginatedProductRegistrationListResourceResponse.md)
125
+
126
+ ### Authorization
127
+
128
+ No authorization required
129
+
130
+ ### HTTP request headers
131
+
132
+ - **Content-Type**: `application/json`
133
+ - **Accept**: `application/json`
134
+
135
+
136
+ ### HTTP response details
137
+ | Status code | Description | Response headers |
138
+ |-------------|-------------|------------------|
139
+ | **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductRegistrationListResource[]>> | - |
140
+
141
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
142
+
143
+
144
+ ## listAssetsProductRegistration
145
+
146
+ > PaginatedProductRegistrationAssetResourceResponse listAssetsProductRegistration(productRegistration, listAssetsProductRegistrationRequest)
147
+
148
+ Auto-generated: listAssetsProductRegistration
149
+
150
+ ### Example
151
+
152
+ ```ts
153
+ import {
154
+ Configuration,
155
+ ProductRegistrationApi,
156
+ } from '@digital8/lighting-illusions-ts-sdk';
157
+ import type { ListAssetsProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
158
+
159
+ async function example() {
160
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
161
+ const api = new ProductRegistrationApi();
162
+
163
+ const body = {
164
+ // number | The id of the productRegistration
165
+ productRegistration: 56,
166
+ // ListAssetsProductRegistrationRequest (optional)
167
+ listAssetsProductRegistrationRequest: ...,
168
+ } satisfies ListAssetsProductRegistrationOperationRequest;
169
+
170
+ try {
171
+ const data = await api.listAssetsProductRegistration(body);
172
+ console.log(data);
173
+ } catch (error) {
174
+ console.error(error);
175
+ }
176
+ }
177
+
178
+ // Run the test
179
+ example().catch(console.error);
180
+ ```
181
+
182
+ ### Parameters
183
+
184
+
185
+ | Name | Type | Description | Notes |
186
+ |------------- | ------------- | ------------- | -------------|
187
+ | **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
188
+ | **listAssetsProductRegistrationRequest** | [ListAssetsProductRegistrationRequest](ListAssetsProductRegistrationRequest.md) | | [Optional] |
189
+
190
+ ### Return type
191
+
192
+ [**PaginatedProductRegistrationAssetResourceResponse**](PaginatedProductRegistrationAssetResourceResponse.md)
193
+
194
+ ### Authorization
195
+
196
+ No authorization required
197
+
198
+ ### HTTP request headers
199
+
200
+ - **Content-Type**: `application/json`
201
+ - **Accept**: `application/json`
202
+
203
+
204
+ ### HTTP response details
205
+ | Status code | Description | Response headers |
206
+ |-------------|-------------|------------------|
207
+ | **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductRegistrationAssetResource[]>> | - |
208
+
209
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
210
+
211
+
212
+ ## showProductRegistration
213
+
214
+ > ProductRegistrationResource showProductRegistration(productRegistration)
215
+
216
+ Auto-generated: showProductRegistration
217
+
218
+ ### Example
219
+
220
+ ```ts
221
+ import {
222
+ Configuration,
223
+ ProductRegistrationApi,
224
+ } from '@digital8/lighting-illusions-ts-sdk';
225
+ import type { ShowProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk';
226
+
227
+ async function example() {
228
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
229
+ const api = new ProductRegistrationApi();
230
+
231
+ const body = {
232
+ // number | The id of the productRegistration
233
+ productRegistration: 56,
234
+ } satisfies ShowProductRegistrationRequest;
235
+
236
+ try {
237
+ const data = await api.showProductRegistration(body);
238
+ console.log(data);
239
+ } catch (error) {
240
+ console.error(error);
241
+ }
242
+ }
243
+
244
+ // Run the test
245
+ example().catch(console.error);
246
+ ```
247
+
248
+ ### Parameters
249
+
250
+
251
+ | Name | Type | Description | Notes |
252
+ |------------- | ------------- | ------------- | -------------|
253
+ | **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
254
+
255
+ ### Return type
256
+
257
+ [**ProductRegistrationResource**](ProductRegistrationResource.md)
258
+
259
+ ### Authorization
260
+
261
+ No authorization required
262
+
263
+ ### HTTP request headers
264
+
265
+ - **Content-Type**: Not defined
266
+ - **Accept**: `application/json`
267
+
268
+
269
+ ### HTTP response details
270
+ | Status code | Description | Response headers |
271
+ |-------------|-------------|------------------|
272
+ | **200** | Successful resource response | - |
273
+
274
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
275
+
@@ -1,5 +1,5 @@
1
1
 
2
- # MenuItemLiteResource
2
+ # ProductRegistrationAssetResource
3
3
 
4
4
 
5
5
  ## Properties
@@ -7,26 +7,20 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `id` | number
10
- `menuId` | number
11
- `parentId` | number
12
10
  `type` | string
13
- `heading` | string
14
- `index` | number
11
+ `asset` | [AssetResource](AssetResource.md)
15
12
 
16
13
  ## Example
17
14
 
18
15
  ```typescript
19
- import type { MenuItemLiteResource } from '@digital8/lighting-illusions-ts-sdk'
16
+ import type { ProductRegistrationAssetResource } from '@digital8/lighting-illusions-ts-sdk'
20
17
 
21
18
  // TODO: Update the object below with actual values
22
19
  const example = {
23
20
  "id": null,
24
- "menuId": null,
25
- "parentId": null,
26
21
  "type": null,
27
- "heading": null,
28
- "index": null,
29
- } satisfies MenuItemLiteResource
22
+ "asset": null,
23
+ } satisfies ProductRegistrationAssetResource
30
24
 
31
25
  console.log(example)
32
26
 
@@ -35,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
35
29
  console.log(exampleJSON)
36
30
 
37
31
  // Parse the JSON string back to an object
38
- const exampleParsed = JSON.parse(exampleJSON) as MenuItemLiteResource
32
+ const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationAssetResource
39
33
  console.log(exampleParsed)
40
34
  ```
41
35
 
@@ -1,22 +1,22 @@
1
1
 
2
- # MenuItemHierarchyResourceArrayResponse
2
+ # ProductRegistrationAssetResourceArrayResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `data` | [Array<MenuItemHierarchyResource>](MenuItemHierarchyResource.md)
9
+ `data` | [Array<ProductRegistrationAssetResource>](ProductRegistrationAssetResource.md)
10
10
 
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import type { MenuItemHierarchyResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
14
+ import type { ProductRegistrationAssetResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
15
 
16
16
  // TODO: Update the object below with actual values
17
17
  const example = {
18
18
  "data": null,
19
- } satisfies MenuItemHierarchyResourceArrayResponse
19
+ } satisfies ProductRegistrationAssetResourceArrayResponse
20
20
 
21
21
  console.log(example)
22
22
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
25
25
  console.log(exampleJSON)
26
26
 
27
27
  // Parse the JSON string back to an object
28
- const exampleParsed = JSON.parse(exampleJSON) as MenuItemHierarchyResourceArrayResponse
28
+ const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationAssetResourceArrayResponse
29
29
  console.log(exampleParsed)
30
30
  ```
31
31
 
@@ -1,5 +1,5 @@
1
1
 
2
- # MenuItemType
2
+ # ProductRegistrationAssetType
3
3
 
4
4
 
5
5
  ## Properties
@@ -10,11 +10,11 @@ Name | Type
10
10
  ## Example
11
11
 
12
12
  ```typescript
13
- import type { MenuItemType } from '@digital8/lighting-illusions-ts-sdk'
13
+ import type { ProductRegistrationAssetType } from '@digital8/lighting-illusions-ts-sdk'
14
14
 
15
15
  // TODO: Update the object below with actual values
16
16
  const example = {
17
- } satisfies MenuItemType
17
+ } satisfies ProductRegistrationAssetType
18
18
 
19
19
  console.log(example)
20
20
 
@@ -23,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
23
23
  console.log(exampleJSON)
24
24
 
25
25
  // Parse the JSON string back to an object
26
- const exampleParsed = JSON.parse(exampleJSON) as MenuItemType
26
+ const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationAssetType
27
27
  console.log(exampleParsed)
28
28
  ```
29
29
 
@@ -1,5 +1,5 @@
1
1
 
2
- # MenuItemLinkResource
2
+ # ProductRegistrationCustomerResource
3
3
 
4
4
 
5
5
  ## Properties
@@ -7,28 +7,26 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `id` | number
10
- `menuItemId` | number
11
- `linkableId` | number
12
- `linkableType` | string
13
10
  `name` | string
14
- `link` | string
15
- `isExternalLink` | boolean
11
+ `email` | string
12
+ `phone` | string
13
+ `omnisendId` | string
14
+ `omnisendSyncStatus` | string
16
15
 
17
16
  ## Example
18
17
 
19
18
  ```typescript
20
- import type { MenuItemLinkResource } from '@digital8/lighting-illusions-ts-sdk'
19
+ import type { ProductRegistrationCustomerResource } from '@digital8/lighting-illusions-ts-sdk'
21
20
 
22
21
  // TODO: Update the object below with actual values
23
22
  const example = {
24
23
  "id": null,
25
- "menuItemId": null,
26
- "linkableId": null,
27
- "linkableType": null,
28
24
  "name": null,
29
- "link": null,
30
- "isExternalLink": null,
31
- } satisfies MenuItemLinkResource
25
+ "email": null,
26
+ "phone": null,
27
+ "omnisendId": null,
28
+ "omnisendSyncStatus": null,
29
+ } satisfies ProductRegistrationCustomerResource
32
30
 
33
31
  console.log(example)
34
32
 
@@ -37,7 +35,7 @@ const exampleJSON: string = JSON.stringify(example)
37
35
  console.log(exampleJSON)
38
36
 
39
37
  // Parse the JSON string back to an object
40
- const exampleParsed = JSON.parse(exampleJSON) as MenuItemLinkResource
38
+ const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationCustomerResource
41
39
  console.log(exampleParsed)
42
40
  ```
43
41
 
@@ -0,0 +1,34 @@
1
+
2
+ # ProductRegistrationCustomerResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRegistrationCustomerResource>](ProductRegistrationCustomerResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ProductRegistrationCustomerResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies ProductRegistrationCustomerResourceArrayResponse
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 ProductRegistrationCustomerResourceArrayResponse
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,5 +1,5 @@
1
1
 
2
- # MenuListResource
2
+ # ProductRegistrationListResource
3
3
 
4
4
 
5
5
  ## Properties
@@ -7,26 +7,24 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `id` | number
10
- `name` | string
11
- `position` | string
12
- `site` | [SiteLiteResource](SiteLiteResource.md)
13
- `items` | [Array<MenuItemLiteResource>](MenuItemLiteResource.md)
14
- `menuItemCount` | number
10
+ `purchasedDate` | Date
11
+ `customer` | [ProductRegistrationCustomerResource](ProductRegistrationCustomerResource.md)
12
+ `productChildrenCount` | number
13
+ `createdAt` | Date
15
14
 
16
15
  ## Example
17
16
 
18
17
  ```typescript
19
- import type { MenuListResource } from '@digital8/lighting-illusions-ts-sdk'
18
+ import type { ProductRegistrationListResource } from '@digital8/lighting-illusions-ts-sdk'
20
19
 
21
20
  // TODO: Update the object below with actual values
22
21
  const example = {
23
22
  "id": null,
24
- "name": null,
25
- "position": null,
26
- "site": null,
27
- "items": null,
28
- "menuItemCount": null,
29
- } satisfies MenuListResource
23
+ "purchasedDate": null,
24
+ "customer": null,
25
+ "productChildrenCount": null,
26
+ "createdAt": null,
27
+ } satisfies ProductRegistrationListResource
30
28
 
31
29
  console.log(example)
32
30
 
@@ -35,7 +33,7 @@ const exampleJSON: string = JSON.stringify(example)
35
33
  console.log(exampleJSON)
36
34
 
37
35
  // Parse the JSON string back to an object
38
- const exampleParsed = JSON.parse(exampleJSON) as MenuListResource
36
+ const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationListResource
39
37
  console.log(exampleParsed)
40
38
  ```
41
39
 
@@ -1,22 +1,22 @@
1
1
 
2
- # MenuItemLinkResourceArrayResponse
2
+ # ProductRegistrationListResourceArrayResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `data` | [Array<MenuItemLinkResource>](MenuItemLinkResource.md)
9
+ `data` | [Array<ProductRegistrationListResource>](ProductRegistrationListResource.md)
10
10
 
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import type { MenuItemLinkResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
14
+ import type { ProductRegistrationListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
15
 
16
16
  // TODO: Update the object below with actual values
17
17
  const example = {
18
18
  "data": null,
19
- } satisfies MenuItemLinkResourceArrayResponse
19
+ } satisfies ProductRegistrationListResourceArrayResponse
20
20
 
21
21
  console.log(example)
22
22
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
25
25
  console.log(exampleJSON)
26
26
 
27
27
  // Parse the JSON string back to an object
28
- const exampleParsed = JSON.parse(exampleJSON) as MenuItemLinkResourceArrayResponse
28
+ const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationListResourceArrayResponse
29
29
  console.log(exampleParsed)
30
30
  ```
31
31
 
@@ -1,5 +1,5 @@
1
1
 
2
- # UpdateMenuRequestMenuItemOrderInner
2
+ # ProductRegistrationLiteResource
3
3
 
4
4
 
5
5
  ## Properties
@@ -7,20 +7,18 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `id` | number
10
- `index` | number
11
- `parentId` | number
10
+ `purchasedDate` | Date
12
11
 
13
12
  ## Example
14
13
 
15
14
  ```typescript
16
- import type { UpdateMenuRequestMenuItemOrderInner } from '@digital8/lighting-illusions-ts-sdk'
15
+ import type { ProductRegistrationLiteResource } from '@digital8/lighting-illusions-ts-sdk'
17
16
 
18
17
  // TODO: Update the object below with actual values
19
18
  const example = {
20
19
  "id": null,
21
- "index": null,
22
- "parentId": null,
23
- } satisfies UpdateMenuRequestMenuItemOrderInner
20
+ "purchasedDate": null,
21
+ } satisfies ProductRegistrationLiteResource
24
22
 
25
23
  console.log(example)
26
24
 
@@ -29,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
29
27
  console.log(exampleJSON)
30
28
 
31
29
  // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as UpdateMenuRequestMenuItemOrderInner
30
+ const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationLiteResource
33
31
  console.log(exampleParsed)
34
32
  ```
35
33