@digital8/lighting-illusions-ts-sdk 0.0.1833 → 0.0.1835

package/docs/BlogCategoryApi.md

@@ -1,407 +0,0 @@
-# BlogCategoryApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyBlogCategory**](BlogCategoryApi.md#destroyblogcategory) | **DELETE** /admin-api/blog-category/{blogCategory}/delete | Auto-generated: destroyBlogCategory |
-| [**getAllBlogCategory**](BlogCategoryApi.md#getallblogcategoryoperation) | **POST** /admin-api/blog-category/all | Auto-generated: getAllBlogCategory |
-| [**indexBlogCategory**](BlogCategoryApi.md#indexblogcategoryoperation) | **POST** /admin-api/blog-category/list | Auto-generated: indexBlogCategory |
-| [**showBlogCategory**](BlogCategoryApi.md#showblogcategory) | **GET** /admin-api/blog-category/{blogCategory} | Auto-generated: showBlogCategory |
-| [**storeBlogCategory**](BlogCategoryApi.md#storeblogcategoryoperation) | **POST** /admin-api/blog-category/create | Auto-generated: storeBlogCategory |
-| [**updateBlogCategory**](BlogCategoryApi.md#updateblogcategoryoperation) | **PUT** /admin-api/blog-category/{blogCategory}/update | Auto-generated: updateBlogCategory |
-
-
-
-## destroyBlogCategory
-
-> GenericResponse destroyBlogCategory(blogCategory)
-
-Auto-generated: destroyBlogCategory
-
-### Example
-
-```ts
-import {
-  Configuration,
-  BlogCategoryApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyBlogCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new BlogCategoryApi();
-
-  const body = {
-    // number | The id of the blogCategory
-    blogCategory: 56,
-  } satisfies DestroyBlogCategoryRequest;
-
-  try {
-    const data = await api.destroyBlogCategory(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **blogCategory** | `number` | The id of the blogCategory | [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)
-
-
-## getAllBlogCategory
-
-> BlogCategoryLiteResourceArrayResponse getAllBlogCategory(getAllBlogCategoryRequest)
-
-Auto-generated: getAllBlogCategory
-
-### Example
-
-```ts
-import {
-  Configuration,
-  BlogCategoryApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllBlogCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new BlogCategoryApi();
-
-  const body = {
-    // GetAllBlogCategoryRequest (optional)
-    getAllBlogCategoryRequest: ...,
-  } satisfies GetAllBlogCategoryOperationRequest;
-
-  try {
-    const data = await api.getAllBlogCategory(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllBlogCategoryRequest** | [GetAllBlogCategoryRequest](GetAllBlogCategoryRequest.md) |  | [Optional] |
-
-### Return type
-
-[**BlogCategoryLiteResourceArrayResponse**](BlogCategoryLiteResourceArrayResponse.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)
-
-
-## indexBlogCategory
-
-> PaginatedBlogCategoryListResourceResponse indexBlogCategory(indexBlogCategoryRequest)
-
-Auto-generated: indexBlogCategory
-
-### Example
-
-```ts
-import {
-  Configuration,
-  BlogCategoryApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexBlogCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new BlogCategoryApi();
-
-  const body = {
-    // IndexBlogCategoryRequest (optional)
-    indexBlogCategoryRequest: ...,
-  } satisfies IndexBlogCategoryOperationRequest;
-
-  try {
-    const data = await api.indexBlogCategory(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexBlogCategoryRequest** | [IndexBlogCategoryRequest](IndexBlogCategoryRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedBlogCategoryListResourceResponse**](PaginatedBlogCategoryListResourceResponse.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<\\BlogCategoryListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## showBlogCategory
-
-> BlogCategoryResource showBlogCategory(blogCategory)
-
-Auto-generated: showBlogCategory
-
-### Example
-
-```ts
-import {
-  Configuration,
-  BlogCategoryApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowBlogCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new BlogCategoryApi();
-
-  const body = {
-    // number | The id of the blogCategory
-    blogCategory: 56,
-  } satisfies ShowBlogCategoryRequest;
-
-  try {
-    const data = await api.showBlogCategory(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **blogCategory** | `number` | The id of the blogCategory | [Defaults to `undefined`] |
-
-### Return type
-
-[**BlogCategoryResource**](BlogCategoryResource.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)
-
-
-## storeBlogCategory
-
-> BlogCategoryResource storeBlogCategory(storeBlogCategoryRequest)
-
-Auto-generated: storeBlogCategory
-
-### Example
-
-```ts
-import {
-  Configuration,
-  BlogCategoryApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreBlogCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new BlogCategoryApi();
-
-  const body = {
-    // StoreBlogCategoryRequest (optional)
-    storeBlogCategoryRequest: ...,
-  } satisfies StoreBlogCategoryOperationRequest;
-
-  try {
-    const data = await api.storeBlogCategory(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeBlogCategoryRequest** | [StoreBlogCategoryRequest](StoreBlogCategoryRequest.md) |  | [Optional] |
-
-### Return type
-
-[**BlogCategoryResource**](BlogCategoryResource.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)
-
-
-## updateBlogCategory
-
-> BlogCategoryResource updateBlogCategory(blogCategory, updateBlogCategoryRequest)
-
-Auto-generated: updateBlogCategory
-
-### Example
-
-```ts
-import {
-  Configuration,
-  BlogCategoryApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateBlogCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new BlogCategoryApi();
-
-  const body = {
-    // number | The id of the blogCategory
-    blogCategory: 56,
-    // UpdateBlogCategoryRequest (optional)
-    updateBlogCategoryRequest: ...,
-  } satisfies UpdateBlogCategoryOperationRequest;
-
-  try {
-    const data = await api.updateBlogCategory(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **blogCategory** | `number` | The id of the blogCategory | [Defaults to `undefined`] |
-| **updateBlogCategoryRequest** | [UpdateBlogCategoryRequest](UpdateBlogCategoryRequest.md) |  | [Optional] |
-
-### Return type
-
-[**BlogCategoryResource**](BlogCategoryResource.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/BlogCategoryListResource.md

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

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

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

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

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

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

@@ -1,52 +0,0 @@
-
-# BlogFrontendDetailResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`slug` | string
-`excerpt` | string
-`featured` | boolean
-`thumbnail` | [AssetResource](AssetResource.md)
-`startDate` | Date
-`categories` | object
-`pageComponents` | object
-`seo` | [Array<SEOResource>](SEOResource.md)
-
-## Example
-
-```typescript
-import type { BlogFrontendDetailResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "slug": null,
-  "excerpt": null,
-  "featured": null,
-  "thumbnail": null,
-  "startDate": null,
-  "categories": null,
-  "pageComponents": null,
-  "seo": null,
-} satisfies BlogFrontendDetailResource
-
-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 BlogFrontendDetailResource
-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)
-
-