@digital8/lighting-illusions-ts-sdk 0.0.473 → 0.0.474
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.
- package/.openapi-generator/FILES +72 -10
- package/README.md +56 -20
- package/dist/apis/AttributeApi.d.ts +33 -33
- package/dist/apis/AttributeApi.js +92 -92
- package/dist/apis/OverlayTemplateApi.d.ts +39 -39
- package/dist/apis/OverlayTemplateApi.js +110 -110
- package/dist/apis/ProductApi.d.ts +78 -17
- package/dist/apis/ProductApi.js +271 -24
- package/dist/apis/ProductTypeApi.d.ts +33 -33
- package/dist/apis/ProductTypeApi.js +89 -89
- package/dist/apis/SiteApi.d.ts +5 -5
- package/dist/apis/SiteApi.js +2 -2
- package/dist/apis/SupplierApi.d.ts +3 -3
- package/dist/apis/SupplierApi.js +1 -1
- package/dist/apis/TagApi.d.ts +27 -27
- package/dist/apis/TagApi.js +81 -81
- package/dist/models/AssetLiteResource.d.ts +6 -0
- package/dist/models/AssetLiteResource.js +4 -0
- package/dist/models/AttachAccessoriesProductChildRequest.d.ts +32 -0
- package/dist/models/AttachAccessoriesProductChildRequest.js +51 -0
- package/dist/models/AttachAssetsOverlayTemplateRequest.d.ts +32 -0
- package/dist/models/AttachAssetsOverlayTemplateRequest.js +51 -0
- package/dist/models/AttachAttributeProductTypeRequest.d.ts +48 -0
- package/dist/models/AttachAttributeProductTypeRequest.js +65 -0
- package/dist/models/AttachProductTypeAttributeRequest.d.ts +48 -0
- package/dist/models/AttachProductTypeAttributeRequest.js +65 -0
- package/dist/models/AttributeListResource.d.ts +56 -0
- package/dist/models/AttributeListResource.js +67 -0
- package/dist/models/AttributeListResourceArrayResponse.d.ts +33 -0
- package/dist/models/AttributeListResourceArrayResponse.js +50 -0
- package/dist/models/DetachAssetableOverlayTemplateRequest.d.ts +51 -0
- package/dist/models/DetachAssetableOverlayTemplateRequest.js +64 -0
- package/dist/models/ExternalApiLogListResource.d.ts +56 -0
- package/dist/models/ExternalApiLogListResource.js +63 -0
- package/dist/models/ExternalApiLogListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ExternalApiLogListResourceArrayResponse.js +50 -0
- package/dist/models/GetAllAttributeRequest.d.ts +15 -9
- package/dist/models/GetAllAttributeRequest.js +6 -4
- package/dist/models/GetAllOverlayTemplateRequest.d.ts +12 -6
- package/dist/models/GetAllOverlayTemplateRequest.js +4 -2
- package/dist/models/GetAllProductChildRequest.d.ts +6 -0
- package/dist/models/GetAllProductChildRequest.js +2 -0
- package/dist/models/GetAllProductRequest.d.ts +36 -0
- package/dist/models/GetAllProductRequest.js +12 -0
- package/dist/models/GetAllProductTypeRequest.d.ts +6 -0
- package/dist/models/GetAllProductTypeRequest.js +2 -0
- package/dist/models/GetAllSupplierRequest.d.ts +6 -0
- package/dist/models/GetAllSupplierRequest.js +2 -0
- package/dist/models/IndexAttributeRequest.d.ts +25 -0
- package/dist/models/IndexAttributeRequest.js +13 -1
- package/dist/models/IndexExternalApiLogRequest.d.ts +21 -3
- package/dist/models/IndexExternalApiLogRequest.js +10 -4
- package/dist/models/IndexOverlayTemplateRequest.d.ts +25 -0
- package/dist/models/IndexOverlayTemplateRequest.js +13 -1
- package/dist/models/IndexProductChildRequest.d.ts +6 -0
- package/dist/models/IndexProductChildRequest.js +2 -0
- package/dist/models/IndexProductRequest.d.ts +130 -0
- package/dist/models/IndexProductRequest.js +97 -0
- package/dist/models/IndexProductTypeRequest.d.ts +25 -0
- package/dist/models/IndexProductTypeRequest.js +13 -1
- package/dist/models/IndexSiteNotificationRequest.d.ts +18 -0
- package/dist/models/IndexSiteNotificationRequest.js +6 -0
- package/dist/models/IndexSiteRequest.d.ts +18 -0
- package/dist/models/IndexSiteRequest.js +6 -0
- package/dist/models/IndexSupplierRequest.d.ts +25 -0
- package/dist/models/IndexSupplierRequest.js +13 -1
- package/dist/models/IndexTagRequest.d.ts +25 -0
- package/dist/models/IndexTagRequest.js +13 -1
- package/dist/models/OverlayTemplateListResource.d.ts +45 -0
- package/dist/models/OverlayTemplateListResource.js +60 -0
- package/dist/models/OverlayTemplateListResourceArrayResponse.d.ts +33 -0
- package/dist/models/OverlayTemplateListResourceArrayResponse.js +50 -0
- package/dist/models/PaginatedAttributeListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedAttributeListResourceResponse.js +57 -0
- package/dist/models/PaginatedExternalApiLogListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedExternalApiLogListResourceResponse.js +57 -0
- package/dist/models/PaginatedOverlayTemplateListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedOverlayTemplateListResourceResponse.js +57 -0
- package/dist/models/PaginatedProductChildListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedProductChildListResourceResponse.js +57 -0
- package/dist/models/PaginatedProductListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedProductListResourceResponse.js +57 -0
- package/dist/models/PaginatedProductTypeListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedProductTypeListResourceResponse.js +57 -0
- package/dist/models/PaginatedSiteListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedSiteListResourceResponse.js +57 -0
- package/dist/models/PaginatedSiteNotificationListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedSiteNotificationListResourceResponse.js +57 -0
- package/dist/models/PaginatedSupplierListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedSupplierListResourceResponse.js +57 -0
- package/dist/models/PaginatedTagListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedTagListResourceResponse.js +57 -0
- package/dist/models/ProductChildListResource.d.ts +63 -0
- package/dist/models/ProductChildListResource.js +72 -0
- package/dist/models/ProductChildListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ProductChildListResourceArrayResponse.js +50 -0
- package/dist/models/ProductListResource.d.ts +38 -0
- package/dist/models/ProductListResource.js +55 -0
- package/dist/models/ProductListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ProductListResourceArrayResponse.js +50 -0
- package/dist/models/ProductTypeListResource.d.ts +44 -0
- package/dist/models/ProductTypeListResource.js +59 -0
- package/dist/models/ProductTypeListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ProductTypeListResourceArrayResponse.js +50 -0
- package/dist/models/SiteListResource.d.ts +50 -0
- package/dist/models/SiteListResource.js +63 -0
- package/dist/models/SiteListResourceArrayResponse.d.ts +33 -0
- package/dist/models/SiteListResourceArrayResponse.js +50 -0
- package/dist/models/SiteNotificationListResource.d.ts +87 -0
- package/dist/models/SiteNotificationListResource.js +84 -0
- package/dist/models/SiteNotificationListResourceArrayResponse.d.ts +33 -0
- package/dist/models/SiteNotificationListResourceArrayResponse.js +50 -0
- package/dist/models/SupplierListResource.d.ts +57 -0
- package/dist/models/SupplierListResource.js +68 -0
- package/dist/models/SupplierListResourceArrayResponse.d.ts +33 -0
- package/dist/models/SupplierListResourceArrayResponse.js +50 -0
- package/dist/models/TagListResource.d.ts +57 -0
- package/dist/models/TagListResource.js +68 -0
- package/dist/models/TagListResourceArrayResponse.d.ts +33 -0
- package/dist/models/TagListResourceArrayResponse.js +50 -0
- package/dist/models/index.d.ts +36 -5
- package/dist/models/index.js +36 -5
- package/docs/AssetLiteResource.md +2 -0
- package/docs/{LinkProductChildrenTagRequest.md → AttachAccessoriesProductChildRequest.md} +4 -4
- package/docs/{LinkAssetsOverlayTemplateRequest.md → AttachAssetsOverlayTemplateRequest.md} +4 -4
- package/docs/{LinkAttributeProductTypeRequest.md → AttachAttributeProductTypeRequest.md} +4 -4
- package/docs/{LinkProductTypeAttributeRequest.md → AttachProductTypeAttributeRequest.md} +4 -4
- package/docs/AttributeApi.md +117 -117
- package/docs/AttributeListResource.md +42 -0
- package/docs/AttributeListResourceArrayResponse.md +34 -0
- package/docs/{UnlinkAssetableOverlayTemplateRequest.md → DetachAssetableOverlayTemplateRequest.md} +6 -4
- package/docs/ExternalApiLogListResource.md +42 -0
- package/docs/ExternalApiLogListResourceArrayResponse.md +34 -0
- package/docs/GetAllAttributeRequest.md +6 -4
- package/docs/GetAllOverlayTemplateRequest.md +4 -2
- package/docs/GetAllProductChildRequest.md +2 -0
- package/docs/GetAllProductRequest.md +12 -0
- package/docs/GetAllProductTypeRequest.md +2 -0
- package/docs/GetAllSupplierRequest.md +2 -0
- package/docs/IndexAttributeRequest.md +6 -0
- package/docs/IndexExternalApiLogRequest.md +10 -4
- package/docs/IndexOverlayTemplateRequest.md +6 -0
- package/docs/IndexProductChildRequest.md +2 -0
- package/docs/IndexProductRequest.md +58 -0
- package/docs/IndexProductTypeRequest.md +6 -0
- package/docs/IndexSiteNotificationRequest.md +6 -0
- package/docs/IndexSiteRequest.md +6 -0
- package/docs/IndexSupplierRequest.md +6 -0
- package/docs/IndexTagRequest.md +6 -0
- package/docs/OverlayTemplateApi.md +115 -115
- package/docs/OverlayTemplateListResource.md +38 -0
- package/docs/OverlayTemplateListResourceArrayResponse.md +34 -0
- package/docs/PaginatedAttributeListResourceResponse.md +36 -0
- package/docs/PaginatedExternalApiLogListResourceResponse.md +36 -0
- package/docs/PaginatedOverlayTemplateListResourceResponse.md +36 -0
- package/docs/PaginatedProductChildListResourceResponse.md +36 -0
- package/docs/PaginatedProductListResourceResponse.md +36 -0
- package/docs/PaginatedProductTypeListResourceResponse.md +36 -0
- package/docs/PaginatedSiteListResourceResponse.md +36 -0
- package/docs/PaginatedSiteNotificationListResourceResponse.md +36 -0
- package/docs/PaginatedSupplierListResourceResponse.md +36 -0
- package/docs/PaginatedTagListResourceResponse.md +36 -0
- package/docs/ProductApi.md +377 -29
- package/docs/ProductChildListResource.md +44 -0
- package/docs/ProductChildListResourceArrayResponse.md +34 -0
- package/docs/ProductListResource.md +36 -0
- package/docs/ProductListResourceArrayResponse.md +34 -0
- package/docs/ProductTypeApi.md +94 -94
- package/docs/ProductTypeListResource.md +38 -0
- package/docs/ProductTypeListResourceArrayResponse.md +34 -0
- package/docs/SiteApi.md +6 -6
- package/docs/SiteListResource.md +40 -0
- package/docs/SiteListResourceArrayResponse.md +34 -0
- package/docs/SiteNotificationListResource.md +52 -0
- package/docs/SiteNotificationListResourceArrayResponse.md +34 -0
- package/docs/SupplierApi.md +3 -3
- package/docs/SupplierListResource.md +42 -0
- package/docs/SupplierListResourceArrayResponse.md +34 -0
- package/docs/TagApi.md +84 -84
- package/docs/TagListResource.md +42 -0
- package/docs/TagListResourceArrayResponse.md +34 -0
- package/package.json +1 -1
- package/src/apis/AttributeApi.ts +108 -108
- package/src/apis/OverlayTemplateApi.ts +141 -141
- package/src/apis/ProductApi.ts +282 -32
- package/src/apis/ProductTypeApi.ts +104 -104
- package/src/apis/SiteApi.ts +12 -12
- package/src/apis/SupplierApi.ts +6 -6
- package/src/apis/TagApi.ts +94 -94
- package/src/models/AssetLiteResource.ts +9 -0
- package/src/models/AttachAccessoriesProductChildRequest.ts +66 -0
- package/src/models/AttachAssetsOverlayTemplateRequest.ts +66 -0
- package/src/models/AttachAttributeProductTypeRequest.ts +88 -0
- package/src/models/AttachProductTypeAttributeRequest.ts +88 -0
- package/src/models/AttributeListResource.ts +102 -0
- package/src/models/AttributeListResourceArrayResponse.ts +73 -0
- package/src/models/DetachAssetableOverlayTemplateRequest.ts +93 -0
- package/src/models/ExternalApiLogListResource.ts +100 -0
- package/src/models/ExternalApiLogListResourceArrayResponse.ts +73 -0
- package/src/models/GetAllAttributeRequest.ts +21 -13
- package/src/models/GetAllOverlayTemplateRequest.ts +16 -8
- package/src/models/GetAllProductChildRequest.ts +8 -0
- package/src/models/GetAllProductRequest.ts +48 -0
- package/src/models/GetAllProductTypeRequest.ts +8 -0
- package/src/models/GetAllSupplierRequest.ts +8 -0
- package/src/models/IndexAttributeRequest.ts +32 -0
- package/src/models/IndexExternalApiLogRequest.ts +31 -7
- package/src/models/IndexOverlayTemplateRequest.ts +32 -0
- package/src/models/IndexProductChildRequest.ts +8 -0
- package/src/models/IndexProductRequest.ts +192 -0
- package/src/models/IndexProductTypeRequest.ts +32 -0
- package/src/models/IndexSiteNotificationRequest.ts +24 -0
- package/src/models/IndexSiteRequest.ts +24 -0
- package/src/models/IndexSupplierRequest.ts +32 -0
- package/src/models/IndexTagRequest.ts +32 -0
- package/src/models/OverlayTemplateListResource.ts +92 -0
- package/src/models/OverlayTemplateListResourceArrayResponse.ts +73 -0
- package/src/models/PaginatedAttributeListResourceResponse.ts +90 -0
- package/src/models/PaginatedExternalApiLogListResourceResponse.ts +90 -0
- package/src/models/PaginatedOverlayTemplateListResourceResponse.ts +90 -0
- package/src/models/PaginatedProductChildListResourceResponse.ts +90 -0
- package/src/models/PaginatedProductListResourceResponse.ts +90 -0
- package/src/models/PaginatedProductTypeListResourceResponse.ts +90 -0
- package/src/models/PaginatedSiteListResourceResponse.ts +90 -0
- package/src/models/PaginatedSiteNotificationListResourceResponse.ts +90 -0
- package/src/models/PaginatedSupplierListResourceResponse.ts +90 -0
- package/src/models/PaginatedTagListResourceResponse.ts +90 -0
- package/src/models/ProductChildListResource.ts +119 -0
- package/src/models/ProductChildListResourceArrayResponse.ts +73 -0
- package/src/models/ProductListResource.ts +75 -0
- package/src/models/ProductListResourceArrayResponse.ts +73 -0
- package/src/models/ProductTypeListResource.ts +84 -0
- package/src/models/ProductTypeListResourceArrayResponse.ts +73 -0
- package/src/models/SiteListResource.ts +93 -0
- package/src/models/SiteListResourceArrayResponse.ts +73 -0
- package/src/models/SiteNotificationListResource.ts +153 -0
- package/src/models/SiteNotificationListResourceArrayResponse.ts +73 -0
- package/src/models/SupplierListResource.ts +110 -0
- package/src/models/SupplierListResourceArrayResponse.ts +73 -0
- package/src/models/TagListResource.ts +110 -0
- package/src/models/TagListResourceArrayResponse.ts +73 -0
- package/src/models/index.ts +36 -5
- package/dist/models/LinkAssetsOverlayTemplateRequest.d.ts +0 -32
- package/dist/models/LinkAssetsOverlayTemplateRequest.js +0 -51
- package/dist/models/LinkAttributeProductTypeRequest.d.ts +0 -48
- package/dist/models/LinkAttributeProductTypeRequest.js +0 -65
- package/dist/models/LinkProductChildrenTagRequest.d.ts +0 -32
- package/dist/models/LinkProductChildrenTagRequest.js +0 -51
- package/dist/models/LinkProductTypeAttributeRequest.d.ts +0 -48
- package/dist/models/LinkProductTypeAttributeRequest.js +0 -65
- package/dist/models/UnlinkAssetableOverlayTemplateRequest.d.ts +0 -45
- package/dist/models/UnlinkAssetableOverlayTemplateRequest.js +0 -62
- package/src/models/LinkAssetsOverlayTemplateRequest.ts +0 -66
- package/src/models/LinkAttributeProductTypeRequest.ts +0 -88
- package/src/models/LinkProductChildrenTagRequest.ts +0 -66
- package/src/models/LinkProductTypeAttributeRequest.ts +0 -88
- package/src/models/UnlinkAssetableOverlayTemplateRequest.ts +0 -85
package/docs/ProductTypeApi.md
CHANGED
|
@@ -4,23 +4,23 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**attachAttributeProductType**](ProductTypeApi.md#attachattributeproducttypeoperation) | **POST** /admin-api/product-type/{productType}/attach-attribute | Auto-generated: attachAttributeProductType |
|
|
7
8
|
| [**destroyProductType**](ProductTypeApi.md#destroyproducttype) | **DELETE** /admin-api/product-type/{productType}/delete | Auto-generated: destroyProductType |
|
|
9
|
+
| [**detachAttributeProductType**](ProductTypeApi.md#detachattributeproducttype) | **POST** /admin-api/product-type/{productType}/detach-attribute/{attribute} | Auto-generated: detachAttributeProductType |
|
|
8
10
|
| [**getAllProductType**](ProductTypeApi.md#getallproducttypeoperation) | **POST** /admin-api/product-type/all | Auto-generated: getAllProductType |
|
|
9
11
|
| [**indexProductType**](ProductTypeApi.md#indexproducttypeoperation) | **POST** /admin-api/product-type/list | Auto-generated: indexProductType |
|
|
10
|
-
| [**linkAttributeProductType**](ProductTypeApi.md#linkattributeproducttypeoperation) | **POST** /admin-api/product-type/{productType}/link-attribute | Auto-generated: linkAttributeProductType |
|
|
11
12
|
| [**showProductType**](ProductTypeApi.md#showproducttype) | **GET** /admin-api/product-type/{productType} | Auto-generated: showProductType |
|
|
12
13
|
| [**storeProductType**](ProductTypeApi.md#storeproducttypeoperation) | **POST** /admin-api/product-type/create | Auto-generated: storeProductType |
|
|
13
|
-
| [**
|
|
14
|
-
| [**updateLinkedAttributeProductType**](ProductTypeApi.md#updatelinkedattributeproducttype) | **PUT** /admin-api/product-type/{productType}/update-attribute | Auto-generated: updateLinkedAttributeProductType |
|
|
14
|
+
| [**updateAttachedAttributeProductType**](ProductTypeApi.md#updateattachedattributeproducttype) | **PUT** /admin-api/product-type/{productType}/update-attribute | Auto-generated: updateAttachedAttributeProductType |
|
|
15
15
|
| [**updateProductType**](ProductTypeApi.md#updateproducttypeoperation) | **PUT** /admin-api/product-type/{productType}/update | Auto-generated: updateProductType |
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## attachAttributeProductType
|
|
20
20
|
|
|
21
|
-
>
|
|
21
|
+
> ProductTypeResource attachAttributeProductType(productType, attachAttributeProductTypeRequest)
|
|
22
22
|
|
|
23
|
-
Auto-generated:
|
|
23
|
+
Auto-generated: attachAttributeProductType
|
|
24
24
|
|
|
25
25
|
### Example
|
|
26
26
|
|
|
@@ -29,7 +29,7 @@ import {
|
|
|
29
29
|
Configuration,
|
|
30
30
|
ProductTypeApi,
|
|
31
31
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
32
|
-
import type {
|
|
32
|
+
import type { AttachAttributeProductTypeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
33
33
|
|
|
34
34
|
async function example() {
|
|
35
35
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
@@ -38,10 +38,12 @@ async function example() {
|
|
|
38
38
|
const body = {
|
|
39
39
|
// number | The id of the productType
|
|
40
40
|
productType: 56,
|
|
41
|
-
|
|
41
|
+
// AttachAttributeProductTypeRequest (optional)
|
|
42
|
+
attachAttributeProductTypeRequest: ...,
|
|
43
|
+
} satisfies AttachAttributeProductTypeOperationRequest;
|
|
42
44
|
|
|
43
45
|
try {
|
|
44
|
-
const data = await api.
|
|
46
|
+
const data = await api.attachAttributeProductType(body);
|
|
45
47
|
console.log(data);
|
|
46
48
|
} catch (error) {
|
|
47
49
|
console.error(error);
|
|
@@ -58,10 +60,11 @@ example().catch(console.error);
|
|
|
58
60
|
| Name | Type | Description | Notes |
|
|
59
61
|
|------------- | ------------- | ------------- | -------------|
|
|
60
62
|
| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
|
|
63
|
+
| **attachAttributeProductTypeRequest** | [AttachAttributeProductTypeRequest](AttachAttributeProductTypeRequest.md) | | [Optional] |
|
|
61
64
|
|
|
62
65
|
### Return type
|
|
63
66
|
|
|
64
|
-
[**
|
|
67
|
+
[**ProductTypeResource**](ProductTypeResource.md)
|
|
65
68
|
|
|
66
69
|
### Authorization
|
|
67
70
|
|
|
@@ -69,23 +72,23 @@ No authorization required
|
|
|
69
72
|
|
|
70
73
|
### HTTP request headers
|
|
71
74
|
|
|
72
|
-
- **Content-Type**:
|
|
75
|
+
- **Content-Type**: `application/json`
|
|
73
76
|
- **Accept**: `application/json`
|
|
74
77
|
|
|
75
78
|
|
|
76
79
|
### HTTP response details
|
|
77
80
|
| Status code | Description | Response headers |
|
|
78
81
|
|-------------|-------------|------------------|
|
|
79
|
-
| **200** |
|
|
82
|
+
| **200** | Successful resource response | - |
|
|
80
83
|
|
|
81
84
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
82
85
|
|
|
83
86
|
|
|
84
|
-
##
|
|
87
|
+
## destroyProductType
|
|
85
88
|
|
|
86
|
-
>
|
|
89
|
+
> GenericResponse destroyProductType(productType)
|
|
87
90
|
|
|
88
|
-
Auto-generated:
|
|
91
|
+
Auto-generated: destroyProductType
|
|
89
92
|
|
|
90
93
|
### Example
|
|
91
94
|
|
|
@@ -94,19 +97,19 @@ import {
|
|
|
94
97
|
Configuration,
|
|
95
98
|
ProductTypeApi,
|
|
96
99
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
97
|
-
import type {
|
|
100
|
+
import type { DestroyProductTypeRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
98
101
|
|
|
99
102
|
async function example() {
|
|
100
103
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
101
104
|
const api = new ProductTypeApi();
|
|
102
105
|
|
|
103
106
|
const body = {
|
|
104
|
-
//
|
|
105
|
-
|
|
106
|
-
} satisfies
|
|
107
|
+
// number | The id of the productType
|
|
108
|
+
productType: 56,
|
|
109
|
+
} satisfies DestroyProductTypeRequest;
|
|
107
110
|
|
|
108
111
|
try {
|
|
109
|
-
const data = await api.
|
|
112
|
+
const data = await api.destroyProductType(body);
|
|
110
113
|
console.log(data);
|
|
111
114
|
} catch (error) {
|
|
112
115
|
console.error(error);
|
|
@@ -122,11 +125,11 @@ example().catch(console.error);
|
|
|
122
125
|
|
|
123
126
|
| Name | Type | Description | Notes |
|
|
124
127
|
|------------- | ------------- | ------------- | -------------|
|
|
125
|
-
| **
|
|
128
|
+
| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
|
|
126
129
|
|
|
127
130
|
### Return type
|
|
128
131
|
|
|
129
|
-
[**
|
|
132
|
+
[**GenericResponse**](GenericResponse.md)
|
|
130
133
|
|
|
131
134
|
### Authorization
|
|
132
135
|
|
|
@@ -134,23 +137,23 @@ No authorization required
|
|
|
134
137
|
|
|
135
138
|
### HTTP request headers
|
|
136
139
|
|
|
137
|
-
- **Content-Type**:
|
|
140
|
+
- **Content-Type**: Not defined
|
|
138
141
|
- **Accept**: `application/json`
|
|
139
142
|
|
|
140
143
|
|
|
141
144
|
### HTTP response details
|
|
142
145
|
| Status code | Description | Response headers |
|
|
143
146
|
|-------------|-------------|------------------|
|
|
144
|
-
| **200** |
|
|
147
|
+
| **200** | \\JsonResponse | - |
|
|
145
148
|
|
|
146
149
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
147
150
|
|
|
148
151
|
|
|
149
|
-
##
|
|
152
|
+
## detachAttributeProductType
|
|
150
153
|
|
|
151
|
-
>
|
|
154
|
+
> ProductTypeResource detachAttributeProductType(productType, attribute)
|
|
152
155
|
|
|
153
|
-
Auto-generated:
|
|
156
|
+
Auto-generated: detachAttributeProductType
|
|
154
157
|
|
|
155
158
|
### Example
|
|
156
159
|
|
|
@@ -159,19 +162,21 @@ import {
|
|
|
159
162
|
Configuration,
|
|
160
163
|
ProductTypeApi,
|
|
161
164
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
162
|
-
import type {
|
|
165
|
+
import type { DetachAttributeProductTypeRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
163
166
|
|
|
164
167
|
async function example() {
|
|
165
168
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
166
169
|
const api = new ProductTypeApi();
|
|
167
170
|
|
|
168
171
|
const body = {
|
|
169
|
-
//
|
|
170
|
-
|
|
171
|
-
|
|
172
|
+
// number | The id of the productType
|
|
173
|
+
productType: 56,
|
|
174
|
+
// number | The id of the attribute
|
|
175
|
+
attribute: 56,
|
|
176
|
+
} satisfies DetachAttributeProductTypeRequest;
|
|
172
177
|
|
|
173
178
|
try {
|
|
174
|
-
const data = await api.
|
|
179
|
+
const data = await api.detachAttributeProductType(body);
|
|
175
180
|
console.log(data);
|
|
176
181
|
} catch (error) {
|
|
177
182
|
console.error(error);
|
|
@@ -187,11 +192,12 @@ example().catch(console.error);
|
|
|
187
192
|
|
|
188
193
|
| Name | Type | Description | Notes |
|
|
189
194
|
|------------- | ------------- | ------------- | -------------|
|
|
190
|
-
| **
|
|
195
|
+
| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
|
|
196
|
+
| **attribute** | `number` | The id of the attribute | [Defaults to `undefined`] |
|
|
191
197
|
|
|
192
198
|
### Return type
|
|
193
199
|
|
|
194
|
-
[**
|
|
200
|
+
[**ProductTypeResource**](ProductTypeResource.md)
|
|
195
201
|
|
|
196
202
|
### Authorization
|
|
197
203
|
|
|
@@ -199,23 +205,23 @@ No authorization required
|
|
|
199
205
|
|
|
200
206
|
### HTTP request headers
|
|
201
207
|
|
|
202
|
-
- **Content-Type**:
|
|
208
|
+
- **Content-Type**: Not defined
|
|
203
209
|
- **Accept**: `application/json`
|
|
204
210
|
|
|
205
211
|
|
|
206
212
|
### HTTP response details
|
|
207
213
|
| Status code | Description | Response headers |
|
|
208
214
|
|-------------|-------------|------------------|
|
|
209
|
-
| **200** |
|
|
215
|
+
| **200** | Successful resource response | - |
|
|
210
216
|
|
|
211
217
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
212
218
|
|
|
213
219
|
|
|
214
|
-
##
|
|
220
|
+
## getAllProductType
|
|
215
221
|
|
|
216
|
-
>
|
|
222
|
+
> PaginatedProductTypeLiteResourceResponse getAllProductType(getAllProductTypeRequest)
|
|
217
223
|
|
|
218
|
-
Auto-generated:
|
|
224
|
+
Auto-generated: getAllProductType
|
|
219
225
|
|
|
220
226
|
### Example
|
|
221
227
|
|
|
@@ -224,21 +230,19 @@ import {
|
|
|
224
230
|
Configuration,
|
|
225
231
|
ProductTypeApi,
|
|
226
232
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
227
|
-
import type {
|
|
233
|
+
import type { GetAllProductTypeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
228
234
|
|
|
229
235
|
async function example() {
|
|
230
236
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
231
237
|
const api = new ProductTypeApi();
|
|
232
238
|
|
|
233
239
|
const body = {
|
|
234
|
-
//
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
linkAttributeProductTypeRequest: ...,
|
|
238
|
-
} satisfies LinkAttributeProductTypeOperationRequest;
|
|
240
|
+
// GetAllProductTypeRequest (optional)
|
|
241
|
+
getAllProductTypeRequest: ...,
|
|
242
|
+
} satisfies GetAllProductTypeOperationRequest;
|
|
239
243
|
|
|
240
244
|
try {
|
|
241
|
-
const data = await api.
|
|
245
|
+
const data = await api.getAllProductType(body);
|
|
242
246
|
console.log(data);
|
|
243
247
|
} catch (error) {
|
|
244
248
|
console.error(error);
|
|
@@ -254,12 +258,11 @@ example().catch(console.error);
|
|
|
254
258
|
|
|
255
259
|
| Name | Type | Description | Notes |
|
|
256
260
|
|------------- | ------------- | ------------- | -------------|
|
|
257
|
-
| **
|
|
258
|
-
| **linkAttributeProductTypeRequest** | [LinkAttributeProductTypeRequest](LinkAttributeProductTypeRequest.md) | | [Optional] |
|
|
261
|
+
| **getAllProductTypeRequest** | [GetAllProductTypeRequest](GetAllProductTypeRequest.md) | | [Optional] |
|
|
259
262
|
|
|
260
263
|
### Return type
|
|
261
264
|
|
|
262
|
-
[**
|
|
265
|
+
[**PaginatedProductTypeLiteResourceResponse**](PaginatedProductTypeLiteResourceResponse.md)
|
|
263
266
|
|
|
264
267
|
### Authorization
|
|
265
268
|
|
|
@@ -274,16 +277,16 @@ No authorization required
|
|
|
274
277
|
### HTTP response details
|
|
275
278
|
| Status code | Description | Response headers |
|
|
276
279
|
|-------------|-------------|------------------|
|
|
277
|
-
| **200** |
|
|
280
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductTypeLiteResource[]>> | - |
|
|
278
281
|
|
|
279
282
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
280
283
|
|
|
281
284
|
|
|
282
|
-
##
|
|
285
|
+
## indexProductType
|
|
283
286
|
|
|
284
|
-
>
|
|
287
|
+
> PaginatedProductTypeListResourceResponse indexProductType(indexProductTypeRequest)
|
|
285
288
|
|
|
286
|
-
Auto-generated:
|
|
289
|
+
Auto-generated: indexProductType
|
|
287
290
|
|
|
288
291
|
### Example
|
|
289
292
|
|
|
@@ -292,19 +295,19 @@ import {
|
|
|
292
295
|
Configuration,
|
|
293
296
|
ProductTypeApi,
|
|
294
297
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
295
|
-
import type {
|
|
298
|
+
import type { IndexProductTypeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
296
299
|
|
|
297
300
|
async function example() {
|
|
298
301
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
299
302
|
const api = new ProductTypeApi();
|
|
300
303
|
|
|
301
304
|
const body = {
|
|
302
|
-
//
|
|
303
|
-
|
|
304
|
-
} satisfies
|
|
305
|
+
// IndexProductTypeRequest (optional)
|
|
306
|
+
indexProductTypeRequest: ...,
|
|
307
|
+
} satisfies IndexProductTypeOperationRequest;
|
|
305
308
|
|
|
306
309
|
try {
|
|
307
|
-
const data = await api.
|
|
310
|
+
const data = await api.indexProductType(body);
|
|
308
311
|
console.log(data);
|
|
309
312
|
} catch (error) {
|
|
310
313
|
console.error(error);
|
|
@@ -320,11 +323,11 @@ example().catch(console.error);
|
|
|
320
323
|
|
|
321
324
|
| Name | Type | Description | Notes |
|
|
322
325
|
|------------- | ------------- | ------------- | -------------|
|
|
323
|
-
| **
|
|
326
|
+
| **indexProductTypeRequest** | [IndexProductTypeRequest](IndexProductTypeRequest.md) | | [Optional] |
|
|
324
327
|
|
|
325
328
|
### Return type
|
|
326
329
|
|
|
327
|
-
[**
|
|
330
|
+
[**PaginatedProductTypeListResourceResponse**](PaginatedProductTypeListResourceResponse.md)
|
|
328
331
|
|
|
329
332
|
### Authorization
|
|
330
333
|
|
|
@@ -332,23 +335,23 @@ No authorization required
|
|
|
332
335
|
|
|
333
336
|
### HTTP request headers
|
|
334
337
|
|
|
335
|
-
- **Content-Type**:
|
|
338
|
+
- **Content-Type**: `application/json`
|
|
336
339
|
- **Accept**: `application/json`
|
|
337
340
|
|
|
338
341
|
|
|
339
342
|
### HTTP response details
|
|
340
343
|
| Status code | Description | Response headers |
|
|
341
344
|
|-------------|-------------|------------------|
|
|
342
|
-
| **200** |
|
|
345
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductTypeListResource[]>> | - |
|
|
343
346
|
|
|
344
347
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
345
348
|
|
|
346
349
|
|
|
347
|
-
##
|
|
350
|
+
## showProductType
|
|
348
351
|
|
|
349
|
-
> ProductTypeResource
|
|
352
|
+
> ProductTypeResource showProductType(productType)
|
|
350
353
|
|
|
351
|
-
Auto-generated:
|
|
354
|
+
Auto-generated: showProductType
|
|
352
355
|
|
|
353
356
|
### Example
|
|
354
357
|
|
|
@@ -357,19 +360,19 @@ import {
|
|
|
357
360
|
Configuration,
|
|
358
361
|
ProductTypeApi,
|
|
359
362
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
360
|
-
import type {
|
|
363
|
+
import type { ShowProductTypeRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
361
364
|
|
|
362
365
|
async function example() {
|
|
363
366
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
364
367
|
const api = new ProductTypeApi();
|
|
365
368
|
|
|
366
369
|
const body = {
|
|
367
|
-
//
|
|
368
|
-
|
|
369
|
-
} satisfies
|
|
370
|
+
// number | The id of the productType
|
|
371
|
+
productType: 56,
|
|
372
|
+
} satisfies ShowProductTypeRequest;
|
|
370
373
|
|
|
371
374
|
try {
|
|
372
|
-
const data = await api.
|
|
375
|
+
const data = await api.showProductType(body);
|
|
373
376
|
console.log(data);
|
|
374
377
|
} catch (error) {
|
|
375
378
|
console.error(error);
|
|
@@ -385,7 +388,7 @@ example().catch(console.error);
|
|
|
385
388
|
|
|
386
389
|
| Name | Type | Description | Notes |
|
|
387
390
|
|------------- | ------------- | ------------- | -------------|
|
|
388
|
-
| **
|
|
391
|
+
| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
|
|
389
392
|
|
|
390
393
|
### Return type
|
|
391
394
|
|
|
@@ -397,7 +400,7 @@ No authorization required
|
|
|
397
400
|
|
|
398
401
|
### HTTP request headers
|
|
399
402
|
|
|
400
|
-
- **Content-Type**:
|
|
403
|
+
- **Content-Type**: Not defined
|
|
401
404
|
- **Accept**: `application/json`
|
|
402
405
|
|
|
403
406
|
|
|
@@ -409,11 +412,11 @@ No authorization required
|
|
|
409
412
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
410
413
|
|
|
411
414
|
|
|
412
|
-
##
|
|
415
|
+
## storeProductType
|
|
413
416
|
|
|
414
|
-
> ProductTypeResource
|
|
417
|
+
> ProductTypeResource storeProductType(storeProductTypeRequest)
|
|
415
418
|
|
|
416
|
-
Auto-generated:
|
|
419
|
+
Auto-generated: storeProductType
|
|
417
420
|
|
|
418
421
|
### Example
|
|
419
422
|
|
|
@@ -422,21 +425,19 @@ import {
|
|
|
422
425
|
Configuration,
|
|
423
426
|
ProductTypeApi,
|
|
424
427
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
425
|
-
import type {
|
|
428
|
+
import type { StoreProductTypeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
426
429
|
|
|
427
430
|
async function example() {
|
|
428
431
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
429
432
|
const api = new ProductTypeApi();
|
|
430
433
|
|
|
431
434
|
const body = {
|
|
432
|
-
//
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
attribute: 56,
|
|
436
|
-
} satisfies UnlinkAttributeProductTypeRequest;
|
|
435
|
+
// StoreProductTypeRequest (optional)
|
|
436
|
+
storeProductTypeRequest: ...,
|
|
437
|
+
} satisfies StoreProductTypeOperationRequest;
|
|
437
438
|
|
|
438
439
|
try {
|
|
439
|
-
const data = await api.
|
|
440
|
+
const data = await api.storeProductType(body);
|
|
440
441
|
console.log(data);
|
|
441
442
|
} catch (error) {
|
|
442
443
|
console.error(error);
|
|
@@ -452,8 +453,7 @@ example().catch(console.error);
|
|
|
452
453
|
|
|
453
454
|
| Name | Type | Description | Notes |
|
|
454
455
|
|------------- | ------------- | ------------- | -------------|
|
|
455
|
-
| **
|
|
456
|
-
| **attribute** | `number` | The id of the attribute | [Defaults to `undefined`] |
|
|
456
|
+
| **storeProductTypeRequest** | [StoreProductTypeRequest](StoreProductTypeRequest.md) | | [Optional] |
|
|
457
457
|
|
|
458
458
|
### Return type
|
|
459
459
|
|
|
@@ -465,7 +465,7 @@ No authorization required
|
|
|
465
465
|
|
|
466
466
|
### HTTP request headers
|
|
467
467
|
|
|
468
|
-
- **Content-Type**:
|
|
468
|
+
- **Content-Type**: `application/json`
|
|
469
469
|
- **Accept**: `application/json`
|
|
470
470
|
|
|
471
471
|
|
|
@@ -477,11 +477,11 @@ No authorization required
|
|
|
477
477
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
478
478
|
|
|
479
479
|
|
|
480
|
-
##
|
|
480
|
+
## updateAttachedAttributeProductType
|
|
481
481
|
|
|
482
|
-
> ProductTypeResource
|
|
482
|
+
> ProductTypeResource updateAttachedAttributeProductType(productType, attachAttributeProductTypeRequest)
|
|
483
483
|
|
|
484
|
-
Auto-generated:
|
|
484
|
+
Auto-generated: updateAttachedAttributeProductType
|
|
485
485
|
|
|
486
486
|
### Example
|
|
487
487
|
|
|
@@ -490,7 +490,7 @@ import {
|
|
|
490
490
|
Configuration,
|
|
491
491
|
ProductTypeApi,
|
|
492
492
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
493
|
-
import type {
|
|
493
|
+
import type { UpdateAttachedAttributeProductTypeRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
494
494
|
|
|
495
495
|
async function example() {
|
|
496
496
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
@@ -499,12 +499,12 @@ async function example() {
|
|
|
499
499
|
const body = {
|
|
500
500
|
// number | The id of the productType
|
|
501
501
|
productType: 56,
|
|
502
|
-
//
|
|
503
|
-
|
|
504
|
-
} satisfies
|
|
502
|
+
// AttachAttributeProductTypeRequest (optional)
|
|
503
|
+
attachAttributeProductTypeRequest: ...,
|
|
504
|
+
} satisfies UpdateAttachedAttributeProductTypeRequest;
|
|
505
505
|
|
|
506
506
|
try {
|
|
507
|
-
const data = await api.
|
|
507
|
+
const data = await api.updateAttachedAttributeProductType(body);
|
|
508
508
|
console.log(data);
|
|
509
509
|
} catch (error) {
|
|
510
510
|
console.error(error);
|
|
@@ -521,7 +521,7 @@ example().catch(console.error);
|
|
|
521
521
|
| Name | Type | Description | Notes |
|
|
522
522
|
|------------- | ------------- | ------------- | -------------|
|
|
523
523
|
| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
|
|
524
|
-
| **
|
|
524
|
+
| **attachAttributeProductTypeRequest** | [AttachAttributeProductTypeRequest](AttachAttributeProductTypeRequest.md) | | [Optional] |
|
|
525
525
|
|
|
526
526
|
### Return type
|
|
527
527
|
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# ProductTypeListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`totalAttributes` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ProductTypeListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"id": null,
|
|
21
|
+
"name": null,
|
|
22
|
+
"totalAttributes": null,
|
|
23
|
+
} satisfies ProductTypeListResource
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as ProductTypeListResource
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ProductTypeListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ProductTypeListResource>](ProductTypeListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ProductTypeListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ProductTypeListResourceArrayResponse
|
|
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 ProductTypeListResourceArrayResponse
|
|
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/SiteApi.md
CHANGED
|
@@ -147,7 +147,7 @@ No authorization required
|
|
|
147
147
|
|
|
148
148
|
## indexSite
|
|
149
149
|
|
|
150
|
-
>
|
|
150
|
+
> PaginatedSiteListResourceResponse indexSite(indexSiteRequest)
|
|
151
151
|
|
|
152
152
|
Auto-generated: indexSite
|
|
153
153
|
|
|
@@ -190,7 +190,7 @@ example().catch(console.error);
|
|
|
190
190
|
|
|
191
191
|
### Return type
|
|
192
192
|
|
|
193
|
-
[**
|
|
193
|
+
[**PaginatedSiteListResourceResponse**](PaginatedSiteListResourceResponse.md)
|
|
194
194
|
|
|
195
195
|
### Authorization
|
|
196
196
|
|
|
@@ -205,14 +205,14 @@ No authorization required
|
|
|
205
205
|
### HTTP response details
|
|
206
206
|
| Status code | Description | Response headers |
|
|
207
207
|
|-------------|-------------|------------------|
|
|
208
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\
|
|
208
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\SiteListResource[]>> | - |
|
|
209
209
|
|
|
210
210
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
## indexSiteNotification
|
|
214
214
|
|
|
215
|
-
>
|
|
215
|
+
> PaginatedSiteNotificationListResourceResponse indexSiteNotification(indexSiteNotificationRequest)
|
|
216
216
|
|
|
217
217
|
Auto-generated: indexSiteNotification
|
|
218
218
|
|
|
@@ -255,7 +255,7 @@ example().catch(console.error);
|
|
|
255
255
|
|
|
256
256
|
### Return type
|
|
257
257
|
|
|
258
|
-
[**
|
|
258
|
+
[**PaginatedSiteNotificationListResourceResponse**](PaginatedSiteNotificationListResourceResponse.md)
|
|
259
259
|
|
|
260
260
|
### Authorization
|
|
261
261
|
|
|
@@ -270,7 +270,7 @@ No authorization required
|
|
|
270
270
|
### HTTP response details
|
|
271
271
|
| Status code | Description | Response headers |
|
|
272
272
|
|-------------|-------------|------------------|
|
|
273
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\
|
|
273
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\SiteNotificationListResource[]>> | - |
|
|
274
274
|
|
|
275
275
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
276
276
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# SiteListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`abbreviation` | string
|
|
12
|
+
`domain` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { SiteListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"id": null,
|
|
22
|
+
"name": null,
|
|
23
|
+
"abbreviation": null,
|
|
24
|
+
"domain": null,
|
|
25
|
+
} satisfies SiteListResource
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as SiteListResource
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|