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

package/docs/GetAllProductRegistrationRequest.md

@@ -0,0 +1,46 @@
+
+# GetAllProductRegistrationRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+`siteId` | Array<string>
+
+## Example
+
+```typescript
+import type { GetAllProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+  "siteId": null,
+} satisfies GetAllProductRegistrationRequest
+
+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 GetAllProductRegistrationRequest
+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/GlobalSearchProductResource.md

@@ -9,6 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `model` | string
+`modelRaw` | string
 `slug` | string
 `sku` | string
 `thumbnail` | string
@@ -28,6 +29,7 @@ const example = {
   "id": null,
   "name": null,
   "model": null,
+  "modelRaw": null,
   "slug": null,
   "sku": null,
   "thumbnail": null,

package/docs/IndexProductRegistrationRequest.md

@@ -0,0 +1,58 @@
+
+# IndexProductRegistrationRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`siteId` | Array<string>
+`beforePurchasedDate` | Date
+`afterPurchasedDate` | Date
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { IndexProductRegistrationRequest } 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,
+  "beforePurchasedDate": null,
+  "afterPurchasedDate": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies IndexProductRegistrationRequest
+
+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 IndexProductRegistrationRequest
+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,7 +9,6 @@ Name | Type
 `id` | number
 `shortName` | string
 `longName` | string
-`productCount` | number
 `colour` | string
 `textColour` | string
 `startDate` | string
@@ -26,7 +25,6 @@ const example = {
   "id": null,
   "shortName": null,
   "longName": null,
-  "productCount": null,
   "colour": null,
   "textColour": null,
   "startDate": null,

package/docs/{IndexRedirectRequest.md → ListAssetsProductRegistrationRequest.md}

@@ -1,5 +1,5 @@
 
-# IndexRedirectRequest
+# ListAssetsProductRegistrationRequest
 
 
 ## Properties
@@ -11,18 +11,16 @@ Name | Type
 `sortDirection` | string
 `perPage` | number
 `page` | number
-`siteId` | Array<string>
-`redirectableType` | Array<string>
+`productRegistrationId` | Array<string>
+`type` | Array<string>
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
-`productChildId` | number
-`productRangeId` | number
 
 ## Example
 
 ```typescript
-import type { IndexRedirectRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { ListAssetsProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -31,14 +29,12 @@ const example = {
   "sortDirection": null,
   "perPage": null,
   "page": null,
-  "siteId": null,
-  "redirectableType": null,
+  "productRegistrationId": null,
+  "type": null,
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
-  "productChildId": null,
-  "productRangeId": null,
-} satisfies IndexRedirectRequest
+} satisfies ListAssetsProductRegistrationRequest
 
 console.log(example)
 
@@ -47,7 +43,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as IndexRedirectRequest
+const exampleParsed = JSON.parse(exampleJSON) as ListAssetsProductRegistrationRequest
 console.log(exampleParsed)
 ```
 

package/docs/PaginatedProductRegistrationAssetResourceResponse.md

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

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

@@ -1,24 +1,24 @@
 
-# PaginatedRedirectListResourceResponse
+# PaginatedProductRegistrationResourceResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<RedirectListResource>](RedirectListResource.md)
+`data` | [Array<ProductRegistrationResource>](ProductRegistrationResource.md)
 `meta` | [PagingMetadata](PagingMetadata.md)
 
 ## Example
 
 ```typescript
-import type { PaginatedRedirectListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { PaginatedProductRegistrationResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
   "meta": null,
-} satisfies PaginatedRedirectListResourceResponse
+} satisfies PaginatedProductRegistrationResourceResponse
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PaginatedRedirectListResourceResponse
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedProductRegistrationResourceResponse
 console.log(exampleParsed)
 ```
 

package/docs/ProductChildListResource.md

@@ -14,6 +14,7 @@ Name | Type
 `stock` | number
 `isDisabled` | string
 `displayInSocialFeed` | boolean
+`quantity` | string
 `netsuiteId` | number
 `thumbnail` | [AssetLiteResource](AssetLiteResource.md)
 `siteDetails` | [Array<ProductChildSiteDetailLiteResource>](ProductChildSiteDetailLiteResource.md)
@@ -33,6 +34,7 @@ const example = {
   "stock": null,
   "isDisabled": null,
   "displayInSocialFeed": null,
+  "quantity": null,
   "netsuiteId": null,
   "thumbnail": null,
   "siteDetails": null,

package/docs/ProductRangeFrontendResource.md

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

package/docs/ProductRegistrationApi.md

@@ -0,0 +1,344 @@
+# 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 |
+| [**listProductsProductRegistration**](ProductRegistrationApi.md#listproductsproductregistration) | **POST** /admin-api/product-registration/{productRegistration}/product/list | Auto-generated: listProductsProductRegistration |
+| [**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)
+
+
+## listProductsProductRegistration
+
+> PaginatedProductChildListResourceResponse listProductsProductRegistration(productRegistration, indexProductChildRequest)
+
+Auto-generated: listProductsProductRegistration
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductRegistrationApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ListProductsProductRegistrationRequest } 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,
+    // IndexProductChildRequest (optional)
+    indexProductChildRequest: ...,
+  } satisfies ListProductsProductRegistrationRequest;
+
+  try {
+    const data = await api.listProductsProductRegistration(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`] |
+| **indexProductChildRequest** | [IndexProductChildRequest](IndexProductChildRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedProductChildListResourceResponse**](PaginatedProductChildListResourceResponse.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<\\ProductChildListResource[]>> |  -  |
+
+[[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)
+