@digital8/lighting-illusions-ts-sdk 0.0.1813 → 0.0.1814

package/docs/CustomerListResource.md

@@ -1,48 +0,0 @@
-
-# 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/CustomerResource.md

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

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

@@ -1,140 +0,0 @@
-# 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 |
-| [**storeCustomer**](CustomersApi.md#storecustomeroperation) | **POST** /admin-api/customers/create | Auto-generated: storeCustomer |
-
-
-
-## 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)
-
-
-## 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)
-

package/docs/FrontendCartResource.md

@@ -1,76 +0,0 @@
-
-# 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
-`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,
-  "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

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

package/docs/IndexCartRequest.md

@@ -1,66 +0,0 @@
-
-# IndexCartRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`siteId` | Array<string>
-`source` | Array<string>
-`beforeCreatedAt` | Date
-`afterCreatedAt` | Date
-`beforeExpiryDate` | Date
-`afterExpiryDate` | Date
-`beforeCheckoutCompletedAt` | Date
-`afterCheckoutCompletedAt` | Date
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`status` | Array<string>
-
-## Example
-
-```typescript
-import type { IndexCartRequest } 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,
-  "siteId": null,
-  "source": null,
-  "beforeCreatedAt": null,
-  "afterCreatedAt": null,
-  "beforeExpiryDate": null,
-  "afterExpiryDate": null,
-  "beforeCheckoutCompletedAt": null,
-  "afterCheckoutCompletedAt": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "status": null,
-} satisfies IndexCartRequest
-
-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 IndexCartRequest
-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/IndexCustomerRequest.md

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

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

@@ -1,34 +0,0 @@
-
-# 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/LineItemListResource.md

@@ -1,40 +0,0 @@
-
-# LineItemListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`quantity` | number
-`productPrice` | number
-`productChild` | [ProductChildListResource](ProductChildListResource.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,
-  "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)
-
-

package/docs/LineItemListResourceArrayResponse.md

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

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