@digital8/lighting-illusions-ts-sdk 0.0.2146 → 0.0.2148

package/docs/CreateCartRequest.md

@@ -1,72 +0,0 @@
-
-# CreateCartRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`customerId` | number
-`siteId` | number
-`token` | string
-`sessionToken` | string
-`paymentToken` | string
-`guestEmail` | string
-`source` | string
-`items` | [Array<CreateCartRequestItemsInner>](CreateCartRequestItemsInner.md)
-`couponCodes` | Array<string>
-`shippingType` | string
-`shippingSubtotal` | number
-`overrideShipping` | boolean
-`insuranceAmount` | number
-`includeInsurance` | boolean
-`overrideInsurance` | boolean
-`useAsBillingAddress` | boolean
-`shippingAddressId` | number
-`billingAddressId` | number
-`shippingAddress` | [CreateCartRequestShippingAddress](CreateCartRequestShippingAddress.md)
-`billingAddress` | [CreateCartRequestShippingAddress](CreateCartRequestShippingAddress.md)
-
-## Example
-
-```typescript
-import type { CreateCartRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "customerId": null,
-  "siteId": null,
-  "token": null,
-  "sessionToken": null,
-  "paymentToken": null,
-  "guestEmail": null,
-  "source": null,
-  "items": null,
-  "couponCodes": null,
-  "shippingType": null,
-  "shippingSubtotal": null,
-  "overrideShipping": null,
-  "insuranceAmount": null,
-  "includeInsurance": null,
-  "overrideInsurance": null,
-  "useAsBillingAddress": null,
-  "shippingAddressId": null,
-  "billingAddressId": null,
-  "shippingAddress": null,
-  "billingAddress": null,
-} satisfies CreateCartRequest
-
-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 CreateCartRequest
-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/CreateCartRequestItemsInner.md

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

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

@@ -1,42 +0,0 @@
-
-# CreateCustomerRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`siteId` | number
-`firstName` | string
-`lastName` | string
-`email` | string
-`phone` | string
-
-## Example
-
-```typescript
-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,
-  "email": null,
-  "phone": null,
-} satisfies CreateCustomerRequest
-
-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 CreateCustomerRequest
-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/CreateTransactionRequest.md

@@ -1,48 +0,0 @@
-
-# CreateTransactionRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`cartId` | number
-`orderId` | number
-`amount` | number
-`surcharge` | number
-`paymentMethod` | string
-`description` | string
-`nonce` | string
-`deviceData` | string
-
-## Example
-
-```typescript
-import type { CreateTransactionRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "cartId": null,
-  "orderId": null,
-  "amount": null,
-  "surcharge": null,
-  "paymentMethod": null,
-  "description": null,
-  "nonce": null,
-  "deviceData": null,
-} satisfies CreateTransactionRequest
-
-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 CreateTransactionRequest
-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/CustomerListResource.md

@@ -1,44 +0,0 @@
-
-# CustomerListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`firstName` | string
-`lastName` | string
-`email` | string
-`phone` | string
-`site` | [SiteLiteResource](SiteLiteResource.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,
-  "site": 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

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

@@ -1,46 +0,0 @@
-
-# CustomerResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`firstName` | string
-`lastName` | string
-`email` | string
-`phone` | 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,
-  "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,206 +0,0 @@
-# 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

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

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