@digital8/lighting-illusions-ts-sdk 0.0.2364 → 0.0.2366

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)
-

package/docs/CreateCouponRequest.md

@@ -1,62 +0,0 @@
-
-# CreateCouponRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`siteId` | number
-`name` | string
-`code` | string
-`type` | string
-`discountType` | string
-`discountAmount` | number
-`minAmount` | number
-`minProducts` | number
-`totalUseLimit` | number
-`customerUseLimit` | number
-`startDate` | string
-`endDate` | string
-`isForAllProducts` | boolean
-`isForAllCustomers` | boolean
-`couponables` | [Array<CreateCouponRequestCouponablesInner>](CreateCouponRequestCouponablesInner.md)
-
-## Example
-
-```typescript
-import type { CreateCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "siteId": null,
-  "name": null,
-  "code": null,
-  "type": null,
-  "discountType": null,
-  "discountAmount": null,
-  "minAmount": null,
-  "minProducts": null,
-  "totalUseLimit": null,
-  "customerUseLimit": null,
-  "startDate": null,
-  "endDate": null,
-  "isForAllProducts": null,
-  "isForAllCustomers": null,
-  "couponables": null,
-} satisfies CreateCouponRequest
-
-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 CreateCouponRequest
-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/CreateCouponRequestCouponablesInner.md

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

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

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

@@ -1,50 +0,0 @@
-
-# SearchAllCouponsRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`type` | Array<string>
-`siteId` | Array<string>
-`isAbandonedCart` | Array<string>
-
-## Example
-
-```typescript
-import type { SearchAllCouponsRequest } 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,
-  "type": null,
-  "siteId": null,
-  "isAbandonedCart": null,
-} satisfies SearchAllCouponsRequest
-
-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 SearchAllCouponsRequest
-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/SearchCouponsRequest.md

@@ -1,62 +0,0 @@
-
-# SearchCouponsRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`type` | Array<string>
-`siteId` | Array<string>
-`isAbandonedCart` | Array<string>
-`beforeStartDate` | Date
-`afterStartDate` | Date
-`beforeEndDate` | Date
-`afterEndDate` | Date
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { SearchCouponsRequest } 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,
-  "type": null,
-  "siteId": null,
-  "isAbandonedCart": null,
-  "beforeStartDate": null,
-  "afterStartDate": null,
-  "beforeEndDate": null,
-  "afterEndDate": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies SearchCouponsRequest
-
-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 SearchCouponsRequest
-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)
-
-