@digital8/lighting-illusions-ts-sdk 0.0.470 → 0.0.472

package/docs/ProductTypeLiteResource.md

@@ -0,0 +1,38 @@
+
+# ProductTypeLiteResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`fieldType` | string
+
+## Example
+
+```typescript
+import type { ProductTypeLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "fieldType": null,
+} satisfies ProductTypeLiteResource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProductTypeLiteResource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ProductTypeLiteResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# ProductTypeLiteResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ProductTypeLiteResource>](ProductTypeLiteResource.md)
+
+## Example
+
+```typescript
+import type { ProductTypeLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies ProductTypeLiteResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProductTypeLiteResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ProductTypeResource.md

@@ -0,0 +1,48 @@
+
+# ProductTypeResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`totalAttributes` | number
+`performanceAttributes` | [Array<AttributeProductTypeRelationResource>](AttributeProductTypeRelationResource.md)
+`dimensionAttributes` | [Array<AttributeProductTypeRelationResource>](AttributeProductTypeRelationResource.md)
+`specificationAttributes` | [Array<AttributeProductTypeRelationResource>](AttributeProductTypeRelationResource.md)
+`otherAttributes` | [Array<AttributeProductTypeRelationResource>](AttributeProductTypeRelationResource.md)
+`productChildren` | object
+
+## Example
+
+```typescript
+import type { ProductTypeResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "totalAttributes": null,
+  "performanceAttributes": null,
+  "dimensionAttributes": null,
+  "specificationAttributes": null,
+  "otherAttributes": null,
+  "productChildren": null,
+} satisfies ProductTypeResource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProductTypeResource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ProductTypeResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# ProductTypeResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ProductTypeResource>](ProductTypeResource.md)
+
+## Example
+
+```typescript
+import type { ProductTypeResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies ProductTypeResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProductTypeResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SEOResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# SEOResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<SEOResource>](SEOResource.md)
+
+## Example
+
+```typescript
+import type { SEOResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies SEOResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SEOResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SiteApi.md

@@ -5,8 +5,10 @@ All URIs are relative to *http://localhost/api*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**destroySiteNotification**](SiteApi.md#destroysitenotification) | **DELETE** /admin-api/site/notification/{siteNotification}/delete | Auto-generated: destroySiteNotification |
+| [**getAllSite**](SiteApi.md#getallsite) | **POST** /admin-api/site/all | Auto-generated: getAllSite |
 | [**indexSite**](SiteApi.md#indexsiteoperation) | **POST** /admin-api/site/list | Auto-generated: indexSite |
 | [**indexSiteNotification**](SiteApi.md#indexsitenotificationoperation) | **POST** /admin-api/site/notification/list | Auto-generated: indexSiteNotification |
+| [**showSite**](SiteApi.md#showsite) | **GET** /admin-api/site/{site} | Auto-generated: showSite |
 | [**storeSiteNotification**](SiteApi.md#storesitenotificationoperation) | **POST** /admin-api/site/notification/create | Auto-generated: storeSiteNotification |
 | [**updateSite**](SiteApi.md#updatesiteoperation) | **PUT** /admin-api/site/{site}/update | Auto-generated: updateSite |
 | [**updateSiteNotification**](SiteApi.md#updatesitenotificationoperation) | **PUT** /admin-api/site/notification/{siteNotification}/update | Auto-generated: updateSiteNotification |
@@ -78,9 +80,74 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getAllSite
+
+> SiteLiteResourceArrayResponse getAllSite(indexSiteRequest)
+
+Auto-generated: getAllSite
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SiteApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllSiteRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new SiteApi();
+
+  const body = {
+    // IndexSiteRequest (optional)
+    indexSiteRequest: ...,
+  } satisfies GetAllSiteRequest;
+
+  try {
+    const data = await api.getAllSite(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexSiteRequest** | [IndexSiteRequest](IndexSiteRequest.md) |  | [Optional] |
+
+### Return type
+
+[**SiteLiteResourceArrayResponse**](SiteLiteResourceArrayResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## indexSite
 
-> PaginatedSiteResourceResponse indexSite(indexSiteRequest)
+> PaginatedSiteListResourceResponse indexSite(indexSiteRequest)
 
 Auto-generated: indexSite
 
@@ -123,7 +190,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**PaginatedSiteResourceResponse**](PaginatedSiteResourceResponse.md)
+[**PaginatedSiteListResourceResponse**](PaginatedSiteListResourceResponse.md)
 
 ### Authorization
 
@@ -138,14 +205,14 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Paginated response |  -  |
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\SiteListResource[]>> |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
 ## indexSiteNotification
 
-> PaginatedSiteNotificationResourceResponse indexSiteNotification(indexSiteNotificationRequest)
+> PaginatedSiteNotificationListResourceResponse indexSiteNotification(indexSiteNotificationRequest)
 
 Auto-generated: indexSiteNotification
 
@@ -188,7 +255,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**PaginatedSiteNotificationResourceResponse**](PaginatedSiteNotificationResourceResponse.md)
+[**PaginatedSiteNotificationListResourceResponse**](PaginatedSiteNotificationListResourceResponse.md)
 
 ### Authorization
 
@@ -203,7 +270,72 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Paginated response |  -  |
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\SiteNotificationListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showSite
+
+> SiteResource showSite(site)
+
+Auto-generated: showSite
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SiteApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowSiteRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new SiteApi();
+
+  const body = {
+    // number | The id of the site
+    site: 56,
+  } satisfies ShowSiteRequest;
+
+  try {
+    const data = await api.showSite(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **site** | `number` | The id of the site | [Defaults to `undefined`] |
+
+### Return type
+
+[**SiteResource**](SiteResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 

package/docs/SiteConfigResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# SiteConfigResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<SiteConfigResource>](SiteConfigResource.md)
+
+## Example
+
+```typescript
+import type { SiteConfigResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies SiteConfigResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteConfigResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SiteListResource.md

@@ -0,0 +1,40 @@
+
+# SiteListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`abbreviation` | string
+`domain` | string
+
+## Example
+
+```typescript
+import type { SiteListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "abbreviation": null,
+  "domain": null,
+} satisfies SiteListResource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteListResource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SiteListResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# SiteListResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<SiteListResource>](SiteListResource.md)
+
+## Example
+
+```typescript
+import type { SiteListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies SiteListResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteListResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SiteLiteResource.md

@@ -0,0 +1,40 @@
+
+# SiteLiteResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`abbreviation` | string
+`domain` | string
+
+## Example
+
+```typescript
+import type { SiteLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "abbreviation": null,
+  "domain": null,
+} satisfies SiteLiteResource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteLiteResource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SiteLiteResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# SiteLiteResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<SiteLiteResource>](SiteLiteResource.md)
+
+## Example
+
+```typescript
+import type { SiteLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies SiteLiteResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteLiteResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SiteNotificationListResource.md

@@ -0,0 +1,52 @@
+
+# SiteNotificationListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`heading` | string
+`type` | string
+`isActive` | boolean
+`startDate` | string
+`endDate` | string
+`text` | string
+`textColour` | string
+`backgroundColour` | string
+`sites` | [SiteLiteResource](SiteLiteResource.md)
+
+## Example
+
+```typescript
+import type { SiteNotificationListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "heading": null,
+  "type": null,
+  "isActive": null,
+  "startDate": null,
+  "endDate": null,
+  "text": null,
+  "textColour": null,
+  "backgroundColour": null,
+  "sites": null,
+} satisfies SiteNotificationListResource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteNotificationListResource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SiteNotificationListResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# SiteNotificationListResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<SiteNotificationListResource>](SiteNotificationListResource.md)
+
+## Example
+
+```typescript
+import type { SiteNotificationListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies SiteNotificationListResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteNotificationListResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SiteNotificationResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# SiteNotificationResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<SiteNotificationResource>](SiteNotificationResource.md)
+
+## Example
+
+```typescript
+import type { SiteNotificationResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies SiteNotificationResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteNotificationResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+