@digital8/lighting-illusions-ts-sdk 0.0.1628 → 0.0.1630

package/dist/models/index.d.ts

@@ -39,6 +39,8 @@ export * from './AttributeResourceArrayResponse';
 export * from './AttributeType';
 export * from './AttributeValueResource';
 export * from './AttributeValueResourceArrayResponse';
+export * from './BlogCategoryFrontendResource';
+export * from './BlogCategoryFrontendResourceArrayResponse';
 export * from './BlogCategoryListResource';
 export * from './BlogCategoryListResourceArrayResponse';
 export * from './BlogCategoryLiteResource';
@@ -89,6 +91,7 @@ export * from './ExternalApiSyncStatus';
 export * from './GenericResponse';
 export * from './GetAllAttributeRequest';
 export * from './GetAllAttributeValueRequest';
+export * from './GetAllBlogCategoryRequest';
 export * from './GetAllDefinitionRequest';
 export * from './GetAllDocumentRequest';
 export * from './GetAllGoogleCategoryRequest';
@@ -114,6 +117,7 @@ export * from './GoogleCategoryResource';
 export * from './GoogleCategoryResourceArrayResponse';
 export * from './IndexAttributeRequest';
 export * from './IndexAttributeValueRequest';
+export * from './IndexBlogCategoryRequest';
 export * from './IndexDefinitionRequest';
 export * from './IndexDocumentRequest';
 export * from './IndexExternalApiLogRequest';
@@ -312,6 +316,7 @@ export * from './StoreAssetFileRequest';
 export * from './StoreAssetForAssetableRequest';
 export * from './StoreAttributeRequest';
 export * from './StoreAttributeValueRequest';
+export * from './StoreBlogCategoryRequest';
 export * from './StoreDefinitionRequest';
 export * from './StoreDocumentFileRequest';
 export * from './StoreDocumentRequest';
@@ -370,6 +375,7 @@ export * from './TagType';
 export * from './UpdateAssetForAssetableRequest';
 export * from './UpdateAttributeRequest';
 export * from './UpdateAttributeValueRequest';
+export * from './UpdateBlogCategoryRequest';
 export * from './UpdateDefinitionRequest';
 export * from './UpdateDocumentRequest';
 export * from './UpdateFilterOrderAttributeRequest';

package/dist/models/index.js

@@ -57,6 +57,8 @@ __exportStar(require("./AttributeResourceArrayResponse"), exports);
 __exportStar(require("./AttributeType"), exports);
 __exportStar(require("./AttributeValueResource"), exports);
 __exportStar(require("./AttributeValueResourceArrayResponse"), exports);
+__exportStar(require("./BlogCategoryFrontendResource"), exports);
+__exportStar(require("./BlogCategoryFrontendResourceArrayResponse"), exports);
 __exportStar(require("./BlogCategoryListResource"), exports);
 __exportStar(require("./BlogCategoryListResourceArrayResponse"), exports);
 __exportStar(require("./BlogCategoryLiteResource"), exports);
@@ -107,6 +109,7 @@ __exportStar(require("./ExternalApiSyncStatus"), exports);
 __exportStar(require("./GenericResponse"), exports);
 __exportStar(require("./GetAllAttributeRequest"), exports);
 __exportStar(require("./GetAllAttributeValueRequest"), exports);
+__exportStar(require("./GetAllBlogCategoryRequest"), exports);
 __exportStar(require("./GetAllDefinitionRequest"), exports);
 __exportStar(require("./GetAllDocumentRequest"), exports);
 __exportStar(require("./GetAllGoogleCategoryRequest"), exports);
@@ -132,6 +135,7 @@ __exportStar(require("./GoogleCategoryResource"), exports);
 __exportStar(require("./GoogleCategoryResourceArrayResponse"), exports);
 __exportStar(require("./IndexAttributeRequest"), exports);
 __exportStar(require("./IndexAttributeValueRequest"), exports);
