@digital8/lighting-illusions-ts-sdk 0.0.1884 → 0.0.1886

package/docs/SiteApi.md

@@ -6,10 +6,10 @@ All URIs are relative to *http://localhost/api*
 |------------- | ------------- | -------------|
 | [**destroySiteNotification**](SiteApi.md#destroysitenotification) | **DELETE** /admin-api/site/notification/{siteNotification}/delete | Auto-generated: destroySiteNotification |
 | [**getAllSite**](SiteApi.md#getallsite) | **POST** /admin-api/site/all | Auto-generated: getAllSite |
-| [**indexSite**](SiteApi.md#indexsiteoperation) | **POST** /admin-api/site/list | Auto-generated: indexSite |
-| [**indexSiteNotification**](SiteApi.md#indexsitenotificationoperation) | **POST** /admin-api/site/notification/list | Auto-generated: indexSiteNotification |
+| [**indexSite**](SiteApi.md#indexsite) | **POST** /admin-api/site/list | Auto-generated: indexSite |
+| [**indexSiteNotification**](SiteApi.md#indexsitenotification) | **POST** /admin-api/site/notification/list | Auto-generated: indexSiteNotification |
 | [**showSite**](SiteApi.md#showsite) | **GET** /admin-api/site/{site} | Auto-generated: showSite |
-| [**storeSiteNotification**](SiteApi.md#storesitenotificationoperation) | **POST** /admin-api/site/notification/create | Auto-generated: storeSiteNotification |
+| [**storeSiteNotification**](SiteApi.md#storesitenotification) | **POST** /admin-api/site/notification/create | Auto-generated: storeSiteNotification |
 | [**updateSite**](SiteApi.md#updatesiteoperation) | **PUT** /admin-api/site/{site}/update | Auto-generated: updateSite |
 | [**updateSiteNotification**](SiteApi.md#updatesitenotificationoperation) | **PUT** /admin-api/site/notification/{siteNotification}/update | Auto-generated: updateSiteNotification |
 
@@ -82,7 +82,7 @@ No authorization required
 
 ## getAllSite
 
-> SiteLiteResourceArrayResponse getAllSite(indexSiteRequest)
+> SiteLiteResourceArrayResponse getAllSite(searchSitesRequest)
 
 Auto-generated: getAllSite
 
@@ -100,8 +100,8 @@ async function example() {
   const api = new SiteApi();
 
   const body = {
-    // IndexSiteRequest (optional)
-    indexSiteRequest: ...,
+    // SearchSitesRequest (optional)
+    searchSitesRequest: ...,
   } satisfies GetAllSiteRequest;
 
   try {
@@ -121,7 +121,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **indexSiteRequest** | [IndexSiteRequest](IndexSiteRequest.md) |  | [Optional] |
+| **searchSitesRequest** | [SearchSitesRequest](SearchSitesRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -147,7 +147,7 @@ No authorization required
 
 ## indexSite
 
-> PaginatedSiteListResourceResponse indexSite(indexSiteRequest)
+> PaginatedSiteListResourceResponse indexSite(searchSitesRequest)
 
 Auto-generated: indexSite
 
@@ -158,16 +158,16 @@ import {
   Configuration,
   SiteApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexSiteOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexSiteRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
   const api = new SiteApi();
 
   const body = {
-    // IndexSiteRequest (optional)
-    indexSiteRequest: ...,
-  } satisfies IndexSiteOperationRequest;
+    // SearchSitesRequest (optional)
+    searchSitesRequest: ...,
+  } satisfies IndexSiteRequest;
 
   try {
     const data = await api.indexSite(body);
@@ -186,7 +186,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **indexSiteRequest** | [IndexSiteRequest](IndexSiteRequest.md) |  | [Optional] |
+| **searchSitesRequest** | [SearchSitesRequest](SearchSitesRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -212,7 +212,7 @@ No authorization required
 
 ## indexSiteNotification
 
-> PaginatedSiteNotificationListResourceResponse indexSiteNotification(indexSiteNotificationRequest)
+> PaginatedSiteNotificationListResourceResponse indexSiteNotification(searchSiteNotificationsRequest)
 
 Auto-generated: indexSiteNotification
 
@@ -223,16 +223,16 @@ import {
   Configuration,
   SiteApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexSiteNotificationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexSiteNotificationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
   const api = new SiteApi();
 
   const body = {
-    // IndexSiteNotificationRequest (optional)
-    indexSiteNotificationRequest: ...,
-  } satisfies IndexSiteNotificationOperationRequest;
+    // SearchSiteNotificationsRequest (optional)
+    searchSiteNotificationsRequest: ...,
+  } satisfies IndexSiteNotificationRequest;
 
   try {
     const data = await api.indexSiteNotification(body);
@@ -251,7 +251,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **indexSiteNotificationRequest** | [IndexSiteNotificationRequest](IndexSiteNotificationRequest.md) |  | [Optional] |
+| **searchSiteNotificationsRequest** | [SearchSiteNotificationsRequest](SearchSiteNotificationsRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -342,7 +342,7 @@ No authorization required
 
 ## storeSiteNotification
 
-> SiteNotificationResource storeSiteNotification(storeSiteNotificationRequest)
+> SiteNotificationResource storeSiteNotification(createSiteNotificationRequest)
 
 Auto-generated: storeSiteNotification
 
@@ -353,16 +353,16 @@ import {
   Configuration,
   SiteApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreSiteNotificationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreSiteNotificationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
   const api = new SiteApi();
 
   const body = {
-    // StoreSiteNotificationRequest (optional)
-    storeSiteNotificationRequest: ...,
-  } satisfies StoreSiteNotificationOperationRequest;
+    // CreateSiteNotificationRequest (optional)
+    createSiteNotificationRequest: ...,
+  } satisfies StoreSiteNotificationRequest;
 
   try {
     const data = await api.storeSiteNotification(body);
@@ -381,7 +381,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **storeSiteNotificationRequest** | [StoreSiteNotificationRequest](StoreSiteNotificationRequest.md) |  | [Optional] |
+| **createSiteNotificationRequest** | [CreateSiteNotificationRequest](CreateSiteNotificationRequest.md) |  | [Optional] |
 
 ### Return type
 

package/docs/SiteIdRequest.md

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

@@ -4,15 +4,15 @@ 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 |
+| [**attachSuppliersStore**](StoreApi.md#attachsuppliersstore) | **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 |
+| [**detachSuppliersStore**](StoreApi.md#detachsuppliersstore) | **POST** /admin-api/store/{store}/detach-suppliers | Auto-generated: detachSuppliersStore |
+| [**getAllStore**](StoreApi.md#getallstore) | **POST** /admin-api/store/all | Auto-generated: getAllStore |
+| [**indexStore**](StoreApi.md#indexstore) | **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 |
+| [**storeStore**](StoreApi.md#storestore) | **POST** /admin-api/store/create | Auto-generated: storeStore |
+| [**storeStoreSpecialDate**](StoreApi.md#storestorespecialdate) | **POST** /admin-api/store/{store}/special-dates | Auto-generated: storeStoreSpecialDate |
 | [**updateStore**](StoreApi.md#updatestoreoperation) | **PUT** /admin-api/store/{store}/update | Auto-generated: updateStore |
 | [**updateStoreSpecialDate**](StoreApi.md#updatestorespecialdate) | **PUT** /admin-api/store/{store}/special-dates/{storeSpecialDate} | Auto-generated: updateStoreSpecialDate |
 
@@ -20,7 +20,7 @@ All URIs are relative to *http://localhost/api*
 
 ## attachSuppliersStore
 
-> StoreResource attachSuppliersStore(store, attachSuppliersStoreRequest)
+> StoreResource attachSuppliersStore(store, attachSuppliersToStoreRequest)
 
 Auto-generated: attachSuppliersStore
 
@@ -31,7 +31,7 @@ import {
   Configuration,
   StoreApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachSuppliersStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { AttachSuppliersStoreRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
@@ -40,9 +40,9 @@ async function example() {
   const body = {
     // number | The id of the store
     store: 56,
-    // AttachSuppliersStoreRequest (optional)
-    attachSuppliersStoreRequest: ...,
-  } satisfies AttachSuppliersStoreOperationRequest;
+    // AttachSuppliersToStoreRequest (optional)
+    attachSuppliersToStoreRequest: ...,
+  } satisfies AttachSuppliersStoreRequest;
 
   try {
     const data = await api.attachSuppliersStore(body);
@@ -62,7 +62,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **store** | `number` | The id of the store | [Defaults to `undefined`] |
-| **attachSuppliersStoreRequest** | [AttachSuppliersStoreRequest](AttachSuppliersStoreRequest.md) |  | [Optional] |
+| **attachSuppliersToStoreRequest** | [AttachSuppliersToStoreRequest](AttachSuppliersToStoreRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -221,7 +221,7 @@ No authorization required
 
 ## detachSuppliersStore
 
-> StoreResource detachSuppliersStore(store, detachSuppliersStoreRequest)
+> StoreResource detachSuppliersStore(store, detachSuppliersFromStoreRequest)
 
 Auto-generated: detachSuppliersStore
 
@@ -232,7 +232,7 @@ import {
   Configuration,
   StoreApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachSuppliersStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { DetachSuppliersStoreRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
@@ -241,9 +241,9 @@ async function example() {
   const body = {
     // number | The id of the store
     store: 56,
-    // DetachSuppliersStoreRequest (optional)
-    detachSuppliersStoreRequest: ...,
-  } satisfies DetachSuppliersStoreOperationRequest;
+    // DetachSuppliersFromStoreRequest (optional)
+    detachSuppliersFromStoreRequest: ...,
+  } satisfies DetachSuppliersStoreRequest;
 
   try {
     const data = await api.detachSuppliersStore(body);
@@ -263,7 +263,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **store** | `number` | The id of the store | [Defaults to `undefined`] |
-| **detachSuppliersStoreRequest** | [DetachSuppliersStoreRequest](DetachSuppliersStoreRequest.md) |  | [Optional] |
+| **detachSuppliersFromStoreRequest** | [DetachSuppliersFromStoreRequest](DetachSuppliersFromStoreRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -289,7 +289,7 @@ No authorization required
 
 ## getAllStore
 
-> StoreListResourceArrayResponse getAllStore(getAllStoreRequest)
+> StoreListResourceArrayResponse getAllStore(searchAllStoresRequest)
 
 Auto-generated: getAllStore
 
@@ -300,16 +300,16 @@ import {
   Configuration,
   StoreApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllStoreRequest } 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;
+    // SearchAllStoresRequest (optional)
+    searchAllStoresRequest: ...,
+  } satisfies GetAllStoreRequest;
 
   try {
     const data = await api.getAllStore(body);
@@ -328,7 +328,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getAllStoreRequest** | [GetAllStoreRequest](GetAllStoreRequest.md) |  | [Optional] |
+| **searchAllStoresRequest** | [SearchAllStoresRequest](SearchAllStoresRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -354,7 +354,7 @@ No authorization required
 
 ## indexStore
 
-> PaginatedStoreListResourceResponse indexStore(indexStoreRequest)
+> PaginatedStoreListResourceResponse indexStore(searchStoresRequest)
 
 Auto-generated: indexStore
 
@@ -365,16 +365,16 @@ import {
   Configuration,
   StoreApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexStoreRequest } 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;
+    // SearchStoresRequest (optional)
+    searchStoresRequest: ...,
+  } satisfies IndexStoreRequest;
 
   try {
     const data = await api.indexStore(body);
@@ -393,7 +393,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **indexStoreRequest** | [IndexStoreRequest](IndexStoreRequest.md) |  | [Optional] |
+| **searchStoresRequest** | [SearchStoresRequest](SearchStoresRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -484,7 +484,7 @@ No authorization required
 
 ## storeStore
 
-> StoreResource storeStore(storeStoreRequest)
+> StoreResource storeStore(createStoreRequest)
 
 Auto-generated: storeStore
 
@@ -495,16 +495,16 @@ import {
   Configuration,
   StoreApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreStoreOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreStoreRequest } 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;
+    // CreateStoreRequest (optional)
+    createStoreRequest: ...,
+  } satisfies StoreStoreRequest;
 
   try {
     const data = await api.storeStore(body);
@@ -523,7 +523,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **storeStoreRequest** | [StoreStoreRequest](StoreStoreRequest.md) |  | [Optional] |
+| **createStoreRequest** | [CreateStoreRequest](CreateStoreRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -549,7 +549,7 @@ No authorization required
 
 ## storeStoreSpecialDate
 
-> StoreSpecialDateResource storeStoreSpecialDate(store, storeStoreSpecialDateRequest)
+> StoreSpecialDateResource storeStoreSpecialDate(store, storeSpecialDateRequest)
 
 Auto-generated: storeStoreSpecialDate
 
@@ -560,7 +560,7 @@ import {
   Configuration,
   StoreApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreStoreSpecialDateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreStoreSpecialDateRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
@@ -569,9 +569,9 @@ async function example() {
   const body = {
     // number | The id of the store
     store: 56,
-    // StoreStoreSpecialDateRequest (optional)
-    storeStoreSpecialDateRequest: ...,
-  } satisfies StoreStoreSpecialDateOperationRequest;
+    // StoreSpecialDateRequest (optional)
+    storeSpecialDateRequest: ...,
+  } satisfies StoreStoreSpecialDateRequest;
 
   try {
     const data = await api.storeStoreSpecialDate(body);
@@ -591,7 +591,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **store** | `number` | The id of the store | [Defaults to `undefined`] |
-| **storeStoreSpecialDateRequest** | [StoreStoreSpecialDateRequest](StoreStoreSpecialDateRequest.md) |  | [Optional] |
+| **storeSpecialDateRequest** | [StoreSpecialDateRequest](StoreSpecialDateRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -685,7 +685,7 @@ No authorization required
 
 ## updateStoreSpecialDate
 
-> StoreSpecialDateResource updateStoreSpecialDate(store, storeSpecialDate, storeStoreSpecialDateRequest)
+> StoreSpecialDateResource updateStoreSpecialDate(store, storeSpecialDate, storeSpecialDateRequest)
 
 Auto-generated: updateStoreSpecialDate
 
@@ -707,8 +707,8 @@ async function example() {
     store: 56,
     // number | The id of the storeSpecialDate
     storeSpecialDate: 56,
-    // StoreStoreSpecialDateRequest (optional)
-    storeStoreSpecialDateRequest: ...,
+    // StoreSpecialDateRequest (optional)
+    storeSpecialDateRequest: ...,
   } satisfies UpdateStoreSpecialDateRequest;
 
   try {
@@ -730,7 +730,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **store** | `number` | The id of the store | [Defaults to `undefined`] |
 | **storeSpecialDate** | `number` | The id of the storeSpecialDate | [Defaults to `undefined`] |
-| **storeStoreSpecialDateRequest** | [StoreStoreSpecialDateRequest](StoreStoreSpecialDateRequest.md) |  | [Optional] |
+| **storeSpecialDateRequest** | [StoreSpecialDateRequest](StoreSpecialDateRequest.md) |  | [Optional] |
 
 ### Return type
 

package/docs/StoreSpecialDateRequest.md

@@ -0,0 +1,44 @@
+
+# StoreSpecialDateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`hours` | string
+`date` | Date
+`closed` | boolean
+`displayStartDate` | Date
+`displayEndDate` | Date
+
+## Example
+
+```typescript
+import type { StoreSpecialDateRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "hours": null,
+  "date": null,
+  "closed": null,
+  "displayStartDate": null,
+  "displayEndDate": null,
+} satisfies StoreSpecialDateRequest
+
+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 StoreSpecialDateRequest
+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)
+
+