npm - @digital8/lighting-illusions-ts-sdk - Versions diffs - 0.0.1779 → 0.0.1781 - Mend

@digital8/lighting-illusions-ts-sdk 0.0.1779 → 0.0.1781

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (540) hide show

package/docs/ProductRegistrationApi.md DELETED Viewed

@@ -1,344 +0,0 @@
-# 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&lt;\\ResourcePaginator&lt;\\ProductRegistrationListResource[]&gt;&gt; |  -  |
-[[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&lt;\\ResourcePaginator&lt;\\ProductRegistrationAssetResource[]&gt;&gt; |  -  |
-[[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&lt;\\ResourcePaginator&lt;\\ProductChildListResource[]&gt;&gt; |  -  |
-[[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/docs/ProductRegistrationAssetResourceArrayResponse.md DELETED Viewed

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

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

@@ -1,44 +0,0 @@
-# ProductRegistrationCustomerResource
-## Properties
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`email` | string
-`phone` | string
-`omnisendId` | string
-`omnisendSyncStatus` | string
-## Example
-```typescript
-import type { ProductRegistrationCustomerResource } from '@digital8/lighting-illusions-ts-sdk'
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "email": null,
-  "phone": null,
-  "omnisendId": null,
-  "omnisendSyncStatus": null,
-} satisfies ProductRegistrationCustomerResource
-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 ProductRegistrationCustomerResource
-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/ProductRegistrationCustomerResourceArrayResponse.md DELETED Viewed

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

@@ -1,42 +0,0 @@
-# ProductRegistrationListResource
-## Properties
-Name | Type
------------- | -------------
-`id` | number
-`purchasedDate` | Date
-`customer` | [ProductRegistrationCustomerLiteResource](ProductRegistrationCustomerLiteResource.md)
-`productChildrenCount` | number
-`createdAt` | Date
-## Example
-```typescript
-import type { ProductRegistrationListResource } from '@digital8/lighting-illusions-ts-sdk'
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "purchasedDate": null,
-  "customer": null,
-  "productChildrenCount": null,
-  "createdAt": null,
-} satisfies ProductRegistrationListResource
-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 ProductRegistrationListResource
-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/ProductRegistrationListResourceArrayResponse.md DELETED Viewed

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

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

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

@@ -1,52 +0,0 @@
-# ProductRegistrationResource
-## Properties
-Name | Type
------------- | -------------
-`id` | number
-`purchasedDate` | Date
-`customer` | [ProductRegistrationCustomerResource](ProductRegistrationCustomerResource.md)
-`address` | [AddressResource](AddressResource.md)
-`productChildren` | [Array&lt;ProductRegistrationProductChildResource&gt;](ProductRegistrationProductChildResource.md)
-`assets` | [Array&lt;ProductRegistrationAssetResource&gt;](ProductRegistrationAssetResource.md)
-`omnisendId` | string
-`omnisendSyncStatus` | string
-`createdAt` | Date
-`updatedAt` | Date
-## Example
-```typescript
-import type { ProductRegistrationResource } from '@digital8/lighting-illusions-ts-sdk'
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "purchasedDate": null,
-  "customer": null,
-  "address": null,
-  "productChildren": null,
-  "assets": null,
-  "omnisendId": null,
-  "omnisendSyncStatus": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies ProductRegistrationResource
-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 ProductRegistrationResource
-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)