@digital8/lighting-illusions-ts-sdk 0.0.1361 → 0.0.1362

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 (230) hide show
  1. package/.openapi-generator/FILES +72 -20
  2. package/README.md +54 -17
  3. package/dist/apis/AttributeApi.d.ts +16 -1
  4. package/dist/apis/AttributeApi.js +58 -0
  5. package/dist/apis/ProductRangeApi.d.ts +269 -0
  6. package/dist/apis/ProductRangeApi.js +1043 -0
  7. package/dist/apis/index.d.ts +1 -1
  8. package/dist/apis/index.js +1 -1
  9. package/dist/models/AttachAccessoriesProductRangeRequest.d.ts +32 -0
  10. package/dist/models/AttachAccessoriesProductRangeRequest.js +51 -0
  11. package/dist/models/AttachAttributesProductRangeRequest.d.ts +33 -0
  12. package/dist/models/AttachAttributesProductRangeRequest.js +52 -0
  13. package/dist/models/AttachAttributesProductRangeRequestAttributesInner.d.ts +38 -0
  14. package/dist/models/AttachAttributesProductRangeRequestAttributesInner.js +53 -0
  15. package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.d.ts +2 -1
  16. package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.js +2 -1
  17. package/dist/models/AttachDocumentsProductRangeRequest.d.ts +33 -0
  18. package/dist/models/AttachDocumentsProductRangeRequest.js +52 -0
  19. package/dist/models/DetachAccessoriesProductRangeRequest.d.ts +32 -0
  20. package/dist/models/DetachAccessoriesProductRangeRequest.js +51 -0
  21. package/dist/models/DetachAttributesProductRangeRequest.d.ts +32 -0
  22. package/dist/models/DetachAttributesProductRangeRequest.js +51 -0
  23. package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.d.ts +2 -1
  24. package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.js +2 -1
  25. package/dist/models/DetachDocumentsProductRangeRequest.d.ts +32 -0
  26. package/dist/models/DetachDocumentsProductRangeRequest.js +51 -0
  27. package/dist/models/GetAllDocumentRequest.d.ts +2 -1
  28. package/dist/models/GetAllDocumentRequest.js +2 -1
  29. package/dist/models/GetAllProductChildRequest.d.ts +1 -0
  30. package/dist/models/GetAllProductChildRequest.js +1 -0
  31. package/dist/models/GetAllProductRangeRequest.d.ts +98 -0
  32. package/dist/models/GetAllProductRangeRequest.js +82 -0
  33. package/dist/models/IndexAttributeRequest.d.ts +2 -0
  34. package/dist/models/IndexAttributeRequest.js +3 -1
  35. package/dist/models/IndexDocumentRequest.d.ts +2 -1
  36. package/dist/models/IndexDocumentRequest.js +2 -1
  37. package/dist/models/IndexModelAttributeRequest.d.ts +118 -0
  38. package/dist/models/IndexModelAttributeRequest.js +93 -0
  39. package/dist/models/IndexProductChildRequest.d.ts +1 -1
  40. package/dist/models/IndexProductChildRequest.js +1 -1
  41. package/dist/models/IndexProductRangeRequest.d.ts +110 -0
  42. package/dist/models/{IndexLabelRequest.js → IndexProductRangeRequest.js} +23 -22
  43. package/dist/models/LabelResource.d.ts +2 -20
  44. package/dist/models/LabelResource.js +5 -15
  45. package/dist/models/ModelAttributeListResource.d.ts +64 -0
  46. package/dist/models/ModelAttributeListResource.js +71 -0
  47. package/dist/models/ModelAttributeListResourceArrayResponse.d.ts +33 -0
  48. package/dist/models/ModelAttributeListResourceArrayResponse.js +50 -0
  49. package/dist/models/ModelAttributeResource.d.ts +6 -0
  50. package/dist/models/ModelAttributeResource.js +2 -0
  51. package/dist/models/PaginatedModelAttributeListResourceResponse.d.ts +40 -0
  52. package/dist/models/PaginatedModelAttributeListResourceResponse.js +57 -0
  53. package/dist/models/PaginatedProductRangeFrontendListResourceResponse.d.ts +40 -0
  54. package/dist/models/PaginatedProductRangeFrontendListResourceResponse.js +57 -0
  55. package/dist/models/PaginatedProductRangeListResourceResponse.d.ts +40 -0
  56. package/dist/models/PaginatedProductRangeListResourceResponse.js +57 -0
  57. package/dist/models/PaginatedProductRangeLiteResourceResponse.d.ts +40 -0
  58. package/dist/models/PaginatedProductRangeLiteResourceResponse.js +57 -0
  59. package/dist/models/PaginatedProductRangeResourceResponse.d.ts +40 -0
  60. package/dist/models/PaginatedProductRangeResourceResponse.js +57 -0
  61. package/dist/models/ProductRangeFrontendListResource.d.ts +62 -0
  62. package/dist/models/ProductRangeFrontendListResource.js +71 -0
  63. package/dist/models/ProductRangeFrontendListResourceArrayResponse.d.ts +33 -0
  64. package/dist/models/ProductRangeFrontendListResourceArrayResponse.js +50 -0
  65. package/dist/models/ProductRangeFrontendResource.d.ts +118 -0
  66. package/dist/models/ProductRangeFrontendResource.js +109 -0
  67. package/dist/models/ProductRangeFrontendResourceArrayResponse.d.ts +33 -0
  68. package/dist/models/ProductRangeFrontendResourceArrayResponse.js +50 -0
  69. package/dist/models/ProductRangeListResource.d.ts +66 -0
  70. package/dist/models/ProductRangeListResource.js +75 -0
  71. package/dist/models/ProductRangeListResourceArrayResponse.d.ts +33 -0
  72. package/dist/models/ProductRangeListResourceArrayResponse.js +50 -0
  73. package/dist/models/ProductRangeLiteResource.d.ts +38 -0
  74. package/dist/models/ProductRangeLiteResource.js +55 -0
  75. package/dist/models/ProductRangeLiteResourceArrayResponse.d.ts +33 -0
  76. package/dist/models/ProductRangeLiteResourceArrayResponse.js +50 -0
  77. package/dist/models/ProductRangeResource.d.ts +89 -0
  78. package/dist/models/ProductRangeResource.js +86 -0
  79. package/dist/models/ProductRangeResourceArrayResponse.d.ts +33 -0
  80. package/dist/models/ProductRangeResourceArrayResponse.js +50 -0
  81. package/dist/models/ProductRangeSiteDetailLiteResource.d.ts +44 -0
  82. package/dist/models/ProductRangeSiteDetailLiteResource.js +59 -0
  83. package/dist/models/ProductRangeSiteDetailLiteResourceArrayResponse.d.ts +33 -0
  84. package/dist/models/ProductRangeSiteDetailLiteResourceArrayResponse.js +50 -0
  85. package/dist/models/ProductRangeSiteDetailResource.d.ts +101 -0
  86. package/dist/models/ProductRangeSiteDetailResource.js +98 -0
  87. package/dist/models/ProductRangeSiteDetailResourceArrayResponse.d.ts +33 -0
  88. package/dist/models/ProductRangeSiteDetailResourceArrayResponse.js +50 -0
  89. package/dist/models/ProductSearchResultResource.d.ts +1 -1
  90. package/dist/models/ProductSearchResultResource.js +3 -3
  91. package/dist/models/StoreAssetForAssetableRequest.d.ts +2 -0
  92. package/dist/models/StoreAssetForAssetableRequest.js +3 -1
  93. package/dist/models/StoreProductRangeRequest.d.ts +52 -0
  94. package/dist/models/StoreProductRangeRequest.js +59 -0
  95. package/dist/models/StoreProductRangeRequestSitesInner.d.ts +92 -0
  96. package/dist/models/StoreProductRangeRequestSitesInner.js +75 -0
  97. package/dist/models/UpdateProductRangeRequest.d.ts +59 -0
  98. package/dist/models/UpdateProductRangeRequest.js +62 -0
  99. package/dist/models/UpdateProductRangeRequestAttributesInner.d.ts +38 -0
  100. package/dist/models/UpdateProductRangeRequestAttributesInner.js +51 -0
  101. package/dist/models/UpdateProductTypeRequest.d.ts +9 -9
  102. package/dist/models/UpdateProductTypeRequest.js +9 -9
  103. package/dist/models/index.d.ts +35 -9
  104. package/dist/models/index.js +35 -9
  105. package/docs/AttachAccessoriesProductRangeRequest.md +34 -0
  106. package/docs/AttachAttributesProductRangeRequest.md +34 -0
  107. package/docs/AttachAttributesProductRangeRequestAttributesInner.md +36 -0
  108. package/docs/AttachDocumentsProductRangeRequest.md +34 -0
  109. package/docs/AttributeApi.md +66 -0
  110. package/docs/DetachAccessoriesProductRangeRequest.md +34 -0
  111. package/docs/{LabelListResourceArrayResponse.md → DetachAttributesProductRangeRequest.md} +6 -6
  112. package/docs/DetachDocumentsProductRangeRequest.md +34 -0
  113. package/docs/GetAllProductRangeRequest.md +50 -0
  114. package/docs/{IndexLabelRequest.md → IndexModelAttributeRequest.md} +10 -6
  115. package/docs/IndexProductRangeRequest.md +54 -0
  116. package/docs/LabelResource.md +4 -10
  117. package/docs/ModelAttributeListResource.md +44 -0
  118. package/docs/ModelAttributeListResourceArrayResponse.md +34 -0
  119. package/docs/ModelAttributeResource.md +2 -0
  120. package/docs/PaginatedModelAttributeListResourceResponse.md +36 -0
  121. package/docs/PaginatedProductRangeFrontendListResourceResponse.md +36 -0
  122. package/docs/PaginatedProductRangeListResourceResponse.md +36 -0
  123. package/docs/PaginatedProductRangeLiteResourceResponse.md +36 -0
  124. package/docs/{PaginatedLabelListResourceResponse.md → PaginatedProductRangeResourceResponse.md} +5 -5
  125. package/docs/ProductRangeApi.md +1097 -0
  126. package/docs/ProductRangeFrontendListResource.md +44 -0
  127. package/docs/ProductRangeFrontendListResourceArrayResponse.md +34 -0
  128. package/docs/ProductRangeFrontendResource.md +62 -0
  129. package/docs/ProductRangeFrontendResourceArrayResponse.md +34 -0
  130. package/docs/ProductRangeListResource.md +44 -0
  131. package/docs/ProductRangeListResourceArrayResponse.md +34 -0
  132. package/docs/{LabelLiteResource.md → ProductRangeLiteResource.md} +6 -12
  133. package/docs/ProductRangeLiteResourceArrayResponse.md +34 -0
  134. package/docs/ProductRangeResource.md +52 -0
  135. package/docs/{LabelLiteResourceArrayResponse.md → ProductRangeResourceArrayResponse.md} +5 -5
  136. package/docs/ProductRangeSiteDetailLiteResource.md +38 -0
  137. package/docs/ProductRangeSiteDetailLiteResourceArrayResponse.md +34 -0
  138. package/docs/ProductRangeSiteDetailResource.md +56 -0
  139. package/docs/ProductRangeSiteDetailResourceArrayResponse.md +34 -0
  140. package/docs/ProductSearchResultResource.md +2 -2
  141. package/docs/StoreProductRangeRequest.md +40 -0
  142. package/docs/StoreProductRangeRequestSitesInner.md +54 -0
  143. package/docs/UpdateProductRangeRequest.md +42 -0
  144. package/docs/{UpdateProductTypeRequestPerformanceValuesInner.md → UpdateProductRangeRequestAttributesInner.md} +4 -4
  145. package/docs/UpdateProductTypeRequest.md +4 -4
  146. package/package.json +1 -1
  147. package/src/apis/AttributeApi.ts +50 -0
  148. package/src/apis/ProductRangeApi.ts +888 -0
  149. package/src/apis/index.ts +1 -1
  150. package/src/models/AttachAccessoriesProductRangeRequest.ts +66 -0
  151. package/src/models/AttachAttributesProductRangeRequest.ts +74 -0
  152. package/src/models/AttachAttributesProductRangeRequestAttributesInner.ts +74 -0
  153. package/src/models/AttachDocumentablesDocumentRequestDocumentablesInner.ts +2 -1
  154. package/src/models/AttachDocumentsProductRangeRequest.ts +74 -0
  155. package/src/models/DetachAccessoriesProductRangeRequest.ts +66 -0
  156. package/src/models/DetachAttributesProductRangeRequest.ts +66 -0
  157. package/src/models/DetachDocumentablesDocumentRequestDocumentablesInner.ts +2 -1
  158. package/src/models/DetachDocumentsProductRangeRequest.ts +66 -0
  159. package/src/models/GetAllDocumentRequest.ts +2 -1
  160. package/src/models/GetAllProductChildRequest.ts +1 -0
  161. package/src/models/GetAllProductRangeRequest.ts +151 -0
  162. package/src/models/IndexAttributeRequest.ts +3 -1
  163. package/src/models/IndexDocumentRequest.ts +2 -1
  164. package/src/models/IndexModelAttributeRequest.ts +176 -0
  165. package/src/models/IndexProductChildRequest.ts +1 -1
  166. package/src/models/IndexProductRangeRequest.ts +167 -0
  167. package/src/models/LabelResource.ts +7 -33
  168. package/src/models/ModelAttributeListResource.ts +125 -0
  169. package/src/models/ModelAttributeListResourceArrayResponse.ts +73 -0
  170. package/src/models/ModelAttributeResource.ts +8 -0
  171. package/src/models/PaginatedModelAttributeListResourceResponse.ts +90 -0
  172. package/src/models/PaginatedProductRangeFrontendListResourceResponse.ts +90 -0
  173. package/src/models/PaginatedProductRangeListResourceResponse.ts +90 -0
  174. package/src/models/PaginatedProductRangeLiteResourceResponse.ts +90 -0
  175. package/src/models/PaginatedProductRangeResourceResponse.ts +90 -0
  176. package/src/models/ProductRangeFrontendListResource.ts +111 -0
  177. package/src/models/ProductRangeFrontendListResourceArrayResponse.ts +73 -0
  178. package/src/models/ProductRangeFrontendResource.ts +207 -0
  179. package/src/models/ProductRangeFrontendResourceArrayResponse.ts +73 -0
  180. package/src/models/ProductRangeListResource.ts +140 -0
  181. package/src/models/ProductRangeListResourceArrayResponse.ts +73 -0
  182. package/src/models/ProductRangeLiteResource.ts +75 -0
  183. package/src/models/ProductRangeLiteResourceArrayResponse.ts +73 -0
  184. package/src/models/ProductRangeResource.ts +167 -0
  185. package/src/models/ProductRangeResourceArrayResponse.ts +73 -0
  186. package/src/models/ProductRangeSiteDetailLiteResource.ts +84 -0
  187. package/src/models/ProductRangeSiteDetailLiteResourceArrayResponse.ts +73 -0
  188. package/src/models/ProductRangeSiteDetailResource.ts +187 -0
  189. package/src/models/ProductRangeSiteDetailResourceArrayResponse.ts +73 -0
  190. package/src/models/ProductSearchResultResource.ts +4 -4
  191. package/src/models/StoreAssetForAssetableRequest.ts +3 -1
  192. package/src/models/StoreProductRangeRequest.ts +105 -0
  193. package/src/models/StoreProductRangeRequestSitesInner.ts +148 -0
  194. package/src/models/UpdateProductRangeRequest.ts +120 -0
  195. package/src/models/UpdateProductRangeRequestAttributesInner.ts +73 -0
  196. package/src/models/UpdateProductTypeRequest.ts +22 -22
  197. package/src/models/index.ts +35 -9
  198. package/dist/apis/LabelApi.d.ts +0 -109
  199. package/dist/apis/LabelApi.js +0 -433
  200. package/dist/models/IndexLabelRequest.d.ts +0 -101
  201. package/dist/models/LabelListResource.d.ts +0 -81
  202. package/dist/models/LabelListResource.js +0 -78
  203. package/dist/models/LabelListResourceArrayResponse.d.ts +0 -33
  204. package/dist/models/LabelListResourceArrayResponse.js +0 -50
  205. package/dist/models/LabelLiteResource.d.ts +0 -56
  206. package/dist/models/LabelLiteResource.js +0 -65
  207. package/dist/models/LabelLiteResourceArrayResponse.d.ts +0 -33
  208. package/dist/models/LabelLiteResourceArrayResponse.js +0 -50
  209. package/dist/models/PaginatedLabelListResourceResponse.d.ts +0 -40
  210. package/dist/models/PaginatedLabelListResourceResponse.js +0 -57
  211. package/dist/models/StoreLabelRequest.d.ts +0 -74
  212. package/dist/models/StoreLabelRequest.js +0 -71
  213. package/dist/models/UpdateLabelRequest.d.ts +0 -74
  214. package/dist/models/UpdateLabelRequest.js +0 -63
  215. package/dist/models/UpdateProductTypeRequestPerformanceValuesInner.d.ts +0 -38
  216. package/dist/models/UpdateProductTypeRequestPerformanceValuesInner.js +0 -51
  217. package/docs/LabelApi.md +0 -407
  218. package/docs/LabelListResource.md +0 -50
  219. package/docs/StoreLabelRequest.md +0 -48
  220. package/docs/UpdateLabelRequest.md +0 -48
  221. package/src/apis/LabelApi.ts +0 -328
  222. package/src/models/IndexLabelRequest.ts +0 -154
  223. package/src/models/LabelListResource.ts +0 -143
  224. package/src/models/LabelListResourceArrayResponse.ts +0 -73
  225. package/src/models/LabelLiteResource.ts +0 -101
  226. package/src/models/LabelLiteResourceArrayResponse.ts +0 -73
  227. package/src/models/PaginatedLabelListResourceResponse.ts +0 -90
  228. package/src/models/StoreLabelRequest.ts +0 -125
  229. package/src/models/UpdateLabelRequest.ts +0 -121
  230. package/src/models/UpdateProductTypeRequestPerformanceValuesInner.ts +0 -73
