@digital8/lighting-illusions-ts-sdk 0.0.2187 → 0.0.2189

package/docs/CouponListResource.md

@@ -1,56 +0,0 @@
-
-# CouponListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`code` | string
-`type` | object
-`discountType` | object
-`discountAmount` | number
-`startDate` | Date
-`endDate` | Date
-`isAbandonedCart` | boolean
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`ordersCount` | number
-`cartsCount` | number
-
-## Example
-
-```typescript
-import type { CouponListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "code": null,
-  "type": null,
-  "discountType": null,
-  "discountAmount": null,
-  "startDate": null,
-  "endDate": null,
-  "isAbandonedCart": null,
-  "site": null,
-  "ordersCount": null,
-  "cartsCount": null,
-} satisfies CouponListResource
-
-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 CouponListResource
-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/CouponListResourceArrayResponse.md

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

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

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

@@ -1,78 +0,0 @@
-
-# CouponResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`siteId` | number
-`name` | string
-`code` | string
-`type` | object
-`discountType` | object
-`discountAmount` | number
-`minAmount` | number
-`minProducts` | number
-`totalUseLimit` | number
-`customerUseLimit` | number
-`isAbandonedCart` | boolean
-`isForAllProducts` | boolean
-`isForAllCustomers` | boolean
-`startDate` | Date
-`endDate` | Date
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`productChildren` | object
-`categories` | object
-`suppliers` | object
-`customers` | [Array<CustomerListResource>](CustomerListResource.md)
-`ordersCount` | number
-`cartsCount` | number
-
-## Example
-
-```typescript
-import type { CouponResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "siteId": null,
-  "name": null,
-  "code": null,
-  "type": null,
-  "discountType": null,
-  "discountAmount": null,
-  "minAmount": null,
-  "minProducts": null,
-  "totalUseLimit": null,
-  "customerUseLimit": null,
-  "isAbandonedCart": null,
-  "isForAllProducts": null,
-  "isForAllCustomers": null,
-  "startDate": null,
-  "endDate": null,
-  "site": null,
-  "productChildren": null,
-  "categories": null,
-  "suppliers": null,
-  "customers": null,
-  "ordersCount": null,
-  "cartsCount": null,
-} satisfies CouponResource
-
-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 CouponResource
-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/CouponResourceArrayResponse.md

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

@@ -1,32 +0,0 @@
-
-# CouponType
-
-
-## Properties
-
-Name | Type
------------- | -------------
-
-## Example
-
-```typescript
-import type { CouponType } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-} satisfies CouponType
-
-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 CouponType
-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/CouponsApi.md

@@ -1,407 +0,0 @@
-# CouponsApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyCoupon**](CouponsApi.md#destroycoupon) | **DELETE** /admin-api/coupons/{coupon}/delete | Auto-generated: destroyCoupon |
-| [**getAllCoupon**](CouponsApi.md#getallcoupon) | **POST** /admin-api/coupons/all | Auto-generated: getAllCoupon |
-| [**indexCoupon**](CouponsApi.md#indexcoupon) | **POST** /admin-api/coupons/list | Auto-generated: indexCoupon |
-| [**showCoupon**](CouponsApi.md#showcoupon) | **GET** /admin-api/coupons/{coupon} | Auto-generated: showCoupon |
-| [**storeCoupon**](CouponsApi.md#storecoupon) | **POST** /admin-api/coupons/create | Auto-generated: storeCoupon |
-| [**updateCoupon**](CouponsApi.md#updatecouponoperation) | **PUT** /admin-api/coupons/{coupon}/update | Auto-generated: updateCoupon |
-
-
-
-## destroyCoupon
-
-> GenericResponse destroyCoupon(coupon)
-
-Auto-generated: destroyCoupon
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CouponsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
-
-  const body = {
-    // number | The id of the coupon
-    coupon: 56,
-  } satisfies DestroyCouponRequest;
-
-  try {
-    const data = await api.destroyCoupon(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **coupon** | `number` | The id of the coupon | [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)
-
-
-## getAllCoupon
-
-> CouponLiteResourceArrayResponse getAllCoupon(searchAllCouponsRequest)
-
-Auto-generated: getAllCoupon
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CouponsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
-
-  const body = {
-    // SearchAllCouponsRequest (optional)
-    searchAllCouponsRequest: ...,
-  } satisfies GetAllCouponRequest;
-
-  try {
-    const data = await api.getAllCoupon(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchAllCouponsRequest** | [SearchAllCouponsRequest](SearchAllCouponsRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CouponLiteResourceArrayResponse**](CouponLiteResourceArrayResponse.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)
-
-
-## indexCoupon
-
-> PaginatedCouponListResourceResponse indexCoupon(searchCouponsRequest)
-
-Auto-generated: indexCoupon
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CouponsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
-
-  const body = {
-    // SearchCouponsRequest (optional)
-    searchCouponsRequest: ...,
-  } satisfies IndexCouponRequest;
-
-  try {
-    const data = await api.indexCoupon(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchCouponsRequest** | [SearchCouponsRequest](SearchCouponsRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedCouponListResourceResponse**](PaginatedCouponListResourceResponse.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<\\CouponListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## showCoupon
-
-> CouponResource showCoupon(coupon)
-
-Auto-generated: showCoupon
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CouponsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
-
-  const body = {
-    // number | The id of the coupon
-    coupon: 56,
-  } satisfies ShowCouponRequest;
-
-  try {
-    const data = await api.showCoupon(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **coupon** | `number` | The id of the coupon | [Defaults to `undefined`] |
-
-### Return type
-
-[**CouponResource**](CouponResource.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)
-
-
-## storeCoupon
-
-> CouponResource storeCoupon(createCouponRequest)
-
-Auto-generated: storeCoupon
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CouponsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
-
-  const body = {
-    // CreateCouponRequest (optional)
-    createCouponRequest: ...,
-  } satisfies StoreCouponRequest;
-
-  try {
-    const data = await api.storeCoupon(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **createCouponRequest** | [CreateCouponRequest](CreateCouponRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CouponResource**](CouponResource.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)
-
-
-## updateCoupon
-
-> CouponResource updateCoupon(coupon, updateCouponRequest)
-
-Auto-generated: updateCoupon
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CouponsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateCouponOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
-
-  const body = {
-    // number | The id of the coupon
-    coupon: 56,
-    // UpdateCouponRequest (optional)
-    updateCouponRequest: ...,
-  } satisfies UpdateCouponOperationRequest;
-
-  try {
-    const data = await api.updateCoupon(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **coupon** | `number` | The id of the coupon | [Defaults to `undefined`] |
-| **updateCouponRequest** | [UpdateCouponRequest](UpdateCouponRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CouponResource**](CouponResource.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)
-