@digital8/lighting-illusions-ts-sdk 0.0.1874 → 0.0.1875

package/docs/DocumentApi.md

@@ -0,0 +1,611 @@
+# 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}/delete | 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 |
+| [**showDocument**](DocumentApi.md#showdocument) | **GET** /admin-api/document/{document} | Auto-generated: showDocument |
+| [**storeDocument**](DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document/create | Auto-generated: storeDocument |
+| [**storeDocumentFile**](DocumentApi.md#storedocumentfileoperation) | **POST** /admin-api/document/files | Auto-generated: storeDocumentFile |
+| [**updateDocument**](DocumentApi.md#updatedocumentoperation) | **PUT** /admin-api/document/{document}/update | Auto-generated: updateDocument |
+
+
+
+## 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)
+
+
+## showDocument
+
+> DocumentResource showDocument(document)
+
+Auto-generated: showDocument
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowDocumentRequest } 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 ShowDocumentRequest;
+
+  try {
+    const data = await api.showDocument(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
+
+[**DocumentResource**](DocumentResource.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)
+
+
+## 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)
+
+
+## updateDocument
+
+> DocumentResource updateDocument(document, updateDocumentRequest)
+
+Auto-generated: updateDocument
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentApi,
+} 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...");
+  const api = new DocumentApi();
+
+  const body = {
+    // number | The id of the document
+    document: 56,
+    // UpdateDocumentRequest (optional)
+    updateDocumentRequest: ...,
+  } satisfies UpdateDocumentOperationRequest;
+
+  try {
+    const data = await api.updateDocument(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`] |
+| **updateDocumentRequest** | [UpdateDocumentRequest](UpdateDocumentRequest.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)
+

package/docs/DocumentFileForUploadResource.md

@@ -8,7 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | number
 `url` | string
-`headers` | Array<string>
+`headers` | Array<boolean>
 `fileName` | string
 
 ## Example

package/docs/{GetAllFrontendComponentRequest.md → GetAllDocumentRequest.md}

@@ -1,5 +1,5 @@
 
-# GetAllFrontendComponentRequest
+# GetAllDocumentRequest
 
 
 ## Properties
@@ -17,7 +17,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { GetAllFrontendComponentRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { GetAllDocumentRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -28,7 +28,7 @@ const example = {
   "relatedType": null,
   "includesRelations": null,
   "sitesId": null,
-} satisfies GetAllFrontendComponentRequest
+} satisfies GetAllDocumentRequest
 
 console.log(example)
 
@@ -37,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as GetAllFrontendComponentRequest
+const exampleParsed = JSON.parse(exampleJSON) as GetAllDocumentRequest
 console.log(exampleParsed)
 ```
 

package/docs/{GenerateGoogleFeedAdminRequest.md → GetHierarchyProductCategoryRequest.md}

@@ -1,5 +1,5 @@
 
-# GenerateGoogleFeedAdminRequest
+# GetHierarchyProductCategoryRequest
 
 
 ## Properties
@@ -11,12 +11,12 @@ Name | Type
 ## Example
 
 ```typescript
-import type { GenerateGoogleFeedAdminRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { GetHierarchyProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "siteId": null,
-} satisfies GenerateGoogleFeedAdminRequest
+} satisfies GetHierarchyProductCategoryRequest
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as GenerateGoogleFeedAdminRequest
+const exampleParsed = JSON.parse(exampleJSON) as GetHierarchyProductCategoryRequest
 console.log(exampleParsed)
 ```