@digital8/lighting-illusions-ts-sdk 0.0.451 → 0.0.453

package/docs/TagApi.md

@@ -1,545 +0,0 @@
-# TagApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyTag**](TagApi.md#destroytag) | **DELETE** /admin-api/tag/{tag}/delete | Auto-generated: destroyTag |
-| [**getAllTag**](TagApi.md#getalltag) | **POST** /admin-api/tag/all | Auto-generated: getAllTag |
-| [**indexTag**](TagApi.md#indextagoperation) | **POST** /admin-api/tag/list | Auto-generated: indexTag |
-| [**linkProductChildrenTag**](TagApi.md#linkproductchildrentagoperation) | **POST** /admin-api/tag/{tag}/link-product-children | Auto-generated: linkProductChildrenTag |
-| [**showTag**](TagApi.md#showtag) | **GET** /admin-api/tag/{tag} | Auto-generated: showTag |
-| [**storeTag**](TagApi.md#storetagoperation) | **POST** /admin-api/tag/create | Auto-generated: storeTag |
-| [**unlinkProductChildTag**](TagApi.md#unlinkproductchildtag) | **POST** /admin-api/tag/{tag}/remove-product-child/{productChild} | Auto-generated: unlinkProductChildTag |
-| [**updateTag**](TagApi.md#updatetagoperation) | **PUT** /admin-api/tag/{tag}/update | Auto-generated: updateTag |
-
-
-
-## destroyTag
-
-> GenericResponse destroyTag(tag)
-
-Auto-generated: destroyTag
-
-### Example
-
-```ts
-import {
-  Configuration,
-  TagApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyTagRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new TagApi();
-
-  const body = {
-    // number | The id of the tag
-    tag: 56,
-  } satisfies DestroyTagRequest;
-
-  try {
-    const data = await api.destroyTag(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **tag** | `number` | The id of the tag | [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)
-
-
-## getAllTag
-
-> TagLiteResourceArrayResponse getAllTag(indexTagRequest)
-
-Auto-generated: getAllTag
-
-### Example
-
-```ts
-import {
-  Configuration,
-  TagApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllTagRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new TagApi();
-
-  const body = {
-    // IndexTagRequest (optional)
-    indexTagRequest: ...,
-  } satisfies GetAllTagRequest;
-
-  try {
-    const data = await api.getAllTag(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexTagRequest** | [IndexTagRequest](IndexTagRequest.md) |  | [Optional] |
-
-### Return type
-
-[**TagLiteResourceArrayResponse**](TagLiteResourceArrayResponse.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)
-
-
-## indexTag
-
-> PaginatedTagResourceResponse indexTag(indexTagRequest)
-
-Auto-generated: indexTag
-
-### Example
-
-```ts
-import {
-  Configuration,
-  TagApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexTagOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new TagApi();
-
-  const body = {
-    // IndexTagRequest (optional)
-    indexTagRequest: ...,
-  } satisfies IndexTagOperationRequest;
-
-  try {
-    const data = await api.indexTag(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexTagRequest** | [IndexTagRequest](IndexTagRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedTagResourceResponse**](PaginatedTagResourceResponse.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<\\TagResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## linkProductChildrenTag
-
-> ProductChildRelationResourceArrayResponse linkProductChildrenTag(tag, linkProductChildrenTagRequest)
-
-Auto-generated: linkProductChildrenTag
-
-### Example
-
-```ts
-import {
-  Configuration,
-  TagApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { LinkProductChildrenTagOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new TagApi();
-
-  const body = {
-    // number | The id of the tag
-    tag: 56,
-    // LinkProductChildrenTagRequest (optional)
-    linkProductChildrenTagRequest: ...,
-  } satisfies LinkProductChildrenTagOperationRequest;
-
-  try {
-    const data = await api.linkProductChildrenTag(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **tag** | `number` | The id of the tag | [Defaults to `undefined`] |
-| **linkProductChildrenTagRequest** | [LinkProductChildrenTagRequest](LinkProductChildrenTagRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductChildRelationResourceArrayResponse**](ProductChildRelationResourceArrayResponse.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)
-
-
-## showTag
-
-> TagResource showTag(tag)
-
-Auto-generated: showTag
-
-### Example
-
-```ts
-import {
-  Configuration,
-  TagApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowTagRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new TagApi();
-
-  const body = {
-    // number | The id of the tag
-    tag: 56,
-  } satisfies ShowTagRequest;
-
-  try {
-    const data = await api.showTag(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **tag** | `number` | The id of the tag | [Defaults to `undefined`] |
-
-### Return type
-
-[**TagResource**](TagResource.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)
-
-
-## storeTag
-
-> TagResource storeTag(storeTagRequest)
-
-Auto-generated: storeTag
-
-### Example
-
-```ts
-import {
-  Configuration,
-  TagApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreTagOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new TagApi();
-
-  const body = {
-    // StoreTagRequest (optional)
-    storeTagRequest: ...,
-  } satisfies StoreTagOperationRequest;
-
-  try {
-    const data = await api.storeTag(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeTagRequest** | [StoreTagRequest](StoreTagRequest.md) |  | [Optional] |
-
-### Return type
-
-[**TagResource**](TagResource.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)
-
-
-## unlinkProductChildTag
-
-> ProductChildRelationResourceArrayResponse unlinkProductChildTag(tag, productChild)
-
-Auto-generated: unlinkProductChildTag
-
-### Example
-
-```ts
-import {
-  Configuration,
-  TagApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UnlinkProductChildTagRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new TagApi();
-
-  const body = {
-    // number | The id of the tag
-    tag: 56,
-    // number | The id of the productChild
-    productChild: 56,
-  } satisfies UnlinkProductChildTagRequest;
-
-  try {
-    const data = await api.unlinkProductChildTag(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **tag** | `number` | The id of the tag | [Defaults to `undefined`] |
-| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
-
-### Return type
-
-[**ProductChildRelationResourceArrayResponse**](ProductChildRelationResourceArrayResponse.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)
-
-
-## updateTag
-
-> TagResource updateTag(tag, updateTagRequest)
-
-Auto-generated: updateTag
-
-### Example
-
-```ts
-import {
-  Configuration,
-  TagApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateTagOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new TagApi();
-
-  const body = {
-    // number | The id of the tag
-    tag: 56,
-    // UpdateTagRequest (optional)
-    updateTagRequest: ...,
-  } satisfies UpdateTagOperationRequest;
-
-  try {
-    const data = await api.updateTag(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **tag** | `number` | The id of the tag | [Defaults to `undefined`] |
-| **updateTagRequest** | [UpdateTagRequest](UpdateTagRequest.md) |  | [Optional] |
-
-### Return type
-
-[**TagResource**](TagResource.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/TagLiteResource.md

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

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

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

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