@digital8/lighting-illusions-ts-sdk 0.0.1451 → 0.0.1452

package/docs/ListAssetsProductRegistrationRequest.md

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

@@ -0,0 +1,275 @@
+# ProductRegistrationApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAllProductRegistration**](ProductRegistrationApi.md#getallproductregistrationoperation) | **POST** /admin-api/product-registration/all | Auto-generated: getAllProductRegistration |
+| [**indexProductRegistration**](ProductRegistrationApi.md#indexproductregistrationoperation) | **POST** /admin-api/product-registration/list | Auto-generated: indexProductRegistration |
+| [**listAssetsProductRegistration**](ProductRegistrationApi.md#listassetsproductregistrationoperation) | **POST** /admin-api/product-registration/{productRegistration}/assets | Auto-generated: listAssetsProductRegistration |
+| [**showProductRegistration**](ProductRegistrationApi.md#showproductregistration) | **GET** /admin-api/product-registration/{productRegistration} | Auto-generated: showProductRegistration |
+
+
+
+## getAllProductRegistration
+
+> ProductRegistrationLiteResourceArrayResponse getAllProductRegistration(getAllProductRegistrationRequest)
+
+Auto-generated: getAllProductRegistration
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductRegistrationApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ProductRegistrationApi();
+
+  const body = {
+    // GetAllProductRegistrationRequest (optional)
+    getAllProductRegistrationRequest: ...,
+  } satisfies GetAllProductRegistrationOperationRequest;
+
+  try {
+    const data = await api.getAllProductRegistration(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAllProductRegistrationRequest** | [GetAllProductRegistrationRequest](GetAllProductRegistrationRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ProductRegistrationLiteResourceArrayResponse**](ProductRegistrationLiteResourceArrayResponse.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)
+
+
+## indexProductRegistration
+
+> PaginatedProductRegistrationListResourceResponse indexProductRegistration(indexProductRegistrationRequest)
+
+Auto-generated: indexProductRegistration
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductRegistrationApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ProductRegistrationApi();
+
+  const body = {
+    // IndexProductRegistrationRequest (optional)
+    indexProductRegistrationRequest: ...,
+  } satisfies IndexProductRegistrationOperationRequest;
+
+  try {
+    const data = await api.indexProductRegistration(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexProductRegistrationRequest** | [IndexProductRegistrationRequest](IndexProductRegistrationRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedProductRegistrationListResourceResponse**](PaginatedProductRegistrationListResourceResponse.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<\\ProductRegistrationListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listAssetsProductRegistration
+
+> PaginatedProductRegistrationAssetResourceResponse listAssetsProductRegistration(productRegistration, listAssetsProductRegistrationRequest)
+
+Auto-generated: listAssetsProductRegistration
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductRegistrationApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ListAssetsProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ProductRegistrationApi();
+
+  const body = {
+    // number | The id of the productRegistration
+    productRegistration: 56,
+    // ListAssetsProductRegistrationRequest (optional)
+    listAssetsProductRegistrationRequest: ...,
+  } satisfies ListAssetsProductRegistrationOperationRequest;
+
+  try {
+    const data = await api.listAssetsProductRegistration(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
+| **listAssetsProductRegistrationRequest** | [ListAssetsProductRegistrationRequest](ListAssetsProductRegistrationRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedProductRegistrationAssetResourceResponse**](PaginatedProductRegistrationAssetResourceResponse.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<\\ProductRegistrationAssetResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showProductRegistration
+
+> ProductRegistrationResource showProductRegistration(productRegistration)
+
+Auto-generated: showProductRegistration
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductRegistrationApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ProductRegistrationApi();
+
+  const body = {
+    // number | The id of the productRegistration
+    productRegistration: 56,
+  } satisfies ShowProductRegistrationRequest;
+
+  try {
+    const data = await api.showProductRegistration(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
+
+### Return type
+
+[**ProductRegistrationResource**](ProductRegistrationResource.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)
+

package/package.json

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

package/src/apis/ProductRegistrationApi.ts

@@ -0,0 +1,238 @@
+/* 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 {
+  GetAllProductRegistrationRequest,
+  IndexProductRegistrationRequest,
+  ListAssetsProductRegistrationRequest,
+  PaginatedProductRegistrationAssetResourceResponse,
+  PaginatedProductRegistrationListResourceResponse,
+  ProductRegistrationLiteResourceArrayResponse,
+  ProductRegistrationResource,
+} from '../models/index';
+import {
+    GetAllProductRegistrationRequestFromJSON,
+    GetAllProductRegistrationRequestToJSON,
+    IndexProductRegistrationRequestFromJSON,
+    IndexProductRegistrationRequestToJSON,
+    ListAssetsProductRegistrationRequestFromJSON,
+    ListAssetsProductRegistrationRequestToJSON,
+    PaginatedProductRegistrationAssetResourceResponseFromJSON,
+    PaginatedProductRegistrationAssetResourceResponseToJSON,
+    PaginatedProductRegistrationListResourceResponseFromJSON,
+    PaginatedProductRegistrationListResourceResponseToJSON,
+    ProductRegistrationLiteResourceArrayResponseFromJSON,
+    ProductRegistrationLiteResourceArrayResponseToJSON,
+    ProductRegistrationResourceFromJSON,
+    ProductRegistrationResourceToJSON,
+} from '../models/index';
+
+export interface GetAllProductRegistrationOperationRequest {
+    getAllProductRegistrationRequest?: GetAllProductRegistrationRequest;
+}
+
+export interface IndexProductRegistrationOperationRequest {
+    indexProductRegistrationRequest?: IndexProductRegistrationRequest;
+}
+
+export interface ListAssetsProductRegistrationOperationRequest {
+    productRegistration: number;
+    listAssetsProductRegistrationRequest?: ListAssetsProductRegistrationRequest;
+}
+
+export interface ShowProductRegistrationRequest {
+    productRegistration: number;
+}
+
+/**
+ * 
+ */
+export class ProductRegistrationApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getAllProductRegistration without sending the request
+     */
+    async getAllProductRegistrationRequestOpts(requestParameters: GetAllProductRegistrationOperationRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/product-registration/all`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetAllProductRegistrationRequestToJSON(requestParameters['getAllProductRegistrationRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: getAllProductRegistration
+     */
+    async getAllProductRegistrationRaw(requestParameters: GetAllProductRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductRegistrationLiteResourceArrayResponse>> {
+        const requestOptions = await this.getAllProductRegistrationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProductRegistrationLiteResourceArrayResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: getAllProductRegistration
+     */
+    async getAllProductRegistration(requestParameters: GetAllProductRegistrationOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductRegistrationLiteResourceArrayResponse> {
+        const response = await this.getAllProductRegistrationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for indexProductRegistration without sending the request
+     */
+    async indexProductRegistrationRequestOpts(requestParameters: IndexProductRegistrationOperationRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/product-registration/list`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IndexProductRegistrationRequestToJSON(requestParameters['indexProductRegistrationRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: indexProductRegistration
+     */
+    async indexProductRegistrationRaw(requestParameters: IndexProductRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductRegistrationListResourceResponse>> {
+        const requestOptions = await this.indexProductRegistrationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductRegistrationListResourceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: indexProductRegistration
+     */
+    async indexProductRegistration(requestParameters: IndexProductRegistrationOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductRegistrationListResourceResponse> {
+        const response = await this.indexProductRegistrationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listAssetsProductRegistration without sending the request
+     */
+    async listAssetsProductRegistrationRequestOpts(requestParameters: ListAssetsProductRegistrationOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['productRegistration'] == null) {
+            throw new runtime.RequiredError(
+                'productRegistration',
+                'Required parameter "productRegistration" was null or undefined when calling listAssetsProductRegistration().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/product-registration/{productRegistration}/assets`;
+        urlPath = urlPath.replace(`{${"productRegistration"}}`, encodeURIComponent(String(requestParameters['productRegistration'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ListAssetsProductRegistrationRequestToJSON(requestParameters['listAssetsProductRegistrationRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: listAssetsProductRegistration
+     */
+    async listAssetsProductRegistrationRaw(requestParameters: ListAssetsProductRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductRegistrationAssetResourceResponse>> {
+        const requestOptions = await this.listAssetsProductRegistrationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductRegistrationAssetResourceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: listAssetsProductRegistration
+     */
+    async listAssetsProductRegistration(requestParameters: ListAssetsProductRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductRegistrationAssetResourceResponse> {
+        const response = await this.listAssetsProductRegistrationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for showProductRegistration without sending the request
+     */
+    async showProductRegistrationRequestOpts(requestParameters: ShowProductRegistrationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['productRegistration'] == null) {
+            throw new runtime.RequiredError(
+                'productRegistration',
+                'Required parameter "productRegistration" was null or undefined when calling showProductRegistration().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/product-registration/{productRegistration}`;
+        urlPath = urlPath.replace(`{${"productRegistration"}}`, encodeURIComponent(String(requestParameters['productRegistration'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Auto-generated: showProductRegistration
+     */
+    async showProductRegistrationRaw(requestParameters: ShowProductRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductRegistrationResource>> {
+        const requestOptions = await this.showProductRegistrationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProductRegistrationResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: showProductRegistration
+     */
+    async showProductRegistration(requestParameters: ShowProductRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductRegistrationResource> {
+        const response = await this.showProductRegistrationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -11,6 +11,7 @@ export * from './OverlayTemplateApi';
 export * from './ProductApi';
 export * from './ProductCategoryApi';
 export * from './ProductRangeApi';
+export * from './ProductRegistrationApi';
 export * from './ProductTypeApi';
 export * from './SiteApi';
 export * from './SupplierApi';

package/src/models/AddressResource.ts

@@ -30,7 +30,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    company: string;
+    company?: string | null;
     /**
      * 
      * @type {string}
@@ -79,7 +79,6 @@ 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;
@@ -100,7 +99,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
     return {
         
         'id': json['id'] == null ? undefined : json['id'],
-        'company': json['company'],
+        'company': json['company'] == null ? undefined : json['company'],
         'line1': json['line1'],
         'line2': json['line2'] == null ? undefined : json['line2'],
         'postcode': json['postcode'],

package/src/models/ExternalApiLogResource.ts

@@ -74,7 +74,7 @@ export interface ExternalApiLogResource {
      * @type {string}
      * @memberof ExternalApiLogResource
      */
-    requestPayload: string;
+    requestPayload?: string | null;
     /**
      * 
      * @type {string}
@@ -106,7 +106,6 @@ export function instanceOfExternalApiLogResource(value: object): value is Extern
     if (!('exteranlApiLoggableId' in value) || value['exteranlApiLoggableId'] === undefined) return false;
     if (!('endpoint' in value) || value['endpoint'] === undefined) return false;
     if (!('responseCode' in value) || value['responseCode'] === undefined) return false;
-    if (!('requestPayload' in value) || value['requestPayload'] === undefined) return false;
     if (!('responsePayload' in value) || value['responsePayload'] === undefined) return false;
     if (!('site' in value) || value['site'] === undefined) return false;
     return true;
@@ -129,7 +128,7 @@ export function ExternalApiLogResourceFromJSONTyped(json: any, ignoreDiscriminat
         'exteranlApiLoggableId': json['exteranlApiLoggableId'],
         'endpoint': json['endpoint'],
         'responseCode': json['responseCode'],
-        'requestPayload': json['requestPayload'],
+        'requestPayload': json['requestPayload'] == null ? undefined : json['requestPayload'],
         'responsePayload': json['responsePayload'],
         'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
         'site': SiteLiteResourceFromJSON(json['site']),