@digital8/lighting-illusions-ts-sdk 0.0.1634 → 0.0.1636

package/dist/models/UpdateStoreRequest.d.ts

@@ -52,19 +52,25 @@ export interface UpdateStoreRequest {
      * @type {string}
      * @memberof UpdateStoreRequest
      */
-    tagLine?: string;
+    tagLine?: string | null;
     /**
      *
      * @type {string}
      * @memberof UpdateStoreRequest
      */
-    email: string;
+    email?: string | null;
     /**
      *
-     * @type {Array<string>}
+     * @type {string}
+     * @memberof UpdateStoreRequest
+     */
+    website?: string | null;
+    /**
+     *
+     * @type {Array<string | null>}
      * @memberof UpdateStoreRequest
      */
-    openingHours?: Array<string>;
+    openingHours?: Array<string | null>;
     /**
      *
      * @type {Array<number>}

package/dist/models/UpdateStoreRequest.js

@@ -34,8 +34,6 @@ function instanceOfUpdateStoreRequest(value) {
         return false;
     if (!('latitude' in value) || value['latitude'] === undefined)
         return false;
-    if (!('email' in value) || value['email'] === undefined)
-        return false;
     if (!('address' in value) || value['address'] === undefined)
         return false;
     return true;
@@ -54,7 +52,8 @@ function UpdateStoreRequestFromJSONTyped(json, ignoreDiscriminator) {
         'longitude': json['longitude'],
         'latitude': json['latitude'],
         'tagLine': json['tag_line'] == null ? undefined : json['tag_line'],
-        'email': json['email'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'website': json['website'] == null ? undefined : json['website'],
         'openingHours': json['opening_hours'] == null ? undefined : json['opening_hours'],
         'supplierIds': json['supplier_ids'] == null ? undefined : json['supplier_ids'],
         'specialDates': json['special_dates'] == null ? undefined : (json['special_dates'].map(UpdateStoreRequestSpecialDatesInner_1.UpdateStoreRequestSpecialDatesInnerFromJSON)),
@@ -77,6 +76,7 @@ function UpdateStoreRequestToJSONTyped(value, ignoreDiscriminator) {
         'latitude': value['latitude'],
         'tag_line': value['tagLine'],
         'email': value['email'],
+        'website': value['website'],
         'opening_hours': value['openingHours'],
         'supplier_ids': value['supplierIds'],
         'special_dates': value['specialDates'] == null ? undefined : (value['specialDates'].map(UpdateStoreRequestSpecialDatesInner_1.UpdateStoreRequestSpecialDatesInnerToJSON)),

package/dist/models/UpdateStoreRequestSpecialDatesInner.d.ts

@@ -20,31 +20,31 @@ export interface UpdateStoreRequestSpecialDatesInner {
      * @type {number}
      * @memberof UpdateStoreRequestSpecialDatesInner
      */
-    id?: number;
+    id?: number | null;
     /**
      *
      * @type {string}
      * @memberof UpdateStoreRequestSpecialDatesInner
      */
-    name?: string;
+    name?: string | null;
     /**
      *
      * @type {string}
      * @memberof UpdateStoreRequestSpecialDatesInner
      */
-    hours?: string;
+    hours?: string | null;
     /**
      *
      * @type {Date}
      * @memberof UpdateStoreRequestSpecialDatesInner
      */
-    displayStart?: Date;
+    displayStart?: Date | null;
     /**
      *
      * @type {Date}
      * @memberof UpdateStoreRequestSpecialDatesInner
      */
-    displayEnd?: Date;
+    displayEnd?: Date | null;
 }
 /**
  * Check if a given object implements the UpdateStoreRequestSpecialDatesInner interface.

package/dist/models/UpdateSupplierRequest.d.ts

@@ -46,7 +46,7 @@ export interface UpdateSupplierRequest {
      * @type {string}
      * @memberof UpdateSupplierRequest
      */
-    altText?: string;
+    altText?: string | null;
     /**
      *
      * @type {string}

package/dist/models/UpdateTagRequest.d.ts

@@ -38,25 +38,25 @@ export interface UpdateTagRequest {
      * @type {string}
      * @memberof UpdateTagRequest
      */
-    seoTitle?: string;
+    seoTitle?: string | null;
     /**
      *
      * @type {string}
      * @memberof UpdateTagRequest
      */
