@digital8/lighting-illusions-ts-sdk 0.0.640 → 0.0.642

package/dist/models/UpdateDefinitionRequest.js

@@ -1,55 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * My API
- * API documentation for my Laravel app
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOfUpdateDefinitionRequest = instanceOfUpdateDefinitionRequest;
-exports.UpdateDefinitionRequestFromJSON = UpdateDefinitionRequestFromJSON;
-exports.UpdateDefinitionRequestFromJSONTyped = UpdateDefinitionRequestFromJSONTyped;
-exports.UpdateDefinitionRequestToJSON = UpdateDefinitionRequestToJSON;
-exports.UpdateDefinitionRequestToJSONTyped = UpdateDefinitionRequestToJSONTyped;
-/**
- * Check if a given object implements the UpdateDefinitionRequest interface.
- */
-function instanceOfUpdateDefinitionRequest(value) {
-    if (!('name' in value) || value['name'] === undefined)
-        return false;
-    if (!('content' in value) || value['content'] === undefined)
-        return false;
-    return true;
-}
-function UpdateDefinitionRequestFromJSON(json) {
-    return UpdateDefinitionRequestFromJSONTyped(json, false);
-}
-function UpdateDefinitionRequestFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'name': json['name'],
-        'content': json['content'],
-    };
-}
-function UpdateDefinitionRequestToJSON(json) {
-    return UpdateDefinitionRequestToJSONTyped(json, false);
-}
-function UpdateDefinitionRequestToJSONTyped(value, ignoreDiscriminator) {
-    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
-    if (value == null) {
-        return value;
-    }
-    return {
-        'name': value['name'],
-        'content': value['content'],
-    };
-}

package/docs/AssetFrontendResource.md

