@digital8/lighting-illusions-ts-sdk 0.0.490 → 0.0.491

package/docs/ProductChildListResource.md

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

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

@@ -1,48 +0,0 @@
-
-# ProductChildLiteResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`parentName` | string
-`name` | string
-`modelNumber` | string
-`sku` | number
-`stock` | number
-`netsuiteId` | number
-`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
-
-## Example
-
-```typescript
-import type { ProductChildLiteResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "parentName": null,
-  "name": null,
-  "modelNumber": null,
-  "sku": null,
-  "stock": null,
-  "netsuiteId": null,
-  "thumbnail": null,
-} satisfies ProductChildLiteResource
-
-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 ProductChildLiteResource
-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/ProductChildLiteResourceArrayResponse.md

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

@@ -1,50 +0,0 @@
-
-# ProductChildOverlayRelationResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`parentName` | string
-`name` | string
-`modelNumber` | string
-`sku` | number
-`stock` | number
-`netsuiteId` | number
-`thumbnail` | [AssetResource](AssetResource.md)
-`numberAttached` | number
-
-## Example
-
-```typescript
-import type { ProductChildOverlayRelationResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "parentName": null,
-  "name": null,
-  "modelNumber": null,
-  "sku": null,
-  "stock": null,
-  "netsuiteId": null,
-  "thumbnail": null,
-  "numberAttached": null,
-} satisfies ProductChildOverlayRelationResource
-
-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 ProductChildOverlayRelationResource
-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/ProductChildOverlayRelationResourceArrayResponse.md

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

@@ -1,46 +0,0 @@
-
-# ProductChildRelationResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`model` | string
-`sku` | number
-`netsuiteId` | number
-`thumbnail` | [AssetResource](AssetResource.md)
-`dateAdded` | object
-
-## Example
-
-```typescript
-import type { ProductChildRelationResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "model": null,
-  "sku": null,
-  "netsuiteId": null,
-  "thumbnail": null,
-  "dateAdded": null,
-} satisfies ProductChildRelationResource
-
-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 ProductChildRelationResource
-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/ProductChildRelationResourceArrayResponse.md

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

@@ -1,80 +0,0 @@
-
-# ProductChildResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`allowOversell` | boolean
-`modelNumber` | string
-`weight` | number
-`warranty` | string
-`stock` | number
-`sku` | number
-`buyPrice` | number
-`hideFromFrontend` | boolean
-`supplierBarcode` | string
-`popularityScore` | number
-`excludedFromSearch` | string
-`isOversized` | boolean
-`googleStockStatus` | number
-`netsuiteId` | number
-`newArrivalsStartDate` | string
-`newArrivalsEndDate` | string
-`omnisendId` | string
-`isDisabled` | string
-`siteDetails` | [Array<ProductChildSiteDetailResource>](ProductChildSiteDetailResource.md)
-`assets` | [Array<AssetResource>](AssetResource.md)
-`thumbnail` | [AssetResource](AssetResource.md)
-`attributes` | object
-
-## Example
-
-```typescript
-import type { ProductChildResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "allowOversell": null,
-  "modelNumber": null,
-  "weight": null,
-  "warranty": null,
-  "stock": null,
-  "sku": null,
-  "buyPrice": null,
-  "hideFromFrontend": null,
-  "supplierBarcode": null,
-  "popularityScore": null,
-  "excludedFromSearch": null,
-  "isOversized": null,
-  "googleStockStatus": null,
-  "netsuiteId": null,
-  "newArrivalsStartDate": null,
-  "newArrivalsEndDate": null,
-  "omnisendId": null,
-  "isDisabled": null,
-  "siteDetails": null,
-  "assets": null,
-  "thumbnail": null,
-  "attributes": null,
-} satisfies ProductChildResource
-
-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 ProductChildResource
-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/ProductChildResourceArrayResponse.md

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

@@ -1,146 +0,0 @@
-# ProductChildSiteDetailApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**attachDocumentsProductChildSiteDetail**](ProductChildSiteDetailApi.md#attachdocumentsproductchildsitedetailoperation) | **POST** /admin-api/product-child-site-detail/{productChildSiteDetail}/attach-documents | Auto-generated: attachDocumentsProductChildSiteDetail |
-| [**detachDocumentsProductChildSiteDetail**](ProductChildSiteDetailApi.md#detachdocumentsproductchildsitedetailoperation) | **POST** /admin-api/product-child-site-detail/{productChildSiteDetail}/detach-documents | Auto-generated: detachDocumentsProductChildSiteDetail |
-
-
-
-## attachDocumentsProductChildSiteDetail
-
-> ProductChildSiteDetailResource attachDocumentsProductChildSiteDetail(productChildSiteDetail, attachDocumentsProductChildSiteDetailRequest)
-
-Auto-generated: attachDocumentsProductChildSiteDetail
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductChildSiteDetailApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachDocumentsProductChildSiteDetailOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductChildSiteDetailApi();
-
-  const body = {
-    // number | The id of the productChildSiteDetail
-    productChildSiteDetail: 56,
-    // AttachDocumentsProductChildSiteDetailRequest (optional)
-    attachDocumentsProductChildSiteDetailRequest: ...,
-  } satisfies AttachDocumentsProductChildSiteDetailOperationRequest;
-
-  try {
-    const data = await api.attachDocumentsProductChildSiteDetail(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productChildSiteDetail** | `number` | The id of the productChildSiteDetail | [Defaults to `undefined`] |
-| **attachDocumentsProductChildSiteDetailRequest** | [AttachDocumentsProductChildSiteDetailRequest](AttachDocumentsProductChildSiteDetailRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductChildSiteDetailResource**](ProductChildSiteDetailResource.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)
-
-
-## detachDocumentsProductChildSiteDetail
-
-> ProductChildSiteDetailResource detachDocumentsProductChildSiteDetail(productChildSiteDetail, detachDocumentsProductChildSiteDetailRequest)
-
-Auto-generated: detachDocumentsProductChildSiteDetail
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductChildSiteDetailApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachDocumentsProductChildSiteDetailOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductChildSiteDetailApi();
-
-  const body = {
-    // number | The id of the productChildSiteDetail
-    productChildSiteDetail: 56,
-    // DetachDocumentsProductChildSiteDetailRequest (optional)
-    detachDocumentsProductChildSiteDetailRequest: ...,
-  } satisfies DetachDocumentsProductChildSiteDetailOperationRequest;
-
-  try {
-    const data = await api.detachDocumentsProductChildSiteDetail(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productChildSiteDetail** | `number` | The id of the productChildSiteDetail | [Defaults to `undefined`] |
-| **detachDocumentsProductChildSiteDetailRequest** | [DetachDocumentsProductChildSiteDetailRequest](DetachDocumentsProductChildSiteDetailRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductChildSiteDetailResource**](ProductChildSiteDetailResource.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/ProductChildSiteDetailLiteResource.md

@@ -1,46 +0,0 @@
-
-# ProductChildSiteDetailLiteResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`name` | string
-`slug` | string
-`rrpPrice` | number
-`salePrice` | number
-`isDisabled` | boolean
-
-## Example
-
-```typescript
-import type { ProductChildSiteDetailLiteResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "site": null,
-  "name": null,
-  "slug": null,
-  "rrpPrice": null,
-  "salePrice": null,
-  "isDisabled": null,
-} satisfies ProductChildSiteDetailLiteResource
-
-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 ProductChildSiteDetailLiteResource
-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/ProductChildSiteDetailLiteResourceArrayResponse.md

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