@digital8/lighting-illusions-ts-sdk 0.0.478 → 0.0.479

package/docs/ExternalApiLogApi.md

@@ -1,74 +0,0 @@
-# ExternalApiLogApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**indexExternalApiLog**](ExternalApiLogApi.md#indexexternalapilogoperation) | **POST** /admin-api/external-api-log/list | Auto-generated: indexExternalApiLog |
-
-
-
-## indexExternalApiLog
-
-> PaginatedExternalApiLogResourceResponse indexExternalApiLog(indexExternalApiLogRequest)
-
-Auto-generated: indexExternalApiLog
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ExternalApiLogApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexExternalApiLogOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ExternalApiLogApi();
-
-  const body = {
-    // IndexExternalApiLogRequest (optional)
-    indexExternalApiLogRequest: ...,
-  } satisfies IndexExternalApiLogOperationRequest;
-
-  try {
-    const data = await api.indexExternalApiLog(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexExternalApiLogRequest** | [IndexExternalApiLogRequest](IndexExternalApiLogRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedExternalApiLogResourceResponse**](PaginatedExternalApiLogResourceResponse.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<\\ExternalApiLogResource[]>> |  -  |
-
-[[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/ExternalApiLogListResource.md

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

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

@@ -1,54 +0,0 @@
-
-# ExternalApiLogResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`provider` | string
-`httpMethod` | string
-`exteranlApiLoggableType` | string
-`exteranlApiLoggableId` | number
-`endpoint` | string
-`responseCode` | number
-`requestPayload` | string
-`responsePayload` | string
-`createdAt` | string
-`site` | [SiteLiteResource](SiteLiteResource.md)
-
-## Example
-
-```typescript
-import type { ExternalApiLogResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "provider": null,
-  "httpMethod": null,
-  "exteranlApiLoggableType": null,
-  "exteranlApiLoggableId": null,
-  "endpoint": null,
-  "responseCode": null,
-  "requestPayload": null,
-  "responsePayload": null,
-  "createdAt": null,
-  "site": null,
-} satisfies ExternalApiLogResource
-
-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 ExternalApiLogResource
-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/ExternalApiLogResourceArrayResponse.md

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

@@ -1,32 +0,0 @@
-
-# ExternalApiProvider
-
-
-## Properties
-
-Name | Type
------------- | -------------
-
-## Example
-
-```typescript
-import type { ExternalApiProvider } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-} satisfies ExternalApiProvider
-
-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 ExternalApiProvider
-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/ExternalApiSyncStatus.md

@@ -1,32 +0,0 @@
-
-# ExternalApiSyncStatus
-
-
-## Properties
-
-Name | Type
------------- | -------------
-
-## Example
-
-```typescript
-import type { ExternalApiSyncStatus } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-} satisfies ExternalApiSyncStatus
-
-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 ExternalApiSyncStatus
-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/GetAllAttributeRequest.md

@@ -1,50 +0,0 @@
-
-# GetAllAttributeRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`type` | Array<string>
-`isFilterable` | Array<string>
-`isExpandedByDefault` | Array<string>
-
-## Example
-
-```typescript
-import type { GetAllAttributeRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "type": null,
-  "isFilterable": null,
-  "isExpandedByDefault": null,
-} satisfies GetAllAttributeRequest
-
-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 GetAllAttributeRequest
-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/GetAllDocumentRequest.md

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

@@ -1,46 +0,0 @@
-
-# GetAllOverlayTemplateRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`sitesId` | Array<string>
-
-## Example
-
-```typescript
-import type { GetAllOverlayTemplateRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "sitesId": null,
-} satisfies GetAllOverlayTemplateRequest
-
-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 GetAllOverlayTemplateRequest
-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/GetAllProductChildRequest.md

@@ -1,54 +0,0 @@
-
-# GetAllProductChildRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`parentProductTypeId` | Array<string>
-`parentSupplierId` | Array<string>
-`siteDetailsSiteId` | Array<string>
-`isDisabled` | Array<string>
-`hasNetsuiteId` | Array<string>
-
-## Example
-
-```typescript
-import type { GetAllProductChildRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "parentProductTypeId": null,
-  "parentSupplierId": null,
-  "siteDetailsSiteId": null,
-  "isDisabled": null,
-  "hasNetsuiteId": null,
-} satisfies GetAllProductChildRequest
-
-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 GetAllProductChildRequest
-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/GetAllProductRequest.md

@@ -1,54 +0,0 @@
-
-# GetAllProductRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`productTypeId` | Array<string>
-`supplierId` | Array<string>
-`isDisabled` | Array<string>
-`isAccessory` | Array<string>
-`categoriesId` | Array<string>
-
-## Example
-
-```typescript
-import type { GetAllProductRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "productTypeId": null,
-  "supplierId": null,
-  "isDisabled": null,
-  "isAccessory": null,
-  "categoriesId": null,
-} satisfies GetAllProductRequest
-
-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 GetAllProductRequest
-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/GetAllProductTypeRequest.md

@@ -1,44 +0,0 @@
-
-# GetAllProductTypeRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { GetAllProductTypeRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies GetAllProductTypeRequest
-
-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 GetAllProductTypeRequest
-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/GetAllSupplierRequest.md

@@ -1,44 +0,0 @@
-
-# GetAllSupplierRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { GetAllSupplierRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies GetAllSupplierRequest
-
-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 GetAllSupplierRequest
-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/IndexAttributeRequest.md

@@ -1,54 +0,0 @@
-
-# IndexAttributeRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`type` | Array<string>
-`isFilterable` | Array<string>
-`isExpandedByDefault` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { IndexAttributeRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "type": null,
-  "isFilterable": null,
-  "isExpandedByDefault": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies IndexAttributeRequest
-
-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 IndexAttributeRequest
-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)
-
-