@@ -1,38 +0,0 @@
1
- /**
2
- * My API
3
- * API documentation for my Laravel app
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @interface UpdateProductTypeRequestPerformanceValuesInner
16
- */
17
- export interface UpdateProductTypeRequestPerformanceValuesInner {
18
- /**
19
- *
20
- * @type {number}
21
- * @memberof UpdateProductTypeRequestPerformanceValuesInner
22
- */
23
- attributeId?: number;
24
- /**
25
- *
26
- * @type {number}
27
- * @memberof UpdateProductTypeRequestPerformanceValuesInner
28
- */
29
- order?: number;
30
- }
31
- /**
32
- * Check if a given object implements the UpdateProductTypeRequestPerformanceValuesInner interface.
33
- */
34
- export declare function instanceOfUpdateProductTypeRequestPerformanceValuesInner(value: object): value is UpdateProductTypeRequestPerformanceValuesInner;
35
- export declare function UpdateProductTypeRequestPerformanceValuesInnerFromJSON(json: any): UpdateProductTypeRequestPerformanceValuesInner;
36
- export declare function UpdateProductTypeRequestPerformanceValuesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateProductTypeRequestPerformanceValuesInner;
37
- export declare function UpdateProductTypeRequestPerformanceValuesInnerToJSON(json: any): UpdateProductTypeRequestPerformanceValuesInner;
38
- export declare function UpdateProductTypeRequestPerformanceValuesInnerToJSONTyped(value?: UpdateProductTypeRequestPerformanceValuesInner | null, ignoreDiscriminator?: boolean): any;
@@ -1,51 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * My API
6
- * API documentation for my Laravel app
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfUpdateProductTypeRequestPerformanceValuesInner = instanceOfUpdateProductTypeRequestPerformanceValuesInner;
17
- exports.UpdateProductTypeRequestPerformanceValuesInnerFromJSON = UpdateProductTypeRequestPerformanceValuesInnerFromJSON;
18
- exports.UpdateProductTypeRequestPerformanceValuesInnerFromJSONTyped = UpdateProductTypeRequestPerformanceValuesInnerFromJSONTyped;
19
- exports.UpdateProductTypeRequestPerformanceValuesInnerToJSON = UpdateProductTypeRequestPerformanceValuesInnerToJSON;
20
- exports.UpdateProductTypeRequestPerformanceValuesInnerToJSONTyped = UpdateProductTypeRequestPerformanceValuesInnerToJSONTyped;
21
- /**
22
- * Check if a given object implements the UpdateProductTypeRequestPerformanceValuesInner interface.
23
- */
24
- function instanceOfUpdateProductTypeRequestPerformanceValuesInner(value) {
25
- return true;
26
- }
27
- function UpdateProductTypeRequestPerformanceValuesInnerFromJSON(json) {
28
- return UpdateProductTypeRequestPerformanceValuesInnerFromJSONTyped(json, false);
29
- }
30
- function UpdateProductTypeRequestPerformanceValuesInnerFromJSONTyped(json, ignoreDiscriminator) {
31
- if (json == null) {
32
- return json;
33
- }
34
- return {
35
- 'attributeId': json['attribute_id'] == null ? undefined : json['attribute_id'],
36
- 'order': json['order'] == null ? undefined : json['order'],
37
- };
38
- }
39
- function UpdateProductTypeRequestPerformanceValuesInnerToJSON(json) {
40
- return UpdateProductTypeRequestPerformanceValuesInnerToJSONTyped(json, false);
41
- }
42
- function UpdateProductTypeRequestPerformanceValuesInnerToJSONTyped(value, ignoreDiscriminator) {
43
- if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
44
- if (value == null) {
45
- return value;
46
- }
47
- return {
48
- 'attribute_id': value['attributeId'],
49
- 'order': value['order'],
50
- };
51
- }
package/docs/LabelApi.md DELETED
@@ -1,407 +0,0 @@
1
- # LabelApi
2
-
3
- All URIs are relative to *http://localhost/api*
4
-
5
- | Method | HTTP request | Description |
6
- |------------- | ------------- | -------------|
7
- | [**destroyLabel**](LabelApi.md#destroylabel) | **DELETE** /admin-api/label/{label}/delete | Auto-generated: destroyLabel |
8
- | [**getAllLabel**](LabelApi.md#getalllabel) | **POST** /admin-api/label/all | Auto-generated: getAllLabel |
9
- | [**indexLabel**](LabelApi.md#indexlabeloperation) | **POST** /admin-api/label/list | Auto-generated: indexLabel |
10
- | [**showLabel**](LabelApi.md#showlabel) | **GET** /admin-api/label/{label} | Auto-generated: showLabel |
11
- | [**storeLabel**](LabelApi.md#storelabeloperation) | **POST** /admin-api/label/create | Auto-generated: storeLabel |
12
- | [**updateLabel**](LabelApi.md#updatelabeloperation) | **PUT** /admin-api/label/{label}/update | Auto-generated: updateLabel |
13
-
14
-
15
-
16
- ## destroyLabel
17
-
18
- > GenericResponse destroyLabel(label)
19
-
20
- Auto-generated: destroyLabel
21
-
22
- ### Example
23
-
24
- ```ts
25
- import {
26
- Configuration,
27
- LabelApi,
28
- } from '@digital8/lighting-illusions-ts-sdk';
29
- import type { DestroyLabelRequest } 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 LabelApi();
34
-
35
- const body = {
36
- // number | The id of the label
37
- label: 56,
38
- } satisfies DestroyLabelRequest;
39
-
40
- try {
41
- const data = await api.destroyLabel(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
- | **label** | `number` | The id of the label | [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
- ## getAllLabel
82
-
83
- > GenericResponse getAllLabel(indexLabelRequest)
84
-
85
- Auto-generated: getAllLabel
86
-
87
- ### Example
88
-
89
- ```ts
90
- import {
91
- Configuration,
92
- LabelApi,
93
- } from '@digital8/lighting-illusions-ts-sdk';
94
- import type { GetAllLabelRequest } 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 LabelApi();
99
-
100
- const body = {
101
- // IndexLabelRequest (optional)
102
- indexLabelRequest: ...,
103
- } satisfies GetAllLabelRequest;
104
-
105
- try {
106
- const data = await api.getAllLabel(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
- | **indexLabelRequest** | [IndexLabelRequest](IndexLabelRequest.md) | | [Optional] |
123
-
124
- ### Return type
125
-
126
- [**GenericResponse**](GenericResponse.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** | \\JsonResponse<array{data: \\LabelLiteResource[]}> | - |
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
- ## indexLabel
147
-
148
- > PaginatedLabelListResourceResponse indexLabel(indexLabelRequest)
149
-
150
- Auto-generated: indexLabel
151
-
152
- ### Example
153
-
154
- ```ts
155
- import {
156
- Configuration,
157
- LabelApi,
158
- } from '@digital8/lighting-illusions-ts-sdk';
159
- import type { IndexLabelOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
160
-
161
- async function example() {
162
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
163
- const api = new LabelApi();
164
-
165
- const body = {
166
- // IndexLabelRequest (optional)
167
- indexLabelRequest: ...,
168
- } satisfies IndexLabelOperationRequest;
169
-
170
- try {
171
- const data = await api.indexLabel(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
- | **indexLabelRequest** | [IndexLabelRequest](IndexLabelRequest.md) | | [Optional] |
188
-
189
- ### Return type
190
-
191
- [**PaginatedLabelListResourceResponse**](PaginatedLabelListResourceResponse.md)
192
-
193
- ### Authorization
194
-
195
- No authorization required
196
-
197
- ### HTTP request headers
198
-
199
- - **Content-Type**: `application/json`
200
- - **Accept**: `application/json`
201
-
202
-
203
- ### HTTP response details
204
- | Status code | Description | Response headers |
205
- |-------------|-------------|------------------|
206
- | **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\LabelListResource[]>> | - |
207
-
208
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
209
-
210
-
211
- ## showLabel
212
-
213
- > LabelResource showLabel(label)
214
-
215
- Auto-generated: showLabel
216
-
217
- ### Example
218
-
219
- ```ts
220
- import {
221
- Configuration,
222
- LabelApi,
223
- } from '@digital8/lighting-illusions-ts-sdk';
224
- import type { ShowLabelRequest } from '@digital8/lighting-illusions-ts-sdk';
225
-
226
- async function example() {
227
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
228
- const api = new LabelApi();
229
-
230
- const body = {
231
- // number | The id of the label
232
- label: 56,
233
- } satisfies ShowLabelRequest;
234
-
235
- try {
236
- const data = await api.showLabel(body);
237
- console.log(data);
238
- } catch (error) {
239
- console.error(error);
240
- }
241
- }
242
-
243
- // Run the test
244
- example().catch(console.error);
245
- ```
246
-
247
- ### Parameters
248
-
249
-
250
- | Name | Type | Description | Notes |
251
- |------------- | ------------- | ------------- | -------------|
252
- | **label** | `number` | The id of the label | [Defaults to `undefined`] |
253
-
254
- ### Return type
255
-
256
- [**LabelResource**](LabelResource.md)
257
-
258
- ### Authorization
259
-
260
- No authorization required
261
-
262
- ### HTTP request headers
263
-
264
- - **Content-Type**: Not defined
265
- - **Accept**: `application/json`
266
-
267
-
268
- ### HTTP response details
269
- | Status code | Description | Response headers |
270
- |-------------|-------------|------------------|
271
- | **200** | Successful resource response | - |
272
-
273
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
274
-
275
-
276
- ## storeLabel
277
-
278
- > LabelResource storeLabel(storeLabelRequest)
279
-
280
- Auto-generated: storeLabel
281
-
282
- ### Example
283
-
284
- ```ts
285
- import {
286
- Configuration,
287
- LabelApi,
288
- } from '@digital8/lighting-illusions-ts-sdk';
289
- import type { StoreLabelOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
290
-
291
- async function example() {
292
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
293
- const api = new LabelApi();
294
-
295
- const body = {
296
- // StoreLabelRequest (optional)
297
- storeLabelRequest: ...,
298
- } satisfies StoreLabelOperationRequest;
299
-
300
- try {
301
- const data = await api.storeLabel(body);
302
- console.log(data);
303
- } catch (error) {
304
- console.error(error);
305
- }
306
- }
307
-
308
- // Run the test
309
- example().catch(console.error);
310
- ```
311
-
312
- ### Parameters
313
-
314
-
315
- | Name | Type | Description | Notes |
316
- |------------- | ------------- | ------------- | -------------|
317
- | **storeLabelRequest** | [StoreLabelRequest](StoreLabelRequest.md) | | [Optional] |
318
-
319
- ### Return type
320
-
321
- [**LabelResource**](LabelResource.md)
322
-
323
- ### Authorization
324
-
325
- No authorization required
326
-
327
- ### HTTP request headers
328
-
329
- - **Content-Type**: `application/json`
330
- - **Accept**: `application/json`
331
-
332
-
333
- ### HTTP response details
334
- | Status code | Description | Response headers |
335
- |-------------|-------------|------------------|
336
- | **200** | Successful resource response | - |
337
-
338
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
339
-
340
-
341
- ## updateLabel
342
-
343
- > LabelResource updateLabel(label, updateLabelRequest)
344
-
345
- Auto-generated: updateLabel
346
-
347
- ### Example
348
-
349
- ```ts
350
- import {
351
- Configuration,
352
- LabelApi,
353
- } from '@digital8/lighting-illusions-ts-sdk';
354
- import type { UpdateLabelOperationRequest } 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 LabelApi();
359
-
360
- const body = {
361
- // number | The id of the label
362
- label: 56,
363
- // UpdateLabelRequest (optional)
364
- updateLabelRequest: ...,
365
- } satisfies UpdateLabelOperationRequest;
366
-
367
- try {
368
- const data = await api.updateLabel(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
- | **label** | `number` | The id of the label | [Defaults to `undefined`] |
385
- | **updateLabelRequest** | [UpdateLabelRequest](UpdateLabelRequest.md) | | [Optional] |
386
-
387
- ### Return type
388
-
389
- [**LabelResource**](LabelResource.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,50 +0,0 @@
1
-
2
- # LabelListResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | number
10
- `shortName` | string
11
- `longName` | string
12
- `siteId` | number
13
- `colour` | string
14
- `textColour` | string
15
- `startDate` | string
16
- `endDate` | string
17
- `site` | [SiteLiteResource](SiteLiteResource.md)
18
-
19
- ## Example
20
-
21
- ```typescript
22
- import type { LabelListResource } from '@digital8/lighting-illusions-ts-sdk'
23
-
24
- // TODO: Update the object below with actual values
25
- const example = {
26
- "id": null,
27
- "shortName": null,
28
- "longName": null,
29
- "siteId": null,
30
- "colour": null,
31
- "textColour": null,
32
- "startDate": null,
33
- "endDate": null,
34
- "site": null,
35
- } satisfies LabelListResource
36
-
37
- console.log(example)
38
-
39
- // Convert the instance to a JSON string
40
- const exampleJSON: string = JSON.stringify(example)
41
- console.log(exampleJSON)
42
-
43
- // Parse the JSON string back to an object
44
- const exampleParsed = JSON.parse(exampleJSON) as LabelListResource
45
- console.log(exampleParsed)
46
- ```
47
-
48
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
49
-
50
-
@@ -1,48 +0,0 @@
1
-
2
- # StoreLabelRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `siteId` | number
10
- `shortName` | string
11
- `longName` | string
12
- `cartButtonText` | string
13
- `colour` | string
14
- `textColour` | string
15
- `startDate` | Date
16
- `endDate` | Date
17
-
18
- ## Example
19
-
20
- ```typescript
21
- import type { StoreLabelRequest } from '@digital8/lighting-illusions-ts-sdk'
22
-
23
- // TODO: Update the object below with actual values
24
- const example = {
25
- "siteId": null,
26
- "shortName": null,
27
- "longName": null,
28
- "cartButtonText": null,
29
- "colour": null,
30
- "textColour": null,
31
- "startDate": null,
32
- "endDate": null,
33
- } satisfies StoreLabelRequest
34
-
35
- console.log(example)
36
-
37
- // Convert the instance to a JSON string
38
- const exampleJSON: string = JSON.stringify(example)
39
- console.log(exampleJSON)
40
-
41
- // Parse the JSON string back to an object
42
- const exampleParsed = JSON.parse(exampleJSON) as StoreLabelRequest
43
- console.log(exampleParsed)
44
- ```
45
-
46
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
47
-
48
-
@@ -1,48 +0,0 @@
1
-
2
- # UpdateLabelRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `siteId` | number
10
- `shortName` | string
11
- `longName` | string
12
- `cartButtonText` | string
13
- `colour` | string
14
- `textColour` | string
15
- `startDate` | Date
16
- `endDate` | Date
17
-
18
- ## Example
19
-
20
- ```typescript
21
- import type { UpdateLabelRequest } from '@digital8/lighting-illusions-ts-sdk'
22
-
23
- // TODO: Update the object below with actual values
24
- const example = {
25
- "siteId": null,
26
- "shortName": null,
27
- "longName": null,
28
- "cartButtonText": null,
29
- "colour": null,
30
- "textColour": null,
31
- "startDate": null,
32
- "endDate": null,
33
- } satisfies UpdateLabelRequest
34
-
35
- console.log(example)
36
-
37
- // Convert the instance to a JSON string
38
- const exampleJSON: string = JSON.stringify(example)
39
- console.log(exampleJSON)
40
-
41
- // Parse the JSON string back to an object
42
- const exampleParsed = JSON.parse(exampleJSON) as UpdateLabelRequest
43
- console.log(exampleParsed)
44
- ```
45
-
46
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
47
-
48
-