@digital8/lighting-illusions-ts-sdk 0.0.2339 → 0.0.2341

package/docs/CouponsApi.md

@@ -0,0 +1,407 @@
+# 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

@@ -0,0 +1,62 @@
+
+# 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/{RoleLiteResource.md → CreateCouponRequestCouponablesInner.md}

@@ -1,26 +1,24 @@
 
-# RoleLiteResource
+# CreateCouponRequestCouponablesInner
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`type` | string
 `id` | number
-`name` | string
-`isLocked` | boolean
 
 ## Example
 
 ```typescript
-import type { RoleLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { CreateCouponRequestCouponablesInner } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
+  "type": null,
   "id": null,
-  "name": null,
-  "isLocked": null,
-} satisfies RoleLiteResource
+} satisfies CreateCouponRequestCouponablesInner
 
 console.log(example)
 
@@ -29,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 RoleLiteResource
+const exampleParsed = JSON.parse(exampleJSON) as CreateCouponRequestCouponablesInner
 console.log(exampleParsed)
 ```
 

package/docs/CreateCustomerRequest.md

@@ -6,14 +6,11 @@
 
 Name | Type
 ------------ | -------------
+`siteId` | number
 `firstName` | string
 `lastName` | string
-`phone` | string
-`password` | string
 `email` | string
-`siteId` | number
-`subscribedToNewsletter` | boolean
-`netsuiteId` | number
+`phone` | string
 
 ## Example
 
@@ -22,14 +19,11 @@ import type { CreateCustomerRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
+  "siteId": null,
   "firstName": null,
   "lastName": null,
-  "phone": null,
-  "password": null,
   "email": null,
-  "siteId": null,
-  "subscribedToNewsletter": null,
-  "netsuiteId": null,
+  "phone": null,
 } satisfies CreateCustomerRequest
 
 console.log(example)

package/docs/CustomerListResource.md

@@ -7,14 +7,11 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`user` | [UserLiteResource](UserLiteResource.md)
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`type` | string
-`signUpType` | string
-`subscribedToNewsletter` | boolean
-`netsuiteId` | object
-`ordersCount` | number
-`createdAt` | Date
 
 ## Example
 
@@ -24,14 +21,11 @@ import type { CustomerListResource } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "user": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
   "site": null,
-  "type": null,
-  "signUpType": null,
-  "subscribedToNewsletter": null,
-  "netsuiteId": null,
-  "ordersCount": null,
-  "createdAt": null,
 } satisfies CustomerListResource
 
 console.log(example)

package/docs/CustomerResource.md

@@ -7,17 +7,12 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`user` | [UserLiteResource](UserLiteResource.md)
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`type` | string
-`signUpType` | string
-`socialId` | string
-`subscribedToNewsletter` | boolean
-`netsuiteSync` | [NetsuiteSyncLiteResource](NetsuiteSyncLiteResource.md)
-`omnisendSync` | [OmnisendSyncLiteResource](OmnisendSyncLiteResource.md)
-`addresses` | [Array<AddressResource>](AddressResource.md)
-`createdAt` | Date
-`updatedAt` | Date
+`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
 
 ## Example
 
@@ -27,17 +22,12 @@ import type { CustomerResource } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "user": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
   "site": null,
-  "type": null,
-  "signUpType": null,
-  "socialId": null,
-  "subscribedToNewsletter": null,
-  "netsuiteSync": null,
-  "omnisendSync": null,
   "addresses": null,
-  "createdAt": null,
-  "updatedAt": null,
 } satisfies CustomerResource
 
 console.log(example)