+__exportStar(require("./IndexBlogCategoryRequest"), exports);
 __exportStar(require("./IndexDefinitionRequest"), exports);
 __exportStar(require("./IndexDocumentRequest"), exports);
 __exportStar(require("./IndexExternalApiLogRequest"), exports);
@@ -330,6 +334,7 @@ __exportStar(require("./StoreAssetFileRequest"), exports);
 __exportStar(require("./StoreAssetForAssetableRequest"), exports);
 __exportStar(require("./StoreAttributeRequest"), exports);
 __exportStar(require("./StoreAttributeValueRequest"), exports);
+__exportStar(require("./StoreBlogCategoryRequest"), exports);
 __exportStar(require("./StoreDefinitionRequest"), exports);
 __exportStar(require("./StoreDocumentFileRequest"), exports);
 __exportStar(require("./StoreDocumentRequest"), exports);
@@ -388,6 +393,7 @@ __exportStar(require("./TagType"), exports);
 __exportStar(require("./UpdateAssetForAssetableRequest"), exports);
 __exportStar(require("./UpdateAttributeRequest"), exports);
 __exportStar(require("./UpdateAttributeValueRequest"), exports);
+__exportStar(require("./UpdateBlogCategoryRequest"), exports);
 __exportStar(require("./UpdateDefinitionRequest"), exports);
 __exportStar(require("./UpdateDocumentRequest"), exports);
 __exportStar(require("./UpdateFilterOrderAttributeRequest"), exports);

package/docs/BlogCategoriesApi.md

@@ -0,0 +1,407 @@
+# BlogCategoriesApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyBlogCategory**](BlogCategoriesApi.md#destroyblogcategory) | **DELETE** /admin-api/blog-categories/{blogCategory}/delete | Auto-generated: destroyBlogCategory |
+| [**getAllBlogCategory**](BlogCategoriesApi.md#getallblogcategoryoperation) | **POST** /admin-api/blog-categories/all | Auto-generated: getAllBlogCategory |
+| [**indexBlogCategory**](BlogCategoriesApi.md#indexblogcategoryoperation) | **POST** /admin-api/blog-categories/list | Auto-generated: indexBlogCategory |
+| [**showBlogCategory**](BlogCategoriesApi.md#showblogcategory) | **GET** /admin-api/blog-categories/{blogCategory} | Auto-generated: showBlogCategory |
+| [**storeBlogCategory**](BlogCategoriesApi.md#storeblogcategoryoperation) | **POST** /admin-api/blog-categories/create | Auto-generated: storeBlogCategory |
+| [**updateBlogCategory**](BlogCategoriesApi.md#updateblogcategoryoperation) | **PUT** /admin-api/blog-categories/{blogCategory}/update | Auto-generated: updateBlogCategory |
+
+
+
+## destroyBlogCategory
+
+> GenericResponse destroyBlogCategory(blogCategory)
+
+Auto-generated: destroyBlogCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BlogCategoriesApi,
+} 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 BlogCategoriesApi();
+
+  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,
+  BlogCategoriesApi,
+} 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 BlogCategoriesApi();
+
+  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,
+  BlogCategoriesApi,
+} 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 BlogCategoriesApi();
+
+  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,
+  BlogCategoriesApi,
+} 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 BlogCategoriesApi();
+
+  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,
+  BlogCategoriesApi,
+} 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 BlogCategoriesApi();
+
+  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,
+  BlogCategoriesApi,
+} 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 BlogCategoriesApi();
+
+  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/BlogCategoryFrontendResource.md

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

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

@@ -0,0 +1,44 @@
+
+# GetAllBlogCategoryRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { GetAllBlogCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies GetAllBlogCategoryRequest
+
+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 GetAllBlogCategoryRequest
+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/IndexBlogCategoryRequest.md

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

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

@@ -9,7 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `hours` | string
-`date` | string
+`date` | object
 `closed` | boolean
 `displayStartDate` | string
 `displayEndDate` | string