@@ -1,48 +0,0 @@
-
-# AssetFrontendResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`filePath` | string
-`fileName` | string
-`altText` | string
-`index` | number
-`isThumbnail` | boolean
-`isLifestyle` | boolean
-`overlays` | object
-
-## Example
-
-```typescript
-import type { AssetFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "filePath": null,
-  "fileName": null,
-  "altText": null,
-  "index": null,
-  "isThumbnail": null,
-  "isLifestyle": null,
-  "overlays": null,
-} satisfies AssetFrontendResource
-
-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 AssetFrontendResource
-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/AssetFrontendResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# AssetFrontendResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<AssetFrontendResource>](AssetFrontendResource.md)
-
-## Example
-
-```typescript
-import type { AssetFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies AssetFrontendResourceArrayResponse
-
-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 AssetFrontendResourceArrayResponse
-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/CategoryFrontendResource.md

@@ -1,46 +0,0 @@
-
-# CategoryFrontendResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`slug` | string
-`parentId` | string
-`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
-`seo` | object
-`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
-
-## Example
-
-```typescript
-import type { CategoryFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "slug": null,
-  "parentId": null,
-  "thumbnail": null,
-  "seo": null,
-  "descriptions": null,
-} satisfies CategoryFrontendResource
-
-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 CategoryFrontendResource
-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/CategoryFrontendResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# CategoryFrontendResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<CategoryFrontendResource>](CategoryFrontendResource.md)
-
-## Example
-
-```typescript
-import type { CategoryFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies CategoryFrontendResourceArrayResponse
-
-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 CategoryFrontendResourceArrayResponse
-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/CategoryWithChildrenFrontendResource.md

@@ -1,36 +0,0 @@
-
-# CategoryWithChildrenFrontendResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`category` | [CategoryFrontendResource](CategoryFrontendResource.md)
-`children` | [Array<CategoryFrontendResource>](CategoryFrontendResource.md)
-
-## Example
-
-```typescript
-import type { CategoryWithChildrenFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "category": null,
-  "children": null,
-} satisfies CategoryWithChildrenFrontendResource
-
-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 CategoryWithChildrenFrontendResource
-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/CategoryWithChildrenFrontendResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# CategoryWithChildrenFrontendResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<CategoryWithChildrenFrontendResource>](CategoryWithChildrenFrontendResource.md)
-
-## Example
-
-```typescript
-import type { CategoryWithChildrenFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies CategoryWithChildrenFrontendResourceArrayResponse
-
-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 CategoryWithChildrenFrontendResourceArrayResponse
-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/DefinitionApi.md

@@ -1,407 +0,0 @@
-# DefinitionApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyDefinition**](DefinitionApi.md#destroydefinition) | **DELETE** /admin-api/definition/{definition}/delete | Auto-generated: destroyDefinition |
-| [**getAllDefinition**](DefinitionApi.md#getalldefinitionoperation) | **POST** /admin-api/definition/all | Auto-generated: getAllDefinition |
-| [**indexDefinition**](DefinitionApi.md#indexdefinitionoperation) | **POST** /admin-api/definition/list | Auto-generated: indexDefinition |
-| [**showDefinition**](DefinitionApi.md#showdefinition) | **GET** /admin-api/definition/{definition} | Auto-generated: showDefinition |
-| [**storeDefinition**](DefinitionApi.md#storedefinitionoperation) | **POST** /admin-api/definition/create | Auto-generated: storeDefinition |
-| [**updateDefinition**](DefinitionApi.md#updatedefinitionoperation) | **PUT** /admin-api/definition/{definition}/update | Auto-generated: updateDefinition |
-
-
-
-## destroyDefinition
-
-> GenericResponse destroyDefinition(definition)
-
-Auto-generated: destroyDefinition
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DefinitionApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DefinitionApi();
-
-  const body = {
-    // number | The id of the definition
-    definition: 56,
-  } satisfies DestroyDefinitionRequest;
-
-  try {
-    const data = await api.destroyDefinition(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **definition** | `number` | The id of the definition | [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** | \\JsonResponse |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## getAllDefinition
-
-> DefinitionListResourceArrayResponse getAllDefinition(getAllDefinitionRequest)
-
-Auto-generated: getAllDefinition
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DefinitionApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DefinitionApi();
-
-  const body = {
-    // GetAllDefinitionRequest (optional)
-    getAllDefinitionRequest: ...,
-  } satisfies GetAllDefinitionOperationRequest;
-
-  try {
-    const data = await api.getAllDefinition(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllDefinitionRequest** | [GetAllDefinitionRequest](GetAllDefinitionRequest.md) |  | [Optional] |
-
-### Return type
-
-[**DefinitionListResourceArrayResponse**](DefinitionListResourceArrayResponse.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)
-
-
-## indexDefinition
-
-> PaginatedDefinitionListResourceResponse indexDefinition(indexDefinitionRequest)
-
-Auto-generated: indexDefinition
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DefinitionApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DefinitionApi();
-
-  const body = {
-    // IndexDefinitionRequest (optional)
-    indexDefinitionRequest: ...,
-  } satisfies IndexDefinitionOperationRequest;
-
-  try {
-    const data = await api.indexDefinition(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexDefinitionRequest** | [IndexDefinitionRequest](IndexDefinitionRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedDefinitionListResourceResponse**](PaginatedDefinitionListResourceResponse.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<\\DefinitionListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## showDefinition
-
-> DefinitionResource showDefinition(definition)
-
-Auto-generated: showDefinition
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DefinitionApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DefinitionApi();
-
-  const body = {
-    // number | The id of the definition
-    definition: 56,
-  } satisfies ShowDefinitionRequest;
-
-  try {
-    const data = await api.showDefinition(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **definition** | `number` | The id of the definition | [Defaults to `undefined`] |
-
-### Return type
-
-[**DefinitionResource**](DefinitionResource.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)
-
-
-## storeDefinition
-
-> DefinitionResource storeDefinition(storeDefinitionRequest)
-
-Auto-generated: storeDefinition
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DefinitionApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DefinitionApi();
-
-  const body = {
-    // StoreDefinitionRequest (optional)
-    storeDefinitionRequest: ...,
-  } satisfies StoreDefinitionOperationRequest;
-
-  try {
-    const data = await api.storeDefinition(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeDefinitionRequest** | [StoreDefinitionRequest](StoreDefinitionRequest.md) |  | [Optional] |
-
-### Return type
-
-[**DefinitionResource**](DefinitionResource.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)
-
-
-## updateDefinition
-
-> DefinitionResource updateDefinition(definition, updateDefinitionRequest)
-
-Auto-generated: updateDefinition
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DefinitionApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DefinitionApi();
-
-  const body = {
-    // number | The id of the definition
-    definition: 56,
-    // UpdateDefinitionRequest (optional)
-    updateDefinitionRequest: ...,
-  } satisfies UpdateDefinitionOperationRequest;
-
-  try {
-    const data = await api.updateDefinition(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **definition** | `number` | The id of the definition | [Defaults to `undefined`] |
-| **updateDefinitionRequest** | [UpdateDefinitionRequest](UpdateDefinitionRequest.md) |  | [Optional] |
-
-### Return type
-
-[**DefinitionResource**](DefinitionResource.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)
-