@digital8/lighting-illusions-ts-sdk 0.0.2199 → 0.0.2201

package/docs/AdminsApi.md

@@ -0,0 +1,407 @@
+# AdminsApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyAdminUser**](AdminsApi.md#destroyadminuser) | **DELETE** /admin-api/admins/{admin}/delete | Auto-generated: destroyAdminUser |
+| [**getAllAdminUser**](AdminsApi.md#getalladminuser) | **POST** /admin-api/admins/all | Auto-generated: getAllAdminUser |
+| [**indexAdminUser**](AdminsApi.md#indexadminuser) | **POST** /admin-api/admins/list | Auto-generated: indexAdminUser |
+| [**showAdminUser**](AdminsApi.md#showadminuser) | **GET** /admin-api/admins/{admin} | Auto-generated: showAdminUser |
+| [**storeAdminUser**](AdminsApi.md#storeadminuser) | **POST** /admin-api/admins/create | Auto-generated: storeAdminUser |
+| [**updateAdminUser**](AdminsApi.md#updateadminuseroperation) | **PUT** /admin-api/admins/{admin}/update | Auto-generated: updateAdminUser |
+
+
+
+## destroyAdminUser
+
+> GenericResponse destroyAdminUser(admin)
+
+Auto-generated: destroyAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // number | The id of the admin
+    admin: 56,
+  } satisfies DestroyAdminUserRequest;
+
+  try {
+    const data = await api.destroyAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAllAdminUser
+
+> AdminLiteResourceArrayResponse getAllAdminUser(searchAllAdminUsersRequest)
+
+Auto-generated: getAllAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // SearchAllAdminUsersRequest (optional)
+    searchAllAdminUsersRequest: ...,
+  } satisfies GetAllAdminUserRequest;
+
+  try {
+    const data = await api.getAllAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchAllAdminUsersRequest** | [SearchAllAdminUsersRequest](SearchAllAdminUsersRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AdminLiteResourceArrayResponse**](AdminLiteResourceArrayResponse.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)
+
+
+## indexAdminUser
+
+> PaginatedAdminListResourceResponse indexAdminUser(searchAdminUsersRequest)
+
+Auto-generated: indexAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // SearchAdminUsersRequest (optional)
+    searchAdminUsersRequest: ...,
+  } satisfies IndexAdminUserRequest;
+
+  try {
+    const data = await api.indexAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchAdminUsersRequest** | [SearchAdminUsersRequest](SearchAdminUsersRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedAdminListResourceResponse**](PaginatedAdminListResourceResponse.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<\\AdminListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showAdminUser
+
+> AdminResource showAdminUser(admin)
+
+Auto-generated: showAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // number | The id of the admin
+    admin: 56,
+  } satisfies ShowAdminUserRequest;
+
+  try {
+    const data = await api.showAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
+
+### Return type
+
+[**AdminResource**](AdminResource.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)
+
+
+## storeAdminUser
+
+> AdminResource storeAdminUser(createAdminUserRequest)
+
+Auto-generated: storeAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // CreateAdminUserRequest (optional)
+    createAdminUserRequest: ...,
+  } satisfies StoreAdminUserRequest;
+
+  try {
+    const data = await api.storeAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createAdminUserRequest** | [CreateAdminUserRequest](CreateAdminUserRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AdminResource**](AdminResource.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)
+
+
+## updateAdminUser
+
+> AdminResource updateAdminUser(admin, updateAdminUserRequest)
+
+Auto-generated: updateAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateAdminUserOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // number | The id of the admin
+    admin: 56,
+    // UpdateAdminUserRequest (optional)
+    updateAdminUserRequest: ...,
+  } satisfies UpdateAdminUserOperationRequest;
+
+  try {
+    const data = await api.updateAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
+| **updateAdminUserRequest** | [UpdateAdminUserRequest](UpdateAdminUserRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AdminResource**](AdminResource.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/AttachCouponRequest.md

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

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

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

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

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

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

@@ -0,0 +1,52 @@
+
+# CartListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`guestEmail` | string
+`source` | string
+`checkoutCompletedAt` | Date
+`createdAt` | Date
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`customer` | [CustomerListResource](CustomerListResource.md)
+`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
+`subtotal` | number
+`status` | string
+
+## Example
+
+```typescript
+import type { CartListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "guestEmail": null,
+  "source": null,
+  "checkoutCompletedAt": null,
+  "createdAt": null,
+  "site": null,
+  "customer": null,
+  "lineItems": null,
+  "subtotal": null,
+  "status": null,
+} satisfies CartListResource
+
+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 CartListResource
+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)
+
+