@digital8/lighting-illusions-ts-sdk 0.0.1613 → 0.0.1615

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/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/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/StoreSpecialDateResource.md

@@ -9,7 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `hours` | string
-`date` | object
+`date` | string
 `closed` | boolean
 `displayStartDate` | string
 `displayEndDate` | string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital8/lighting-illusions-ts-sdk",
-  "version": "0.0.1613",
+  "version": "0.0.1615",
   "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/RedirectApi.ts

@@ -0,0 +1,77 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  IndexRedirectRequest,
+  PaginatedRedirectListResourceResponse,
+} from '../models/index';
+import {
+    IndexRedirectRequestFromJSON,
+    IndexRedirectRequestToJSON,
+    PaginatedRedirectListResourceResponseFromJSON,
+    PaginatedRedirectListResourceResponseToJSON,
+} from '../models/index';
+
+export interface IndexRedirectOperationRequest {
+    indexRedirectRequest?: IndexRedirectRequest;
+}
+
+/**
+ * 
+ */
+export class RedirectApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for indexRedirect without sending the request
+     */
+    async indexRedirectRequestOpts(requestParameters: IndexRedirectOperationRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/redirect/list`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IndexRedirectRequestToJSON(requestParameters['indexRedirectRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: indexRedirect
+     */
+    async indexRedirectRaw(requestParameters: IndexRedirectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedRedirectListResourceResponse>> {
+        const requestOptions = await this.indexRedirectRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedRedirectListResourceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: indexRedirect
+     */
+    async indexRedirect(requestParameters: IndexRedirectOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedRedirectListResourceResponse> {
+        const response = await this.indexRedirectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -13,6 +13,7 @@ export * from './ProductApi';
 export * from './ProductCategoryApi';
 export * from './ProductRangeApi';
 export * from './ProductTypeApi';
+export * from './RedirectApi';
 export * from './SiteApi';
 export * from './StoreApi';
 export * from './SupplierApi';

package/src/models/AddressFrontendResource.ts

@@ -36,7 +36,7 @@ export interface AddressFrontendResource {
      * @type {string}
      * @memberof AddressFrontendResource
      */
-    line2: string;
+    line2?: string | null;
     /**
      * 
      * @type {string}
@@ -75,7 +75,6 @@ export interface AddressFrontendResource {
 export function instanceOfAddressFrontendResource(value: object): value is AddressFrontendResource {
     if (!('company' in value) || value['company'] === undefined) return false;
     if (!('line1' in value) || value['line1'] === undefined) return false;
-    if (!('line2' in value) || value['line2'] === undefined) return false;
     if (!('postcode' in value) || value['postcode'] === undefined) return false;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
     if (!('country' in value) || value['country'] === undefined) return false;
@@ -96,7 +95,7 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
         
         'company': json['company'],
         'line1': json['line1'],
-        'line2': json['line2'],
+        'line2': json['line2'] == null ? undefined : json['line2'],
         'postcode': json['postcode'],
         'suburb': json['suburb'],
         'country': json['country'],

package/src/models/AddressResource.ts

@@ -30,7 +30,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    company?: string | null;
+    company: string;
     /**
      * 
      * @type {string}
@@ -79,6 +79,7 @@ export interface AddressResource {
  * Check if a given object implements the AddressResource interface.
  */
 export function instanceOfAddressResource(value: object): value is AddressResource {
+    if (!('company' in value) || value['company'] === undefined) return false;
     if (!('line1' in value) || value['line1'] === undefined) return false;
     if (!('postcode' in value) || value['postcode'] === undefined) return false;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
@@ -99,7 +100,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
     return {
         
         'id': json['id'] == null ? undefined : json['id'],
-        'company': json['company'] == null ? undefined : json['company'],
+        'company': json['company'],
         'line1': json['line_1'],
         'line2': json['line_2'] == null ? undefined : json['line_2'],
         'postcode': json['postcode'],

package/src/models/IndexRedirectRequest.ts

@@ -0,0 +1,184 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface IndexRedirectRequest
+ */
+export interface IndexRedirectRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof IndexRedirectRequest
+     */
+    search?: string | null;
+    /**
+     * 
+     * @type {IndexRedirectRequestSortByEnum}
+     * @memberof IndexRedirectRequest
+     */
+    sortBy?: IndexRedirectRequestSortByEnum;
+    /**
+     * 
+     * @type {IndexRedirectRequestSortDirectionEnum}
+     * @memberof IndexRedirectRequest
+     */
+    sortDirection?: IndexRedirectRequestSortDirectionEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof IndexRedirectRequest
+     */
+    perPage?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IndexRedirectRequest
+     */
+    page?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IndexRedirectRequest
+     */
+    siteId?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IndexRedirectRequest
+     */
+    redirectableType?: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof IndexRedirectRequest
+     */
+    relatedId?: number;
+    /**
+     * 
+     * @type {IndexRedirectRequestRelatedTypeEnum}
+     * @memberof IndexRedirectRequest
+     */
+    relatedType?: IndexRedirectRequestRelatedTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IndexRedirectRequest
+     */
+    includesRelations?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof IndexRedirectRequest
+     */
+    productChildId?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof IndexRedirectRequest
+     */
+    productRangeId?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const IndexRedirectRequestSortByEnum = {
+    Id: 'id'
+} as const;
+export type IndexRedirectRequestSortByEnum = typeof IndexRedirectRequestSortByEnum[keyof typeof IndexRedirectRequestSortByEnum];
+
+/**
+ * @export
+ */
+export const IndexRedirectRequestSortDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type IndexRedirectRequestSortDirectionEnum = typeof IndexRedirectRequestSortDirectionEnum[keyof typeof IndexRedirectRequestSortDirectionEnum];
+
+/**
+ * @export
+ */
+export const IndexRedirectRequestRelatedTypeEnum = {
+    ProductChildSiteDetail: 'productChildSiteDetail',
+    ProductRangeSiteDetail: 'productRangeSiteDetail',
+    ProductCategory: 'productCategory',
+    Supplier: 'supplier',
+    Tag: 'tag'
+} as const;
+export type IndexRedirectRequestRelatedTypeEnum = typeof IndexRedirectRequestRelatedTypeEnum[keyof typeof IndexRedirectRequestRelatedTypeEnum];
+
+
+/**
+ * Check if a given object implements the IndexRedirectRequest interface.
+ */
+export function instanceOfIndexRedirectRequest(value: object): value is IndexRedirectRequest {
+    return true;
+}
+
+export function IndexRedirectRequestFromJSON(json: any): IndexRedirectRequest {
+    return IndexRedirectRequestFromJSONTyped(json, false);
+}
+
+export function IndexRedirectRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndexRedirectRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'search': json['search'] == null ? undefined : json['search'],
+        'sortBy': json['sortBy'] == null ? undefined : json['sortBy'],
+        'sortDirection': json['sortDirection'] == null ? undefined : json['sortDirection'],
+        'perPage': json['per_page'] == null ? undefined : json['per_page'],
+        'page': json['page'] == null ? undefined : json['page'],
+        'siteId': json['site_id'] == null ? undefined : json['site_id'],
+        'redirectableType': json['redirectable_type'] == null ? undefined : json['redirectable_type'],
+        'relatedId': json['related_id'] == null ? undefined : json['related_id'],
+        'relatedType': json['related_type'] == null ? undefined : json['related_type'],
+        'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
+        'productChildId': json['product_child_id'] == null ? undefined : json['product_child_id'],
+        'productRangeId': json['product_range_id'] == null ? undefined : json['product_range_id'],
+    };
+}
+
+export function IndexRedirectRequestToJSON(json: any): IndexRedirectRequest {
+    return IndexRedirectRequestToJSONTyped(json, false);
+}
+
+export function IndexRedirectRequestToJSONTyped(value?: IndexRedirectRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'search': value['search'],
+        'sortBy': value['sortBy'],
+        'sortDirection': value['sortDirection'],
+        'per_page': value['perPage'],
+        'page': value['page'],
+        'site_id': value['siteId'],
+        'redirectable_type': value['redirectableType'],
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'includes_relations': value['includesRelations'],
+        'product_child_id': value['productChildId'],
+        'product_range_id': value['productRangeId'],
+    };
+}
+