@digital8/lighting-illusions-ts-sdk 0.0.2375 → 0.0.2377

package/docs/ReturnsApi.md

@@ -1,545 +0,0 @@
-# ReturnsApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**attachAssetsReturn**](ReturnsApi.md#attachassetsreturn) | **POST** /admin-api/returns/{productReturn}/assets/attach | Auto-generated: attachAssetsReturn |
-| [**destroyReturn**](ReturnsApi.md#destroyreturn) | **DELETE** /admin-api/returns/{productReturn}/delete | Auto-generated: destroyReturn |
-| [**detachAssetsReturn**](ReturnsApi.md#detachassetsreturn) | **POST** /admin-api/returns/{productReturn}/assets/detach | Auto-generated: detachAssetsReturn |
-| [**getAllReturn**](ReturnsApi.md#getallreturn) | **POST** /admin-api/returns/all | Auto-generated: getAllReturn |
-| [**indexReturn**](ReturnsApi.md#indexreturn) | **POST** /admin-api/returns/list | Auto-generated: indexReturn |
-| [**showReturn**](ReturnsApi.md#showreturn) | **GET** /admin-api/returns/{productReturn} | Auto-generated: showReturn |
-| [**storeReturn**](ReturnsApi.md#storereturn) | **POST** /admin-api/returns/create | Auto-generated: storeReturn |
-| [**updateReturn**](ReturnsApi.md#updatereturnoperation) | **PUT** /admin-api/returns/{productReturn}/update | Auto-generated: updateReturn |
-
-
-
-## attachAssetsReturn
-
-> ReturnResource attachAssetsReturn(productReturn, attachReturnAssetsRequest)
-
-Auto-generated: attachAssetsReturn
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReturnsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachAssetsReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReturnsApi();
-
-  const body = {
-    // number | The id of the productReturn
-    productReturn: 56,
-    // AttachReturnAssetsRequest (optional)
-    attachReturnAssetsRequest: ...,
-  } satisfies AttachAssetsReturnRequest;
-
-  try {
-    const data = await api.attachAssetsReturn(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productReturn** | `number` | The id of the productReturn | [Defaults to `undefined`] |
-| **attachReturnAssetsRequest** | [AttachReturnAssetsRequest](AttachReturnAssetsRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ReturnResource**](ReturnResource.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)
-
-
-## destroyReturn
-
-> GenericResponse destroyReturn(productReturn)
-
-Auto-generated: destroyReturn
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReturnsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReturnsApi();
-
-  const body = {
-    // number | The id of the productReturn
-    productReturn: 56,
-  } satisfies DestroyReturnRequest;
-
-  try {
-    const data = await api.destroyReturn(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productReturn** | `number` | The id of the productReturn | [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)
-
-
-## detachAssetsReturn
-
-> ReturnResource detachAssetsReturn(productReturn, detachReturnAssetsRequest)
-
-Auto-generated: detachAssetsReturn
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReturnsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachAssetsReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReturnsApi();
-
-  const body = {
-    // number | The id of the productReturn
-    productReturn: 56,
-    // DetachReturnAssetsRequest (optional)
-    detachReturnAssetsRequest: ...,
-  } satisfies DetachAssetsReturnRequest;
-
-  try {
-    const data = await api.detachAssetsReturn(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productReturn** | `number` | The id of the productReturn | [Defaults to `undefined`] |
-| **detachReturnAssetsRequest** | [DetachReturnAssetsRequest](DetachReturnAssetsRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ReturnResource**](ReturnResource.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)
-
-
-## getAllReturn
-
-> ReturnLiteResourceArrayResponse getAllReturn(searchReturnsRequest)
-
-Auto-generated: getAllReturn
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReturnsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReturnsApi();
-
-  const body = {
-    // SearchReturnsRequest (optional)
-    searchReturnsRequest: ...,
-  } satisfies GetAllReturnRequest;
-
-  try {
-    const data = await api.getAllReturn(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchReturnsRequest** | [SearchReturnsRequest](SearchReturnsRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ReturnLiteResourceArrayResponse**](ReturnLiteResourceArrayResponse.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)
-
-
-## indexReturn
-
-> PaginatedReturnListResourceResponse indexReturn(searchReturnsRequest)
-
-Auto-generated: indexReturn
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReturnsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReturnsApi();
-
-  const body = {
-    // SearchReturnsRequest (optional)
-    searchReturnsRequest: ...,
-  } satisfies IndexReturnRequest;
-
-  try {
-    const data = await api.indexReturn(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchReturnsRequest** | [SearchReturnsRequest](SearchReturnsRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedReturnListResourceResponse**](PaginatedReturnListResourceResponse.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<\\ReturnListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## showReturn
-
-> ReturnResource showReturn(productReturn)
-
-Auto-generated: showReturn
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReturnsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReturnsApi();
-
-  const body = {
-    // number | The id of the productReturn
-    productReturn: 56,
-  } satisfies ShowReturnRequest;
-
-  try {
-    const data = await api.showReturn(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productReturn** | `number` | The id of the productReturn | [Defaults to `undefined`] |
-
-### Return type
-
-[**ReturnResource**](ReturnResource.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)
-
-
-## storeReturn
-
-> ReturnResource storeReturn(createReturnRequest)
-
-Auto-generated: storeReturn
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReturnsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReturnsApi();
-
-  const body = {
-    // CreateReturnRequest (optional)
-    createReturnRequest: ...,
-  } satisfies StoreReturnRequest;
-
-  try {
-    const data = await api.storeReturn(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **createReturnRequest** | [CreateReturnRequest](CreateReturnRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ReturnResource**](ReturnResource.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)
-
-
-## updateReturn
-
-> ReturnResource updateReturn(productReturn, updateReturnRequest)
-
-Auto-generated: updateReturn
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReturnsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateReturnOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReturnsApi();
-
-  const body = {
-    // number | The id of the productReturn
-    productReturn: 56,
-    // UpdateReturnRequest (optional)
-    updateReturnRequest: ...,
-  } satisfies UpdateReturnOperationRequest;
-
-  try {
-    const data = await api.updateReturn(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productReturn** | `number` | The id of the productReturn | [Defaults to `undefined`] |
-| **updateReturnRequest** | [UpdateReturnRequest](UpdateReturnRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ReturnResource**](ReturnResource.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/RoleListResource.md

@@ -1,48 +0,0 @@
-
-# RoleListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`isLocked` | boolean
-`permissionCount` | number
-`adminsCount` | number
-`permissions` | object
-`createdAt` | Date
-`updatedAt` | Date
-
-## Example
-
-```typescript
-import type { RoleListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "isLocked": null,
-  "permissionCount": null,
-  "adminsCount": null,
-  "permissions": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies RoleListResource
-
-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 RoleListResource
-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/RoleListResourceArrayResponse.md

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

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

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