@digital8/lighting-illusions-ts-sdk 0.0.1787 → 0.0.1789

package/docs/ProductRegistrationCustomerResource.md

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

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

@@ -1,42 +0,0 @@
-
-# ProductRegistrationListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`purchasedDate` | Date
-`customer` | [ProductRegistrationCustomerLiteResource](ProductRegistrationCustomerLiteResource.md)
-`productChildrenCount` | number
-`createdAt` | Date
-
-## Example
-
-```typescript
-import type { ProductRegistrationListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "purchasedDate": null,
-  "customer": null,
-  "productChildrenCount": null,
-  "createdAt": null,
-} satisfies ProductRegistrationListResource
-
-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 ProductRegistrationListResource
-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/ProductRegistrationListResourceArrayResponse.md

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

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

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

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

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

@@ -1,52 +0,0 @@
-
-# ProductRegistrationResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`purchasedDate` | Date
-`customer` | [ProductRegistrationCustomerResource](ProductRegistrationCustomerResource.md)
-`address` | [AddressResource](AddressResource.md)
-`productChildren` | [Array<ProductRegistrationProductChildResource>](ProductRegistrationProductChildResource.md)
-`assets` | [Array<ProductRegistrationAssetResource>](ProductRegistrationAssetResource.md)
-`omnisendId` | string
-`omnisendSyncStatus` | string
-`createdAt` | Date
-`updatedAt` | Date
-
-## Example
-
-```typescript
-import type { ProductRegistrationResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "purchasedDate": null,
-  "customer": null,
-  "address": null,
-  "productChildren": null,
-  "assets": null,
-  "omnisendId": null,
-  "omnisendSyncStatus": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies ProductRegistrationResource
-
-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 ProductRegistrationResource
-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/ProductRegistrationResourceArrayResponse.md

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

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

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

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

@@ -1,46 +0,0 @@
-
-# RedirectListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`redirectableType` | string
-`redirectableId` | number
-`fromSlug` | string
-`toSlug` | string
-`status` | number
-
-## Example
-
-```typescript
-import type { RedirectListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "site": null,
-  "redirectableType": null,
-  "redirectableId": null,
-  "fromSlug": null,
-  "toSlug": null,
-  "status": null,
-} satisfies RedirectListResource
-
-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 RedirectListResource
-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/RedirectListResourceArrayResponse.md

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

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