@digital8/lighting-illusions-ts-sdk 0.0.476 → 0.0.477

package/docs/DocumentApi.md

@@ -1,476 +0,0 @@
-# DocumentApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**attachDocumentablesDocument**](DocumentApi.md#attachdocumentablesdocumentoperation) | **POST** /admin-api/document/{document}/attach-documentables | Auto-generated: attachDocumentablesDocument |
-| [**destroyDocument**](DocumentApi.md#destroydocument) | **DELETE** /admin-api/document/{document} | Auto-generated: destroyDocument |
-| [**detachDocumentablesDocument**](DocumentApi.md#detachdocumentablesdocumentoperation) | **POST** /admin-api/document/{document}/detach-documentables | Auto-generated: detachDocumentablesDocument |
-| [**getAllDocument**](DocumentApi.md#getalldocumentoperation) | **POST** /admin-api/document/all | Auto-generated: getAllDocument |
-| [**indexDocument**](DocumentApi.md#indexdocumentoperation) | **POST** /admin-api/document/list | Auto-generated: indexDocument |
-| [**storeDocument**](DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document | Auto-generated: storeDocument |
-| [**storeDocumentFile**](DocumentApi.md#storedocumentfileoperation) | **POST** /admin-api/document/files | Auto-generated: storeDocumentFile |
-
-
-
-## attachDocumentablesDocument
-
-> DocumentResource attachDocumentablesDocument(document, attachDocumentablesDocumentRequest)
-
-Auto-generated: attachDocumentablesDocument
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DocumentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachDocumentablesDocumentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DocumentApi();
-
-  const body = {
-    // number | The id of the document
-    document: 56,
-    // AttachDocumentablesDocumentRequest (optional)
-    attachDocumentablesDocumentRequest: ...,
-  } satisfies AttachDocumentablesDocumentOperationRequest;
-
-  try {
-    const data = await api.attachDocumentablesDocument(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **document** | `number` | The id of the document | [Defaults to `undefined`] |
-| **attachDocumentablesDocumentRequest** | [AttachDocumentablesDocumentRequest](AttachDocumentablesDocumentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**DocumentResource**](DocumentResource.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)
-
-
-## destroyDocument
-
-> GenericResponse destroyDocument(document)
-
-Auto-generated: destroyDocument
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DocumentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyDocumentRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DocumentApi();
-
-  const body = {
-    // number | The id of the document
-    document: 56,
-  } satisfies DestroyDocumentRequest;
-
-  try {
-    const data = await api.destroyDocument(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **document** | `number` | The id of the document | [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)
-
-
-## detachDocumentablesDocument
-
-> DocumentResource detachDocumentablesDocument(document, detachDocumentablesDocumentRequest)
-
-Auto-generated: detachDocumentablesDocument
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DocumentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachDocumentablesDocumentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DocumentApi();
-
-  const body = {
-    // number | The id of the document
-    document: 56,
-    // DetachDocumentablesDocumentRequest (optional)
-    detachDocumentablesDocumentRequest: ...,
-  } satisfies DetachDocumentablesDocumentOperationRequest;
-
-  try {
-    const data = await api.detachDocumentablesDocument(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **document** | `number` | The id of the document | [Defaults to `undefined`] |
-| **detachDocumentablesDocumentRequest** | [DetachDocumentablesDocumentRequest](DetachDocumentablesDocumentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**DocumentResource**](DocumentResource.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)
-
-
-## getAllDocument
-
-> DocumentResourceArrayResponse getAllDocument(getAllDocumentRequest)
-
-Auto-generated: getAllDocument
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DocumentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllDocumentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DocumentApi();
-
-  const body = {
-    // GetAllDocumentRequest (optional)
-    getAllDocumentRequest: ...,
-  } satisfies GetAllDocumentOperationRequest;
-
-  try {
-    const data = await api.getAllDocument(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllDocumentRequest** | [GetAllDocumentRequest](GetAllDocumentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**DocumentResourceArrayResponse**](DocumentResourceArrayResponse.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)
-
-
-## indexDocument
-
-> PaginatedDocumentResourceResponse indexDocument(indexDocumentRequest)
-
-Auto-generated: indexDocument
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DocumentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexDocumentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DocumentApi();
-
-  const body = {
-    // IndexDocumentRequest (optional)
-    indexDocumentRequest: ...,
-  } satisfies IndexDocumentOperationRequest;
-
-  try {
-    const data = await api.indexDocument(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexDocumentRequest** | [IndexDocumentRequest](IndexDocumentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedDocumentResourceResponse**](PaginatedDocumentResourceResponse.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<\\DocumentResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## storeDocument
-
-> DocumentResource storeDocument(storeDocumentRequest)
-
-Auto-generated: storeDocument
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DocumentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreDocumentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DocumentApi();
-
-  const body = {
-    // StoreDocumentRequest (optional)
-    storeDocumentRequest: ...,
-  } satisfies StoreDocumentOperationRequest;
-
-  try {
-    const data = await api.storeDocument(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeDocumentRequest** | [StoreDocumentRequest](StoreDocumentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**DocumentResource**](DocumentResource.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)
-
-
-## storeDocumentFile
-
-> DocumentFileForUploadResource storeDocumentFile(storeDocumentFileRequest)
-
-Auto-generated: storeDocumentFile
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DocumentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreDocumentFileOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DocumentApi();
-
-  const body = {
-    // StoreDocumentFileRequest (optional)
-    storeDocumentFileRequest: ...,
-  } satisfies StoreDocumentFileOperationRequest;
-
-  try {
-    const data = await api.storeDocumentFile(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeDocumentFileRequest** | [StoreDocumentFileRequest](StoreDocumentFileRequest.md) |  | [Optional] |
-
-### Return type
-
-[**DocumentFileForUploadResource**](DocumentFileForUploadResource.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/DocumentFileForUploadResource.md

@@ -1,40 +0,0 @@
-
-# DocumentFileForUploadResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`url` | string
-`headers` | Array<boolean>
-`fileName` | string
-
-## Example
-
-```typescript
-import type { DocumentFileForUploadResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "url": null,
-  "headers": null,
-  "fileName": null,
-} satisfies DocumentFileForUploadResource
-
-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 DocumentFileForUploadResource
-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/DocumentFileForUploadResourceArrayResponse.md

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

@@ -1,38 +0,0 @@
-
-# DocumentLiteResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`tag` | string
-
-## Example
-
-```typescript
-import type { DocumentLiteResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "tag": null,
-} satisfies DocumentLiteResource
-
-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 DocumentLiteResource
-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/DocumentLiteResourceArrayResponse.md

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

@@ -1,48 +0,0 @@
-
-# DocumentResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`tag` | string
-`documentFileId` | string
-`fileUrl` | string
-`sites` | [Array<SiteLiteResource>](SiteLiteResource.md)
-`createdAt` | string
-`updatedAt` | string
-
-## Example
-
-```typescript
-import type { DocumentResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "tag": null,
-  "documentFileId": null,
-  "fileUrl": null,
-  "sites": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies DocumentResource
-
-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 DocumentResource
-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/DocumentResourceArrayResponse.md

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