@digital8/lighting-illusions-ts-sdk 0.0.1878 → 0.0.1880

package/docs/{PageResource.md → CustomerListResource.md}

@@ -1,5 +1,5 @@
 
-# PageResource
+# CustomerListResource
 
 
 ## Properties
@@ -7,34 +7,28 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`name` | string
-`slug` | string
-`type` | object
-`enabled` | boolean
-`startDate` | Date
-`pageComponents` | object
-`blog` | [BlogResource](BlogResource.md)
-`seo` | [Array<SEOResource>](SEOResource.md)
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
+`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
 
 ## Example
 
 ```typescript
-import type { PageResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { CustomerListResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "name": null,
-  "slug": null,
-  "type": null,
-  "enabled": null,
-  "startDate": null,
-  "pageComponents": null,
-  "blog": null,
-  "seo": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
   "site": null,
-} satisfies PageResource
+  "addresses": null,
+} satisfies CustomerListResource
 
 console.log(example)
 
@@ -43,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PageResource
+const exampleParsed = JSON.parse(exampleJSON) as CustomerListResource
 console.log(exampleParsed)
 ```
 

package/docs/{BlogFrontendResourceArrayResponse.md → CustomerListResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# BlogFrontendResourceArrayResponse
+# CustomerListResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<BlogFrontendResource>](BlogFrontendResource.md)
+`data` | [Array<CustomerListResource>](CustomerListResource.md)
 
 ## Example
 
 ```typescript
-import type { BlogFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { CustomerListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies BlogFrontendResourceArrayResponse
+} satisfies CustomerListResourceArrayResponse
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as BlogFrontendResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as CustomerListResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/{PageListResource.md → CustomerResource.md}

@@ -1,5 +1,5 @@
 
-# PageListResource
+# CustomerResource
 
 
 ## Properties
@@ -7,36 +7,28 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`name` | string
-`slug` | string
-`type` | object
-`enabled` | boolean
-`siteId` | number
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
-`startDate` | Date
-`createdAt` | string
-`updatedAt` | string
+`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
 
 ## Example
 
 ```typescript
-import type { PageListResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { CustomerResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "name": null,
-  "slug": null,
-  "type": null,
-  "enabled": null,
-  "siteId": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
   "site": null,
-  "thumbnail": null,
-  "startDate": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies PageListResource
+  "addresses": null,
+} satisfies CustomerResource
 
 console.log(example)
 
@@ -45,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PageListResource
+const exampleParsed = JSON.parse(exampleJSON) as CustomerResource
 console.log(exampleParsed)
 ```
 

package/docs/{PageLiteResourceArrayResponse.md → CustomerResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# PageLiteResourceArrayResponse
+# CustomerResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<PageLiteResource>](PageLiteResource.md)
+`data` | [Array<CustomerResource>](CustomerResource.md)
 
 ## Example
 
 ```typescript
-import type { PageLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { CustomerResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies PageLiteResourceArrayResponse
+} satisfies CustomerResourceArrayResponse
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PageLiteResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as CustomerResourceArrayResponse
 console.log(exampleParsed)
 ```
 

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/DetachDocumentablesDocumentRequest.md

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

@@ -0,0 +1,36 @@
+
+# DetachDocumentablesDocumentRequestDocumentablesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentableType` | string
+`documentableId` | number
+
+## Example
+
+```typescript
+import type { DetachDocumentablesDocumentRequestDocumentablesInner } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentableType": null,
+  "documentableId": null,
+} satisfies DetachDocumentablesDocumentRequestDocumentablesInner
+
+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 DetachDocumentablesDocumentRequestDocumentablesInner
+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)
+
+