@digital8/lighting-illusions-ts-sdk 0.0.2152 → 0.0.2154

package/docs/CustomersApi.md

@@ -0,0 +1,206 @@
+# CustomersApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**indexCustomer**](CustomersApi.md#indexcustomer) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
+| [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
+| [**storeCustomer**](CustomersApi.md#storecustomer) | **POST** /admin-api/customers/create | Auto-generated: storeCustomer |
+
+
+
+## indexCustomer
+
+> PaginatedCustomerListResourceResponse indexCustomer(searchCustomersRequest)
+
+Auto-generated: indexCustomer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CustomersApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new CustomersApi();
+
+  const body = {
+    // SearchCustomersRequest (optional)
+    searchCustomersRequest: ...,
+  } satisfies IndexCustomerRequest;
+
+  try {
+    const data = await api.indexCustomer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchCustomersRequest** | [SearchCustomersRequest](SearchCustomersRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedCustomerListResourceResponse**](PaginatedCustomerListResourceResponse.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<\\CustomerListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showCustomer
+
+> CustomerResource showCustomer(customer)
+
+Auto-generated: showCustomer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CustomersApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new CustomersApi();
+
+  const body = {
+    // number | The id of the customer
+    customer: 56,
+  } satisfies ShowCustomerRequest;
+
+  try {
+    const data = await api.showCustomer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
+
+### Return type
+
+[**CustomerResource**](CustomerResource.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)
+
+
+## storeCustomer
+
+> CustomerResource storeCustomer(createCustomerRequest)
+
+Auto-generated: storeCustomer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CustomersApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new CustomersApi();
+
+  const body = {
+    // CreateCustomerRequest (optional)
+    createCustomerRequest: ...,
+  } satisfies StoreCustomerRequest;
+
+  try {
+    const data = await api.storeCustomer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createCustomerRequest** | [CreateCustomerRequest](CreateCustomerRequest.md) |  | [Optional] |
+
+### Return type
+
+[**CustomerResource**](CustomerResource.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/DetachCouponRequest.md

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

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

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

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

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

@@ -0,0 +1,52 @@
+
+# LiAddressResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`type` | string
+`company` | string
+`line1` | string
+`line2` | string
+`suburb` | string
+`state` | string
+`postcode` | string
+`country` | string
+`fullAddress` | string
+
+## Example
+
+```typescript
+import type { LiAddressResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "company": null,
+  "line1": null,
+  "line2": null,
+  "suburb": null,
+  "state": null,
+  "postcode": null,
+  "country": null,
+  "fullAddress": null,
+} satisfies LiAddressResource
+
+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 LiAddressResource
+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/LiAddressResourceArrayResponse.md

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

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

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

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

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

@@ -0,0 +1,52 @@
+
+# LineItemListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`quantity` | number
+`productPrice` | number
+`labelId` | number
+`label` | [LabelLiteResource](LabelLiteResource.md)
+`productDiscount` | number
+`totalDiscount` | number
+`lineSubtotal` | number
+`discounts` | [Array<LineItemDiscountResource>](LineItemDiscountResource.md)
+`productChild` | [ProductChildLineItemLiteResource](ProductChildLineItemLiteResource.md)
+
+## Example
+
+```typescript
+import type { LineItemListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "quantity": null,
+  "productPrice": null,
+  "labelId": null,
+  "label": null,
+  "productDiscount": null,
+  "totalDiscount": null,
+  "lineSubtotal": null,
+  "discounts": null,
+  "productChild": null,
+} satisfies LineItemListResource
+
+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 LineItemListResource
+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)
+
+