@digital8/lighting-illusions-ts-sdk 0.0.1745 → 0.0.1747

package/docs/IndexRedirectRequest.md

@@ -1,56 +0,0 @@
-
-# IndexRedirectRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`siteId` | Array<string>
-`redirectableType` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`productChildId` | number
-`productRangeId` | number
-
-## Example
-
-```typescript
-import type { IndexRedirectRequest } 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,
-  "siteId": null,
-  "redirectableType": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "productChildId": null,
-  "productRangeId": null,
-} satisfies IndexRedirectRequest
-
-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 IndexRedirectRequest
-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/IndexReviewRequest.md

@@ -1,54 +0,0 @@
-
-# IndexReviewRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`siteId` | Array<string>
-`createdByAdmin` | Array<string>
-`hasApprovedAt` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { IndexReviewRequest } 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,
-  "siteId": null,
-  "createdByAdmin": null,
-  "hasApprovedAt": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies IndexReviewRequest
-
-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 IndexReviewRequest
-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/PaginatedRedirectListResourceResponse.md

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

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

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

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

@@ -1,44 +0,0 @@
-
-# ProductReviewsResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`reviews` | [Array<ReviewPublicResource>](ReviewPublicResource.md)
-`totalReview` | number
-`averageRating` | number
-`stats` | Array<object>
-`myReview` | string
-`canReview` | boolean
-
-## Example
-
-```typescript
-import type { ProductReviewsResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "reviews": null,
-  "totalReview": null,
-  "averageRating": null,
-  "stats": null,
-  "myReview": null,
-  "canReview": null,
-} satisfies ProductReviewsResource
-
-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 ProductReviewsResource
-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/ProductReviewsResourceArrayResponse.md

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