@digital8/lighting-illusions-ts-sdk 0.0.1853 → 0.0.1854

package/docs/SiteApi.md

@@ -6,12 +6,12 @@ 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 |
-| [**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 |
+| [**storeSiteNotification**](SiteApi.md#storesitenotification) | **POST** /admin-api/site/notification/create | Auto-generated: storeSiteNotification |
+| [**updateSite**](SiteApi.md#updatesite) | **PUT** /admin-api/site/{site}/update | Auto-generated: updateSite |
+| [**updateSiteNotification**](SiteApi.md#updatesitenotification) | **PUT** /admin-api/site/notification/{siteNotification}/update | Auto-generated: updateSiteNotification |
 
 
 
@@ -82,7 +82,7 @@ No authorization required
 
 ## getAllSite
 
-> SiteLiteResourceArrayResponse getAllSite(indexSiteRequest)
+> SiteLiteResourceArrayResponse getAllSite(sitesSearchSitesRequest)
 
 Auto-generated: getAllSite
 
@@ -100,8 +100,8 @@ async function example() {
   const api = new SiteApi();
 
   const body = {
-    // IndexSiteRequest (optional)
-    indexSiteRequest: ...,
+    // SitesSearchSitesRequest (optional)
+    sitesSearchSitesRequest: ...,
   } satisfies GetAllSiteRequest;
 
   try {
@@ -121,7 +121,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **indexSiteRequest** | [IndexSiteRequest](IndexSiteRequest.md) |  | [Optional] |
+| **sitesSearchSitesRequest** | [SitesSearchSitesRequest](SitesSearchSitesRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -147,7 +147,7 @@ No authorization required
 
 ## indexSite
 
-> PaginatedSiteListResourceResponse indexSite(indexSiteRequest)
+> PaginatedSiteListResourceResponse indexSite(sitesSearchSitesRequest)
 
 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;
+    // SitesSearchSitesRequest (optional)
+    sitesSearchSitesRequest: ...,
+  } 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] |
+| **sitesSearchSitesRequest** | [SitesSearchSitesRequest](SitesSearchSitesRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -212,7 +212,7 @@ No authorization required
 
 ## indexSiteNotification
 
-> PaginatedSiteNotificationListResourceResponse indexSiteNotification(indexSiteNotificationRequest)
+> PaginatedSiteNotificationListResourceResponse indexSiteNotification(sitesSiteNotificationsSearchSiteNotificationsRequest)
 
 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;
+    // SitesSiteNotificationsSearchSiteNotificationsRequest (optional)
+    sitesSiteNotificationsSearchSiteNotificationsRequest: ...,
+  } 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] |
+| **sitesSiteNotificationsSearchSiteNotificationsRequest** | [SitesSiteNotificationsSearchSiteNotificationsRequest](SitesSiteNotificationsSearchSiteNotificationsRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -342,7 +342,7 @@ No authorization required
 
 ## storeSiteNotification
 
-> SiteNotificationResource storeSiteNotification(storeSiteNotificationRequest)
+> SiteNotificationResource storeSiteNotification(sitesSiteNotificationsCreateSiteNotificationRequest)
 
 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;
+    // SitesSiteNotificationsCreateSiteNotificationRequest (optional)
+    sitesSiteNotificationsCreateSiteNotificationRequest: ...,
+  } 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] |
+| **sitesSiteNotificationsCreateSiteNotificationRequest** | [SitesSiteNotificationsCreateSiteNotificationRequest](SitesSiteNotificationsCreateSiteNotificationRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -407,7 +407,7 @@ No authorization required
 
 ## updateSite
 
-> SiteResource updateSite(site, updateSiteRequest)
+> SiteResource updateSite(site, sitesUpdateSiteRequest)
 
 Auto-generated: updateSite
 
@@ -418,7 +418,7 @@ import {
   Configuration,
   SiteApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateSiteOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateSiteRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
@@ -427,9 +427,9 @@ async function example() {
   const body = {
     // number | The id of the site
     site: 56,
-    // UpdateSiteRequest (optional)
-    updateSiteRequest: ...,
-  } satisfies UpdateSiteOperationRequest;
+    // SitesUpdateSiteRequest (optional)
+    sitesUpdateSiteRequest: ...,
+  } satisfies UpdateSiteRequest;
 
   try {
     const data = await api.updateSite(body);
@@ -449,7 +449,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **site** | `number` | The id of the site | [Defaults to `undefined`] |
-| **updateSiteRequest** | [UpdateSiteRequest](UpdateSiteRequest.md) |  | [Optional] |
+| **sitesUpdateSiteRequest** | [SitesUpdateSiteRequest](SitesUpdateSiteRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -475,7 +475,7 @@ No authorization required
 
 ## updateSiteNotification
 
-> SiteNotificationResource updateSiteNotification(siteNotification, updateSiteNotificationRequest)
+> SiteNotificationResource updateSiteNotification(siteNotification, sitesSiteNotificationsUpdateSiteNotificationRequest)
 
 Auto-generated: updateSiteNotification
 
@@ -486,7 +486,7 @@ import {
   Configuration,
   SiteApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateSiteNotificationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateSiteNotificationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
@@ -495,9 +495,9 @@ async function example() {
   const body = {
     // number | The id of the siteNotification
     siteNotification: 56,
-    // UpdateSiteNotificationRequest (optional)
-    updateSiteNotificationRequest: ...,
-  } satisfies UpdateSiteNotificationOperationRequest;
+    // SitesSiteNotificationsUpdateSiteNotificationRequest (optional)
+    sitesSiteNotificationsUpdateSiteNotificationRequest: ...,
+  } satisfies UpdateSiteNotificationRequest;
 
   try {
     const data = await api.updateSiteNotification(body);
@@ -517,7 +517,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **siteNotification** | `number` | The id of the siteNotification | [Defaults to `undefined`] |
-| **updateSiteNotificationRequest** | [UpdateSiteNotificationRequest](UpdateSiteNotificationRequest.md) |  | [Optional] |
+| **sitesSiteNotificationsUpdateSiteNotificationRequest** | [SitesSiteNotificationsUpdateSiteNotificationRequest](SitesSiteNotificationsUpdateSiteNotificationRequest.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/SitesSearchSitesRequest.md

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

@@ -0,0 +1,44 @@
+
+# SitesSiteNotificationsCreateSiteNotificationRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`siteId` | number
+`text` | string
+`startDate` | Date
+`endDate` | Date
+`backgroundColour` | string
+`textColour` | string
+
+## Example
+
+```typescript
+import type { SitesSiteNotificationsCreateSiteNotificationRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "siteId": null,
+  "text": null,
+  "startDate": null,
+  "endDate": null,
+  "backgroundColour": null,
+  "textColour": null,
+} satisfies SitesSiteNotificationsCreateSiteNotificationRequest
+
+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 SitesSiteNotificationsCreateSiteNotificationRequest
+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/SitesSiteNotificationsSearchSiteNotificationsRequest.md

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

@@ -0,0 +1,42 @@
+
+# SitesSiteNotificationsUpdateSiteNotificationRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`text` | string
+`startDate` | Date
+`endDate` | Date
+`backgroundColour` | string
+`textColour` | string
+
+## Example
+
+```typescript
+import type { SitesSiteNotificationsUpdateSiteNotificationRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "text": null,
+  "startDate": null,
+  "endDate": null,
+  "backgroundColour": null,
+  "textColour": null,
+} satisfies SitesSiteNotificationsUpdateSiteNotificationRequest
+
+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 SitesSiteNotificationsUpdateSiteNotificationRequest
+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/SitesUpdateSiteRequest.md

@@ -0,0 +1,76 @@
+
+# SitesUpdateSiteRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`senderName` | string
+`senderEmail` | string
+`phoneNumber` | string
+`tollFreeNumber` | string
+`fullAddress` | string
+`shortAddress` | string
+`invoiceHeader` | string
+`googleMaps` | string
+`facebook` | string
+`instagram` | string
+`pinterest` | string
+`abn` | string
+`shippingAmount` | number
+`freeShippingThreshold` | number
+`insuranceThreshold` | number
+`insuranceBase` | number
+`insuranceAdditional` | number
+`amexSurcharge` | number
+`acCouponValue` | number
+`acCouponDiscountType` | string
+`acCouponExpiryDays` | number
+`acCouponEnabled` | boolean
+
+## Example
+
+```typescript
+import type { SitesUpdateSiteRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "senderName": null,
+  "senderEmail": null,
+  "phoneNumber": null,
+  "tollFreeNumber": null,
+  "fullAddress": null,
+  "shortAddress": null,
+  "invoiceHeader": null,
+  "googleMaps": null,
+  "facebook": null,
+  "instagram": null,
+  "pinterest": null,
+  "abn": null,
+  "shippingAmount": null,
+  "freeShippingThreshold": null,
+  "insuranceThreshold": null,
+  "insuranceBase": null,
+  "insuranceAdditional": null,
+  "amexSurcharge": null,
+  "acCouponValue": null,
+  "acCouponDiscountType": null,
+  "acCouponExpiryDays": null,
+  "acCouponEnabled": null,
+} satisfies SitesUpdateSiteRequest
+
+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 SitesUpdateSiteRequest
+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)
+
+