@digital8/lighting-illusions-ts-sdk 0.0.1854 → 0.0.1855

package/docs/DocumentApi.md

@@ -12,13 +12,13 @@ All URIs are relative to *http://localhost/api*
 | [**showDocument**](DocumentApi.md#showdocument) | **GET** /admin-api/document/{document} | Auto-generated: showDocument |
 | [**storeDocument**](DocumentApi.md#storedocument) | **POST** /admin-api/document/create | Auto-generated: storeDocument |
 | [**storeDocumentFile**](DocumentApi.md#storedocumentfile) | **POST** /admin-api/document/files | Auto-generated: storeDocumentFile |
-| [**updateDocument**](DocumentApi.md#updatedocument) | **PUT** /admin-api/document/{document}/update | Auto-generated: updateDocument |
+| [**updateDocument**](DocumentApi.md#updatedocumentoperation) | **PUT** /admin-api/document/{document}/update | Auto-generated: updateDocument |
 
 
 
 ## attachDocumentablesDocument
 
-> DocumentResource attachDocumentablesDocument(document, documentsAttachDocumentablesToDocumentRequest)
+> DocumentResource attachDocumentablesDocument(document, attachDocumentablesToDocumentRequest)
 
 Auto-generated: attachDocumentablesDocument
 
@@ -38,8 +38,8 @@ async function example() {
   const body = {
     // number | The id of the document
     document: 56,
-    // DocumentsAttachDocumentablesToDocumentRequest (optional)
-    documentsAttachDocumentablesToDocumentRequest: ...,
+    // AttachDocumentablesToDocumentRequest (optional)
+    attachDocumentablesToDocumentRequest: ...,
   } satisfies AttachDocumentablesDocumentRequest;
 
   try {
@@ -60,7 +60,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **document** | `number` | The id of the document | [Defaults to `undefined`] |
-| **documentsAttachDocumentablesToDocumentRequest** | [DocumentsAttachDocumentablesToDocumentRequest](DocumentsAttachDocumentablesToDocumentRequest.md) |  | [Optional] |
+| **attachDocumentablesToDocumentRequest** | [AttachDocumentablesToDocumentRequest](AttachDocumentablesToDocumentRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -151,7 +151,7 @@ No authorization required
 
 ## detachDocumentablesDocument
 
-> DocumentResource detachDocumentablesDocument(document, documentsDetachDocumentablesFromDocumentRequest)
+> DocumentResource detachDocumentablesDocument(document, detachDocumentablesFromDocumentRequest)
 
 Auto-generated: detachDocumentablesDocument
 
@@ -171,8 +171,8 @@ async function example() {
   const body = {
     // number | The id of the document
     document: 56,
-    // DocumentsDetachDocumentablesFromDocumentRequest (optional)
-    documentsDetachDocumentablesFromDocumentRequest: ...,
+    // DetachDocumentablesFromDocumentRequest (optional)
+    detachDocumentablesFromDocumentRequest: ...,
   } satisfies DetachDocumentablesDocumentRequest;
 
   try {
@@ -193,7 +193,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **document** | `number` | The id of the document | [Defaults to `undefined`] |
-| **documentsDetachDocumentablesFromDocumentRequest** | [DocumentsDetachDocumentablesFromDocumentRequest](DocumentsDetachDocumentablesFromDocumentRequest.md) |  | [Optional] |
+| **detachDocumentablesFromDocumentRequest** | [DetachDocumentablesFromDocumentRequest](DetachDocumentablesFromDocumentRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -219,7 +219,7 @@ No authorization required
 
 ## getAllDocument
 
-> DocumentResourceArrayResponse getAllDocument(documentsSearchAllDocumentsRequest)
+> DocumentResourceArrayResponse getAllDocument(searchAllDocumentsRequest)
 
 Auto-generated: getAllDocument
 
@@ -237,8 +237,8 @@ async function example() {
   const api = new DocumentApi();
 
   const body = {
-    // DocumentsSearchAllDocumentsRequest (optional)
-    documentsSearchAllDocumentsRequest: ...,
+    // SearchAllDocumentsRequest (optional)
+    searchAllDocumentsRequest: ...,
   } satisfies GetAllDocumentRequest;
 
   try {
@@ -258,7 +258,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **documentsSearchAllDocumentsRequest** | [DocumentsSearchAllDocumentsRequest](DocumentsSearchAllDocumentsRequest.md) |  | [Optional] |
+| **searchAllDocumentsRequest** | [SearchAllDocumentsRequest](SearchAllDocumentsRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -284,7 +284,7 @@ No authorization required
 
 ## indexDocument
 
-> PaginatedDocumentResourceResponse indexDocument(documentsSearchDocumentsRequest)
+> PaginatedDocumentResourceResponse indexDocument(searchDocumentsRequest)
 
 Auto-generated: indexDocument
 
@@ -302,8 +302,8 @@ async function example() {
   const api = new DocumentApi();
 
   const body = {
-    // DocumentsSearchDocumentsRequest (optional)
-    documentsSearchDocumentsRequest: ...,
+    // SearchDocumentsRequest (optional)
+    searchDocumentsRequest: ...,
   } satisfies IndexDocumentRequest;
 
   try {
@@ -323,7 +323,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **documentsSearchDocumentsRequest** | [DocumentsSearchDocumentsRequest](DocumentsSearchDocumentsRequest.md) |  | [Optional] |
+| **searchDocumentsRequest** | [SearchDocumentsRequest](SearchDocumentsRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -414,7 +414,7 @@ No authorization required
 
 ## storeDocument
 
-> DocumentResource storeDocument(documentsCreateDocumentRequest)
+> DocumentResource storeDocument(createDocumentRequest)
 
 Auto-generated: storeDocument
 
@@ -432,8 +432,8 @@ async function example() {
   const api = new DocumentApi();
 
   const body = {
-    // DocumentsCreateDocumentRequest (optional)
-    documentsCreateDocumentRequest: ...,
+    // CreateDocumentRequest (optional)
+    createDocumentRequest: ...,
   } satisfies StoreDocumentRequest;
 
   try {
@@ -453,7 +453,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **documentsCreateDocumentRequest** | [DocumentsCreateDocumentRequest](DocumentsCreateDocumentRequest.md) |  | [Optional] |
+| **createDocumentRequest** | [CreateDocumentRequest](CreateDocumentRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -479,7 +479,7 @@ No authorization required
 
 ## storeDocumentFile
 
-> DocumentFileForUploadResource storeDocumentFile(documentsCreateDocumentFileRequest)
+> DocumentFileForUploadResource storeDocumentFile(createDocumentFileRequest)
 
 Auto-generated: storeDocumentFile
 
@@ -497,8 +497,8 @@ async function example() {
   const api = new DocumentApi();
 
   const body = {
-    // DocumentsCreateDocumentFileRequest (optional)
-    documentsCreateDocumentFileRequest: ...,
+    // CreateDocumentFileRequest (optional)
+    createDocumentFileRequest: ...,
   } satisfies StoreDocumentFileRequest;
 
   try {
@@ -518,7 +518,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **documentsCreateDocumentFileRequest** | [DocumentsCreateDocumentFileRequest](DocumentsCreateDocumentFileRequest.md) |  | [Optional] |
+| **createDocumentFileRequest** | [CreateDocumentFileRequest](CreateDocumentFileRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -544,7 +544,7 @@ No authorization required
 
 ## updateDocument
 
-> DocumentResource updateDocument(document, documentsUpdateDocumentRequest)
+> DocumentResource updateDocument(document, updateDocumentRequest)
 
 Auto-generated: updateDocument
 
@@ -555,7 +555,7 @@ import {
   Configuration,
   DocumentApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateDocumentRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateDocumentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
@@ -564,9 +564,9 @@ async function example() {
   const body = {
     // number | The id of the document
     document: 56,
-    // DocumentsUpdateDocumentRequest (optional)
-    documentsUpdateDocumentRequest: ...,
-  } satisfies UpdateDocumentRequest;
+    // UpdateDocumentRequest (optional)
+    updateDocumentRequest: ...,
+  } satisfies UpdateDocumentOperationRequest;
 
   try {
     const data = await api.updateDocument(body);
@@ -586,7 +586,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **document** | `number` | The id of the document | [Defaults to `undefined`] |
-| **documentsUpdateDocumentRequest** | [DocumentsUpdateDocumentRequest](DocumentsUpdateDocumentRequest.md) |  | [Optional] |
+| **updateDocumentRequest** | [UpdateDocumentRequest](UpdateDocumentRequest.md) |  | [Optional] |
 
 ### Return type
 

package/docs/FrontendComponentApi.md

@@ -10,7 +10,7 @@ All URIs are relative to *http://localhost/api*
 
 ## getAllFrontendComponent
 
-> FrontendComponentResourceArrayResponse getAllFrontendComponent(frontendComponentsSearchAllFrontendComponentsRequest)
+> FrontendComponentResourceArrayResponse getAllFrontendComponent(searchAllFrontendComponentsRequest)
 
 Auto-generated: getAllFrontendComponent
 
@@ -28,8 +28,8 @@ async function example() {
   const api = new FrontendComponentApi();
 
   const body = {
-    // FrontendComponentsSearchAllFrontendComponentsRequest (optional)
-    frontendComponentsSearchAllFrontendComponentsRequest: ...,
+    // SearchAllFrontendComponentsRequest (optional)
+    searchAllFrontendComponentsRequest: ...,
   } satisfies GetAllFrontendComponentRequest;
 
   try {
@@ -49,7 +49,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **frontendComponentsSearchAllFrontendComponentsRequest** | [FrontendComponentsSearchAllFrontendComponentsRequest](FrontendComponentsSearchAllFrontendComponentsRequest.md) |  | [Optional] |
+| **searchAllFrontendComponentsRequest** | [SearchAllFrontendComponentsRequest](SearchAllFrontendComponentsRequest.md) |  | [Optional] |
 
 ### Return type
 

package/docs/GoogleCategoryApi.md

@@ -10,7 +10,7 @@ All URIs are relative to *http://localhost/api*
 
 ## getAllGoogleCategory
 
-> GoogleCategoryResourceArrayResponse getAllGoogleCategory(googleCategoriesSearchGoogleCategoriesRequest)
+> GoogleCategoryResourceArrayResponse getAllGoogleCategory(searchGoogleCategoriesRequest)
 
 Auto-generated: getAllGoogleCategory
 
@@ -28,8 +28,8 @@ async function example() {
   const api = new GoogleCategoryApi();
 
   const body = {
-    // GoogleCategoriesSearchGoogleCategoriesRequest (optional)
-    googleCategoriesSearchGoogleCategoriesRequest: ...,
+    // SearchGoogleCategoriesRequest (optional)
+    searchGoogleCategoriesRequest: ...,
   } satisfies GetAllGoogleCategoryRequest;
 
   try {
@@ -49,7 +49,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **googleCategoriesSearchGoogleCategoriesRequest** | [GoogleCategoriesSearchGoogleCategoriesRequest](GoogleCategoriesSearchGoogleCategoriesRequest.md) |  | [Optional] |
+| **searchGoogleCategoriesRequest** | [SearchGoogleCategoriesRequest](SearchGoogleCategoriesRequest.md) |  | [Optional] |
 
 ### Return type
 

package/docs/LabelApi.md

@@ -9,7 +9,7 @@ All URIs are relative to *http://localhost/api*
 | [**indexLabel**](LabelApi.md#indexlabel) | **POST** /admin-api/label/list | Auto-generated: indexLabel |
 | [**showLabel**](LabelApi.md#showlabel) | **GET** /admin-api/label/{label} | Auto-generated: showLabel |
 | [**storeLabel**](LabelApi.md#storelabel) | **POST** /admin-api/label/create | Auto-generated: storeLabel |
-| [**updateLabel**](LabelApi.md#updatelabel) | **PUT** /admin-api/label/{label}/update | Auto-generated: updateLabel |
+| [**updateLabel**](LabelApi.md#updatelabeloperation) | **PUT** /admin-api/label/{label}/update | Auto-generated: updateLabel |
 
 
 
@@ -80,7 +80,7 @@ No authorization required
 
 ## getAllLabel
 
-> GenericResponse getAllLabel(labelsSearchLabelsRequest)
+> GenericResponse getAllLabel(searchLabelsRequest)
 
 Auto-generated: getAllLabel
 
@@ -98,8 +98,8 @@ async function example() {
   const api = new LabelApi();
 
   const body = {
-    // LabelsSearchLabelsRequest (optional)
-    labelsSearchLabelsRequest: ...,
+    // SearchLabelsRequest (optional)
+    searchLabelsRequest: ...,
   } satisfies GetAllLabelRequest;
 
   try {
@@ -119,7 +119,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **labelsSearchLabelsRequest** | [LabelsSearchLabelsRequest](LabelsSearchLabelsRequest.md) |  | [Optional] |
+| **searchLabelsRequest** | [SearchLabelsRequest](SearchLabelsRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -145,7 +145,7 @@ No authorization required
 
 ## indexLabel
 
-> PaginatedLabelListResourceResponse indexLabel(labelsSearchLabelsRequest)
+> PaginatedLabelListResourceResponse indexLabel(searchLabelsRequest)
 
 Auto-generated: indexLabel
 
@@ -163,8 +163,8 @@ async function example() {
   const api = new LabelApi();
 
   const body = {
-    // LabelsSearchLabelsRequest (optional)
-    labelsSearchLabelsRequest: ...,
+    // SearchLabelsRequest (optional)
+    searchLabelsRequest: ...,
   } satisfies IndexLabelRequest;
 
   try {
@@ -184,7 +184,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **labelsSearchLabelsRequest** | [LabelsSearchLabelsRequest](LabelsSearchLabelsRequest.md) |  | [Optional] |
+| **searchLabelsRequest** | [SearchLabelsRequest](SearchLabelsRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -275,7 +275,7 @@ No authorization required
 
 ## storeLabel
 
-> LabelResource storeLabel(labelsCreateLabelRequest)
+> LabelResource storeLabel(createLabelRequest)
 
 Auto-generated: storeLabel
 
@@ -293,8 +293,8 @@ async function example() {
   const api = new LabelApi();
 
   const body = {
-    // LabelsCreateLabelRequest (optional)
-    labelsCreateLabelRequest: ...,
+    // CreateLabelRequest (optional)
+    createLabelRequest: ...,
   } satisfies StoreLabelRequest;
 
   try {
@@ -314,7 +314,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **labelsCreateLabelRequest** | [LabelsCreateLabelRequest](LabelsCreateLabelRequest.md) |  | [Optional] |
+| **createLabelRequest** | [CreateLabelRequest](CreateLabelRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -340,7 +340,7 @@ No authorization required
 
 ## updateLabel
 
-> LabelResource updateLabel(label, labelsUpdateLabelRequest)
+> LabelResource updateLabel(label, updateLabelRequest)
 
 Auto-generated: updateLabel
 
@@ -351,7 +351,7 @@ import {
   Configuration,
   LabelApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateLabelRequest } 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...");
@@ -360,9 +360,9 @@ async function example() {
   const body = {
     // number | The id of the label
     label: 56,
-    // LabelsUpdateLabelRequest (optional)
-    labelsUpdateLabelRequest: ...,
-  } satisfies UpdateLabelRequest;
+    // UpdateLabelRequest (optional)
+    updateLabelRequest: ...,
+  } satisfies UpdateLabelOperationRequest;
 
   try {
     const data = await api.updateLabel(body);
@@ -382,7 +382,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **label** | `number` | The id of the label | [Defaults to `undefined`] |
-| **labelsUpdateLabelRequest** | [LabelsUpdateLabelRequest](LabelsUpdateLabelRequest.md) |  | [Optional] |
+| **updateLabelRequest** | [UpdateLabelRequest](UpdateLabelRequest.md) |  | [Optional] |
 
 ### Return type
 

package/docs/LinkOverlayTemplateToAssetsRequest.md

@@ -0,0 +1,36 @@
+
+# LinkOverlayTemplateToAssetsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`assetIds` | Array<number>
+`syncAssets` | boolean
+
+## Example
+
+```typescript
+import type { LinkOverlayTemplateToAssetsRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "assetIds": null,
+  "syncAssets": null,
+} satisfies LinkOverlayTemplateToAssetsRequest
+
+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 LinkOverlayTemplateToAssetsRequest
+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)
+
+