@digital8/lighting-illusions-ts-sdk 0.0.1842 → 0.0.1843

package/docs/CustomerListResource.md

@@ -0,0 +1,48 @@
+
+# CustomerListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
+`siteId` | string
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
+
+## Example
+
+```typescript
+import type { CustomerListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
+  "siteId": null,
+  "site": null,
+  "addresses": null,
+} satisfies CustomerListResource
+
+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 CustomerListResource
+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/CustomerListResourceArrayResponse.md

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

@@ -0,0 +1,48 @@
+
+# CustomerResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
+`siteId` | string
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
+
+## Example
+
+```typescript
+import type { CustomerResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
+  "siteId": null,
+  "site": null,
+  "addresses": null,
+} satisfies CustomerResource
+
+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 CustomerResource
+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/CustomerResourceArrayResponse.md

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

@@ -0,0 +1,275 @@
+# CustomersApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**indexCustomer**](CustomersApi.md#indexcustomeroperation) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
+| [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
+| [**storeCustomer**](CustomersApi.md#storecustomeroperation) | **POST** /admin-api/customers/create | Auto-generated: storeCustomer |
+| [**updateCustomer**](CustomersApi.md#updatecustomeroperation) | **PUT** /admin-api/customers/{customer}/update | Auto-generated: updateCustomer |
+
+
+
+## indexCustomer
+
+> PaginatedCustomerListResourceResponse indexCustomer(indexCustomerRequest)
+
+Auto-generated: indexCustomer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CustomersApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexCustomerOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new CustomersApi();
+
+  const body = {
+    // IndexCustomerRequest (optional)
+    indexCustomerRequest: ...,
+  } satisfies IndexCustomerOperationRequest;
+
+  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 |
+|------------- | ------------- | ------------- | -------------|
+| **indexCustomerRequest** | [IndexCustomerRequest](IndexCustomerRequest.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(storeCustomerRequest)
+
+Auto-generated: storeCustomer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CustomersApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreCustomerOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new CustomersApi();
+
+  const body = {
+    // StoreCustomerRequest (optional)
+    storeCustomerRequest: ...,
+  } satisfies StoreCustomerOperationRequest;
+
+  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 |
+|------------- | ------------- | ------------- | -------------|
+| **storeCustomerRequest** | [StoreCustomerRequest](StoreCustomerRequest.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)
+
+
+## updateCustomer
+
+> CustomerResource updateCustomer(customer, updateCustomerRequest)
+
+Auto-generated: updateCustomer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CustomersApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateCustomerOperationRequest } 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,
+    // UpdateCustomerRequest (optional)
+    updateCustomerRequest: ...,
+  } satisfies UpdateCustomerOperationRequest;
+
+  try {
+    const data = await api.updateCustomer(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`] |
+| **updateCustomerRequest** | [UpdateCustomerRequest](UpdateCustomerRequest.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/DetachCouponCartRequest.md

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

@@ -0,0 +1,80 @@
+
+# FrontendCartResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`siteId` | number
+`customerId` | number
+`source` | string
+`sessionToken` | string
+`expiryDate` | Date
+`checkoutCompletedAt` | Date
+`createdAt` | Date
+`updatedAt` | Date
+`shippingType` | string
+`useAsBillingAddress` | boolean
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`customer` | [CustomerListResource](CustomerListResource.md)
+`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
+`coupons` | object
+`shippingAddress` | [AddressResource](AddressResource.md)
+`billingAddress` | [AddressResource](AddressResource.md)
+`subtotal` | number
+`discountPreview` | number
+`totalSubtotalDiscount` | number
+`totalShippingDiscount` | number
+`shippingEstimate` | number
+`insuranceEstimate` | number
+`status` | string
+
+## Example
+
+```typescript
+import type { FrontendCartResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "siteId": null,
+  "customerId": null,
+  "source": null,
+  "sessionToken": null,
+  "expiryDate": null,
+  "checkoutCompletedAt": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "shippingType": null,
+  "useAsBillingAddress": null,
+  "site": null,
+  "customer": null,
+  "lineItems": null,
+  "coupons": null,
+  "shippingAddress": null,
+  "billingAddress": null,
+  "subtotal": null,
+  "discountPreview": null,
+  "totalSubtotalDiscount": null,
+  "totalShippingDiscount": null,
+  "shippingEstimate": null,
+  "insuranceEstimate": null,
+  "status": null,
+} satisfies FrontendCartResource
+
+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 FrontendCartResource
+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/FrontendCartResourceArrayResponse.md

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