npm - @digital8/lighting-illusions-ts-sdk - Versions diffs - 0.0.1821 → 0.0.1822 - Mend

@digital8/lighting-illusions-ts-sdk 0.0.1821 → 0.0.1822

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 (604) hide show

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)

package/docs/ProductRegistrationResourceArrayResponse.md DELETED Viewed

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

@@ -1,44 +0,0 @@
-# ProductReviewsResource
-## Properties
-Name | Type
------------- | -------------
-`reviews` | [Array&lt;ReviewPublicResource&gt;](ReviewPublicResource.md)
-`totalReview` | number
-`averageRating` | number
-`stats` | Array&lt;object&gt;
-`myReview` | string
-`canReview` | boolean
-## Example
-```typescript
-import type { ProductReviewsResource } from '@digital8/lighting-illusions-ts-sdk'
-// TODO: Update the object below with actual values
-const example = {
-  "reviews": null,
-  "totalReview": null,
-  "averageRating": null,
-  "stats": null,
-  "myReview": null,
-  "canReview": null,
-} satisfies ProductReviewsResource
-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 ProductReviewsResource
-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/ProductReviewsResourceArrayResponse.md DELETED Viewed

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

@@ -1,539 +0,0 @@
-# ReviewApi
-All URIs are relative to *http://localhost/api*
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyReview**](ReviewApi.md#destroyreview) | **DELETE** /admin-api/review/{review}/delete | Auto-generated: destroyReview |
-| [**exportReview**](ReviewApi.md#exportreview) | **POST** /admin-api/review/export | Auto-generated: exportReview |
-| [**getAllReview**](ReviewApi.md#getallreview) | **POST** /admin-api/review/all | Auto-generated: getAllReview |
-| [**importReview**](ReviewApi.md#importreview) | **POST** /admin-api/review/import | Auto-generated: importReview |
-| [**indexReview**](ReviewApi.md#indexreviewoperation) | **POST** /admin-api/review/list | Auto-generated: indexReview |
-| [**showReview**](ReviewApi.md#showreview) | **GET** /admin-api/review/{review} | Auto-generated: showReview |
-| [**storeReview**](ReviewApi.md#storereviewoperation) | **POST** /admin-api/review/create | Auto-generated: storeReview |
-| [**updateReview**](ReviewApi.md#updatereviewoperation) | **PUT** /admin-api/review/{review}/update | Auto-generated: updateReview |
-## destroyReview
-> GenericResponse destroyReview(review)
-Auto-generated: destroyReview
-### Example
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-  const body = {
-    // number | The id of the review
-    review: 56,
-  } satisfies DestroyReviewRequest;
-  try {
-    const data = await api.destroyReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **review** | `number` | The id of the review | [Defaults to `undefined`] |
-### Return type
-[**GenericResponse**](GenericResponse.md)
-### Authorization
-No authorization required
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | \\JsonResponse |  -  |
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-## exportReview
-> Blob exportReview(indexReviewRequest)
-Auto-generated: exportReview
-### Example
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ExportReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-  const body = {
-    // IndexReviewRequest (optional)
-    indexReviewRequest: ...,
-  } satisfies ExportReviewRequest;
-  try {
-    const data = await api.exportReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
-### Return type
-**Blob**
-### Authorization
-No authorization required
-### HTTP request headers
-- **Content-Type**: `application/json`
-- **Accept**: ``
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | File download () |  -  |
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-## getAllReview
-> ReviewLiteResourceArrayResponse getAllReview(indexReviewRequest)
-Auto-generated: getAllReview
-### Example
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-  const body = {
-    // IndexReviewRequest (optional)
-    indexReviewRequest: ...,
-  } satisfies GetAllReviewRequest;
-  try {
-    const data = await api.getAllReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
-### Return type
-[**ReviewLiteResourceArrayResponse**](ReviewLiteResourceArrayResponse.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)
-## importReview
-> GenericResponse importReview(file)
-Auto-generated: importReview
-### Example
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ImportReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-  const body = {
-    // Blob
-    file: BINARY_DATA_HERE,
-  } satisfies ImportReviewRequest;
-  try {
-    const data = await api.importReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **file** | `Blob` |  | [Defaults to `undefined`] |
-### Return type
-[**GenericResponse**](GenericResponse.md)
-### Authorization
-No authorization required
-### HTTP request headers
-- **Content-Type**: `application/x-www-form-urlencoded`
-- **Accept**: `application/json`
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | \\JsonResponse |  -  |
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-## indexReview
-> PaginatedReviewListResourceResponse indexReview(indexReviewRequest)
-Auto-generated: indexReview
-### Example
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-  const body = {
-    // IndexReviewRequest (optional)
-    indexReviewRequest: ...,
-  } satisfies IndexReviewOperationRequest;
-  try {
-    const data = await api.indexReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
-### Return type
-[**PaginatedReviewListResourceResponse**](PaginatedReviewListResourceResponse.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;\\ReviewListResource[]&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)
-## showReview
-> ReviewResource showReview(review)
-Auto-generated: showReview
-### Example
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-  const body = {
-    // number | The id of the review
-    review: 56,
-  } satisfies ShowReviewRequest;
-  try {
-    const data = await api.showReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **review** | `number` | The id of the review | [Defaults to `undefined`] |
-### Return type
-[**ReviewResource**](ReviewResource.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)
-## storeReview
-> ReviewResource storeReview(storeReviewRequest)
-Auto-generated: storeReview
-### Example
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-  const body = {
-    // StoreReviewRequest (optional)
-    storeReviewRequest: ...,
-  } satisfies StoreReviewOperationRequest;
-  try {
-    const data = await api.storeReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeReviewRequest** | [StoreReviewRequest](StoreReviewRequest.md) |  | [Optional] |
-### Return type
-[**ReviewResource**](ReviewResource.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)
-## updateReview
-> ReviewResource updateReview(review, updateReviewRequest)
-Auto-generated: updateReview
-### Example
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-  const body = {
-    // number | The id of the review
-    review: 56,
-    // UpdateReviewRequest (optional)
-    updateReviewRequest: ...,
-  } satisfies UpdateReviewOperationRequest;
-  try {
-    const data = await api.updateReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **review** | `number` | The id of the review | [Defaults to `undefined`] |
-| **updateReviewRequest** | [UpdateReviewRequest](UpdateReviewRequest.md) |  | [Optional] |
-### Return type
-[**ReviewResource**](ReviewResource.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)