-    seoDescription?: string;
+    seoDescription?: string | null;
     /**
      *
      * @type {string}
      * @memberof UpdateTagRequest
      */
-    headerDescription?: string;
+    headerDescription?: string | null;
     /**
      *
      * @type {string}
      * @memberof UpdateTagRequest
      */
-    footerDescription?: string;
+    footerDescription?: string | null;
 }
 /**
  * @export

package/dist/models/index.d.ts

@@ -121,6 +121,7 @@ export * from './IndexProductRangeRequest';
 export * from './IndexProductRegistrationRequest';
 export * from './IndexProductRequest';
 export * from './IndexProductTypeRequest';
+export * from './IndexRedirectRequest';
 export * from './IndexSiteNotificationRequest';
 export * from './IndexSiteRequest';
 export * from './IndexStoreRequest';
@@ -133,6 +134,8 @@ export * from './LabelLiteResourceArrayResponse';
 export * from './LabelResource';
 export * from './LabelResourceArrayResponse';
 export * from './ListAssetsProductRegistrationRequest';
+export * from './ModelAttributeFrontendResource';
+export * from './ModelAttributeFrontendResourceArrayResponse';
 export * from './ModelAttributeListResource';
 export * from './ModelAttributeListResourceArrayResponse';
 export * from './ModelAttributeResource';
@@ -187,6 +190,7 @@ export * from './PaginatedProductSearchResultResourceResponse';
 export * from './PaginatedProductTypeListResourceResponse';
 export * from './PaginatedProductTypeLiteResourceResponse';
 export * from './PaginatedProductTypeResourceResponse';
+export * from './PaginatedRedirectListResourceResponse';
 export * from './PaginatedSiteListResourceResponse';
 export * from './PaginatedSiteLiteResourceResponse';
 export * from './PaginatedSiteNotificationListResourceResponse';
@@ -292,6 +296,10 @@ export * from './ProductTypeLiteResource';
 export * from './ProductTypeLiteResourceArrayResponse';
 export * from './ProductTypeResource';
 export * from './ProductTypeResourceArrayResponse';
+export * from './RedirectFrontendResource';
+export * from './RedirectFrontendResourceArrayResponse';
+export * from './RedirectListResource';
+export * from './RedirectListResourceArrayResponse';
 export * from './SEOResource';
 export * from './SEOResourceArrayResponse';
 export * from './ShowAssetsProductChildRequest';

package/dist/models/index.js

@@ -139,6 +139,7 @@ __exportStar(require("./IndexProductRangeRequest"), exports);
 __exportStar(require("./IndexProductRegistrationRequest"), exports);
 __exportStar(require("./IndexProductRequest"), exports);
 __exportStar(require("./IndexProductTypeRequest"), exports);
+__exportStar(require("./IndexRedirectRequest"), exports);
 __exportStar(require("./IndexSiteNotificationRequest"), exports);
 __exportStar(require("./IndexSiteRequest"), exports);
 __exportStar(require("./IndexStoreRequest"), exports);
@@ -151,6 +152,8 @@ __exportStar(require("./LabelLiteResourceArrayResponse"), exports);
 __exportStar(require("./LabelResource"), exports);
 __exportStar(require("./LabelResourceArrayResponse"), exports);
 __exportStar(require("./ListAssetsProductRegistrationRequest"), exports);
+__exportStar(require("./ModelAttributeFrontendResource"), exports);
+__exportStar(require("./ModelAttributeFrontendResourceArrayResponse"), exports);
 __exportStar(require("./ModelAttributeListResource"), exports);
 __exportStar(require("./ModelAttributeListResourceArrayResponse"), exports);
 __exportStar(require("./ModelAttributeResource"), exports);
@@ -205,6 +208,7 @@ __exportStar(require("./PaginatedProductSearchResultResourceResponse"), exports)
 __exportStar(require("./PaginatedProductTypeListResourceResponse"), exports);
 __exportStar(require("./PaginatedProductTypeLiteResourceResponse"), exports);
 __exportStar(require("./PaginatedProductTypeResourceResponse"), exports);
+__exportStar(require("./PaginatedRedirectListResourceResponse"), exports);
 __exportStar(require("./PaginatedSiteListResourceResponse"), exports);
 __exportStar(require("./PaginatedSiteLiteResourceResponse"), exports);
 __exportStar(require("./PaginatedSiteNotificationListResourceResponse"), exports);
@@ -310,6 +314,10 @@ __exportStar(require("./ProductTypeLiteResource"), exports);
 __exportStar(require("./ProductTypeLiteResourceArrayResponse"), exports);
 __exportStar(require("./ProductTypeResource"), exports);
 __exportStar(require("./ProductTypeResourceArrayResponse"), exports);
+__exportStar(require("./RedirectFrontendResource"), exports);
+__exportStar(require("./RedirectFrontendResourceArrayResponse"), exports);
+__exportStar(require("./RedirectListResource"), exports);
+__exportStar(require("./RedirectListResourceArrayResponse"), exports);
 __exportStar(require("./SEOResource"), exports);
 __exportStar(require("./SEOResourceArrayResponse"), exports);
 __exportStar(require("./ShowAssetsProductChildRequest"), exports);

package/docs/IndexRedirectRequest.md

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

@@ -9,6 +9,7 @@ Name | Type
 `id` | number
 `shortName` | string
 `longName` | string
+`productCount` | number
 `colour` | string
 `textColour` | string
 `startDate` | string
@@ -25,6 +26,7 @@ const example = {
   "id": null,
   "shortName": null,
   "longName": null,
+  "productCount": null,
   "colour": null,
   "textColour": null,
   "startDate": null,

package/docs/ModelAttributeFrontendResource.md

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

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

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

@@ -21,6 +21,7 @@ Name | Type
 `seo` | object
 `assets` | object
 `thumbnail` | string
+`attributes` | [Array<ModelAttributeFrontendResource>](ModelAttributeFrontendResource.md)
 
 ## Example
 
@@ -44,6 +45,7 @@ const example = {
   "seo": null,
   "assets": null,
   "thumbnail": null,
+  "attributes": null,
 } satisfies ProductRangeFrontendResource
 
 console.log(example)

package/docs/RedirectApi.md

@@ -0,0 +1,74 @@
+# RedirectApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**indexRedirect**](RedirectApi.md#indexredirectoperation) | **POST** /admin-api/redirect/list | Auto-generated: indexRedirect |
+
+
+
+## indexRedirect
+
+> PaginatedRedirectListResourceResponse indexRedirect(indexRedirectRequest)
+
+Auto-generated: indexRedirect
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RedirectApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexRedirectOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RedirectApi();
+
+  const body = {
+    // IndexRedirectRequest (optional)
+    indexRedirectRequest: ...,
+  } satisfies IndexRedirectOperationRequest;
+
+  try {
+    const data = await api.indexRedirect(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexRedirectRequest** | [IndexRedirectRequest](IndexRedirectRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedRedirectListResourceResponse**](PaginatedRedirectListResourceResponse.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<\\RedirectListResource[]>> |  -  |
+
+[[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/RedirectFrontendResource.md

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

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

@@ -0,0 +1,46 @@
+
+# RedirectListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`redirectableType` | string
+`redirectableId` | number
+`fromSlug` | string
+`toSlug` | string
+`status` | number
+
+## Example
+
+```typescript
+import type { RedirectListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "site": null,
+  "redirectableType": null,
+  "redirectableId": null,
+  "fromSlug": null,
+  "toSlug": null,
+  "status": null,
+} satisfies RedirectListResource
+
+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 RedirectListResource
+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/RedirectListResourceArrayResponse.md

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

@@ -10,6 +10,7 @@ Name | Type
 `siteId` | number
 `name` | string
 `email` | string
+`website` | string
 `phone` | string
 `address` | string
 `latitude` | number
@@ -30,6 +31,7 @@ const example = {
   "siteId": null,
   "name": null,
   "email": null,
+  "website": null,
   "phone": null,
   "address": null,
   "latitude": null,

package/docs/StoreListResource.md

@@ -14,6 +14,7 @@ Name | Type
 `latitude` | number
 `tagLine` | string
 `email` | string
+`website` | string
 `openingHours` | string
 
 ## Example
@@ -31,6 +32,7 @@ const example = {
   "latitude": null,
   "tagLine": null,
   "email": null,
+  "website": null,
   "openingHours": null,
 } satisfies StoreListResource