@digital8/lighting-illusions-ts-sdk 0.0.1235 → 0.0.1237

package/docs/StoreApi.md

@@ -0,0 +1,683 @@
+# StoreApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**attachSuppliersStore**](StoreApi.md#attachsuppliersstoreoperation) | **POST** /admin-api/store/{store}/attach-suppliers | Auto-generated: attachSuppliersStore |
+| [**destroyStore**](StoreApi.md#destroystore) | **DELETE** /admin-api/store/{store}/delete | Auto-generated: destroyStore |
+| [**destroyStoreSpecialDate**](StoreApi.md#destroystorespecialdate) | **DELETE** /admin-api/store/{store}/special-dates/{storeSpecialDate} | Auto-generated: destroyStoreSpecialDate |
+| [**detachSuppliersStore**](StoreApi.md#detachsuppliersstoreoperation) | **POST** /admin-api/store/{store}/detach-suppliers | Auto-generated: detachSuppliersStore |
+| [**getAllStore**](StoreApi.md#getallstoreoperation) | **POST** /admin-api/store/all | Auto-generated: getAllStore |
+| [**indexStore**](StoreApi.md#indexstoreoperation) | **POST** /admin-api/store/list | Auto-generated: indexStore |
+| [**showStore**](StoreApi.md#showstore) | **GET** /admin-api/store/{store} | Auto-generated: showStore |
+| [**storeStore**](StoreApi.md#storestoreoperation) | **POST** /admin-api/store/create | Auto-generated: storeStore |
+| [**storeStoreSpecialDate**](StoreApi.md#storestorespecialdateoperation) | **POST** /admin-api/store/{store}/special-dates | Auto-generated: storeStoreSpecialDate |
+| [**updateStore**](StoreApi.md#updatestoreoperation) | **PUT** /admin-api/store/{store}/update | Auto-generated: updateStore |
+
+
+
+## attachSuppliersStore
+
+> StoreResource attachSuppliersStore(store, attachSuppliersStoreRequest)
+
+Auto-generated: attachSuppliersStore
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { AttachSuppliersStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // number | The id of the store
+    store: 56,
+    // AttachSuppliersStoreRequest (optional)
+    attachSuppliersStoreRequest: ...,
+  } satisfies AttachSuppliersStoreOperationRequest;
+
+  try {
+    const data = await api.attachSuppliersStore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **store** | `number` | The id of the store | [Defaults to `undefined`] |
+| **attachSuppliersStoreRequest** | [AttachSuppliersStoreRequest](AttachSuppliersStoreRequest.md) |  | [Optional] |
+
+### Return type
+
+[**StoreResource**](StoreResource.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)
+
+
+## destroyStore
+
+> GenericResponse destroyStore(store)
+
+Auto-generated: destroyStore
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyStoreRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // number | The id of the store
+    store: 56,
+  } satisfies DestroyStoreRequest;
+
+  try {
+    const data = await api.destroyStore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **store** | `number` | The id of the store | [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<array{message: string}> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## destroyStoreSpecialDate
+
+> GenericResponse destroyStoreSpecialDate(store, storeSpecialDate)
+
+Auto-generated: destroyStoreSpecialDate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyStoreSpecialDateRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // number | The id of the store
+    store: 56,
+    // number | The id of the storeSpecialDate
+    storeSpecialDate: 56,
+  } satisfies DestroyStoreSpecialDateRequest;
+
+  try {
+    const data = await api.destroyStoreSpecialDate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **store** | `number` | The id of the store | [Defaults to `undefined`] |
+| **storeSpecialDate** | `number` | The id of the storeSpecialDate | [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<array{message: string}> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## detachSuppliersStore
+
+> StoreResource detachSuppliersStore(store, detachSuppliersStoreRequest)
+
+Auto-generated: detachSuppliersStore
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DetachSuppliersStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // number | The id of the store
+    store: 56,
+    // DetachSuppliersStoreRequest (optional)
+    detachSuppliersStoreRequest: ...,
+  } satisfies DetachSuppliersStoreOperationRequest;
+
+  try {
+    const data = await api.detachSuppliersStore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **store** | `number` | The id of the store | [Defaults to `undefined`] |
+| **detachSuppliersStoreRequest** | [DetachSuppliersStoreRequest](DetachSuppliersStoreRequest.md) |  | [Optional] |
+
+### Return type
+
+[**StoreResource**](StoreResource.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)
+
+
+## getAllStore
+
+> StoreLiteResource getAllStore(getAllStoreRequest)
+
+Auto-generated: getAllStore
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // GetAllStoreRequest (optional)
+    getAllStoreRequest: ...,
+  } satisfies GetAllStoreOperationRequest;
+
+  try {
+    const data = await api.getAllStore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAllStoreRequest** | [GetAllStoreRequest](GetAllStoreRequest.md) |  | [Optional] |
+
+### Return type
+
+[**StoreLiteResource**](StoreLiteResource.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)
+
+
+## indexStore
+
+> PaginatedStoreListResourceResponse indexStore(indexStoreRequest)
+
+Auto-generated: indexStore
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // IndexStoreRequest (optional)
+    indexStoreRequest: ...,
+  } satisfies IndexStoreOperationRequest;
+
+  try {
+    const data = await api.indexStore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexStoreRequest** | [IndexStoreRequest](IndexStoreRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedStoreListResourceResponse**](PaginatedStoreListResourceResponse.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<\\StoreListResource>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showStore
+
+> StoreResource showStore(store)
+
+Auto-generated: showStore
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowStoreRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // number | The id of the store
+    store: 56,
+  } satisfies ShowStoreRequest;
+
+  try {
+    const data = await api.showStore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **store** | `number` | The id of the store | [Defaults to `undefined`] |
+
+### Return type
+
+[**StoreResource**](StoreResource.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)
+
+
+## storeStore
+
+> StoreResource storeStore(storeStoreRequest)
+
+Auto-generated: storeStore
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // StoreStoreRequest (optional)
+    storeStoreRequest: ...,
+  } satisfies StoreStoreOperationRequest;
+
+  try {
+    const data = await api.storeStore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeStoreRequest** | [StoreStoreRequest](StoreStoreRequest.md) |  | [Optional] |
+
+### Return type
+
+[**StoreResource**](StoreResource.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)
+
+
+## storeStoreSpecialDate
+
+> StoreSpecialDateResource storeStoreSpecialDate(store, storeStoreSpecialDateRequest)
+
+Auto-generated: storeStoreSpecialDate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreStoreSpecialDateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // number | The id of the store
+    store: 56,
+    // StoreStoreSpecialDateRequest (optional)
+    storeStoreSpecialDateRequest: ...,
+  } satisfies StoreStoreSpecialDateOperationRequest;
+
+  try {
+    const data = await api.storeStoreSpecialDate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **store** | `number` | The id of the store | [Defaults to `undefined`] |
+| **storeStoreSpecialDateRequest** | [StoreStoreSpecialDateRequest](StoreStoreSpecialDateRequest.md) |  | [Optional] |
+
+### Return type
+
+[**StoreSpecialDateResource**](StoreSpecialDateResource.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)
+
+
+## updateStore
+
+> StoreResource updateStore(store, updateStoreRequest)
+
+Auto-generated: updateStore
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // number | The id of the store
+    store: 56,
+    // UpdateStoreRequest (optional)
+    updateStoreRequest: ...,
+  } satisfies UpdateStoreOperationRequest;
+
+  try {
+    const data = await api.updateStore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **store** | `number` | The id of the store | [Defaults to `undefined`] |
+| **updateStoreRequest** | [UpdateStoreRequest](UpdateStoreRequest.md) |  | [Optional] |
+
+### Return type
+
+[**StoreResource**](StoreResource.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)
+