@digital8/lighting-illusions-ts-sdk 0.0.1455 → 0.0.1457

package/docs/LabelApi.md

@@ -1,407 +0,0 @@
-# LabelApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyLabel**](LabelApi.md#destroylabel) | **DELETE** /admin-api/label/{label}/delete | Auto-generated: destroyLabel |
-| [**getAllLabel**](LabelApi.md#getalllabel) | **POST** /admin-api/label/all | Auto-generated: getAllLabel |
-| [**indexLabel**](LabelApi.md#indexlabeloperation) | **POST** /admin-api/label/list | Auto-generated: indexLabel |
-| [**showLabel**](LabelApi.md#showlabel) | **GET** /admin-api/label/{label} | Auto-generated: showLabel |
-| [**storeLabel**](LabelApi.md#storelabeloperation) | **POST** /admin-api/label/create | Auto-generated: storeLabel |
-| [**updateLabel**](LabelApi.md#updatelabeloperation) | **PUT** /admin-api/label/{label}/update | Auto-generated: updateLabel |
-
-
-
-## destroyLabel
-
-> GenericResponse destroyLabel(label)
-
-Auto-generated: destroyLabel
-
-### Example
-
-```ts
-import {
-  Configuration,
-  LabelApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyLabelRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new LabelApi();
-
-  const body = {
-    // number | The id of the label
-    label: 56,
-  } satisfies DestroyLabelRequest;
-
-  try {
-    const data = await api.destroyLabel(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **label** | `number` | The id of the label | [Defaults to `undefined`] |
-
-### Return type
-
-[**GenericResponse**](GenericResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Generic JSON success |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## getAllLabel
-
-> GenericResponse getAllLabel(indexLabelRequest)
-
-Auto-generated: getAllLabel
-
-### Example
-
-```ts
-import {
-  Configuration,
-  LabelApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllLabelRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new LabelApi();
-
-  const body = {
-    // IndexLabelRequest (optional)
-    indexLabelRequest: ...,
-  } satisfies GetAllLabelRequest;
-
-  try {
-    const data = await api.getAllLabel(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexLabelRequest** | [IndexLabelRequest](IndexLabelRequest.md) |  | [Optional] |
-
-### Return type
-
-[**GenericResponse**](GenericResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | \\JsonResponse<array{data: \\LabelLiteResource[]}> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## indexLabel
-
-> PaginatedLabelListResourceResponse indexLabel(indexLabelRequest)
-
-Auto-generated: indexLabel
-
-### Example
-
-```ts
-import {
-  Configuration,
-  LabelApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexLabelOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new LabelApi();
-
-  const body = {
-    // IndexLabelRequest (optional)
-    indexLabelRequest: ...,
-  } satisfies IndexLabelOperationRequest;
-
-  try {
-    const data = await api.indexLabel(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexLabelRequest** | [IndexLabelRequest](IndexLabelRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedLabelListResourceResponse**](PaginatedLabelListResourceResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\LabelListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## showLabel
-
-> LabelResource showLabel(label)
-
-Auto-generated: showLabel
-
-### Example
-
-```ts
-import {
-  Configuration,
-  LabelApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowLabelRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new LabelApi();
-
-  const body = {
-    // number | The id of the label
-    label: 56,
-  } satisfies ShowLabelRequest;
-
-  try {
-    const data = await api.showLabel(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **label** | `number` | The id of the label | [Defaults to `undefined`] |
-
-### Return type
-
-[**LabelResource**](LabelResource.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)
-
-
-## storeLabel
-
-> LabelResource storeLabel(storeLabelRequest)
-
-Auto-generated: storeLabel
-
-### Example
-
-```ts
-import {
-  Configuration,
-  LabelApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreLabelOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new LabelApi();
-
-  const body = {
-    // StoreLabelRequest (optional)
-    storeLabelRequest: ...,
-  } satisfies StoreLabelOperationRequest;
-
-  try {
-    const data = await api.storeLabel(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeLabelRequest** | [StoreLabelRequest](StoreLabelRequest.md) |  | [Optional] |
-
-### Return type
-
-[**LabelResource**](LabelResource.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)
-
-
-## updateLabel
-
-> LabelResource updateLabel(label, updateLabelRequest)
-
-Auto-generated: updateLabel
-
-### Example
-
-```ts
-import {
-  Configuration,
-  LabelApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateLabelOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new LabelApi();
-
-  const body = {
-    // number | The id of the label
-    label: 56,
-    // UpdateLabelRequest (optional)
-    updateLabelRequest: ...,
-  } satisfies UpdateLabelOperationRequest;
-
-  try {
-    const data = await api.updateLabel(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **label** | `number` | The id of the label | [Defaults to `undefined`] |
-| **updateLabelRequest** | [UpdateLabelRequest](UpdateLabelRequest.md) |  | [Optional] |
-
-### Return type
-
-[**LabelResource**](LabelResource.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)
-

package/docs/LabelListResource.md

@@ -1,48 +0,0 @@
-
-# LabelListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`shortName` | string
-`longName` | string
-`colour` | string
-`textColour` | string
-`startDate` | string
-`endDate` | string
-`site` | [SiteLiteResource](SiteLiteResource.md)
-
-## Example
-
-```typescript
-import type { LabelListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "shortName": null,
-  "longName": null,
-  "colour": null,
-  "textColour": null,
-  "startDate": null,
-  "endDate": null,
-  "site": null,
-} satisfies LabelListResource
-
-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 LabelListResource
-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)
-
-