@digital8/lighting-illusions-ts-sdk 0.0.2293 → 0.0.2295

package/docs/AdminOrderLineItemResourceArrayResponse.md

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

@@ -1,120 +0,0 @@
-
-# AdminOrderResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`cartId` | number
-`placedAt` | Date
-`createdAt` | Date
-`updatedAt` | Date
-`source` | string
-`paymentToken` | string
-`shippingType` | string
-`shippingSubtotal` | number
-`overrideShipping` | boolean
-`lockedInsuranceAmount` | number
-`includeInsurance` | boolean
-`overrideInsurance` | boolean
-`useAsBillingAddress` | boolean
-`netsuiteId` | number
-`isNetsuiteLocked` | boolean
-`subtotal` | number
-`productDiscountAmount` | number
-`subtotalDiscountAmount` | number
-`shippingDiscountAmount` | number
-`shippingAmount` | number
-`total` | number
-`discountAmount` | number
-`finalTotalAmount` | number
-`totalAmount` | number
-`totalShipping` | number
-`grandTotal` | number
-`totalPaid` | number
-`totalOutstanding` | number
-`insuranceEstimate` | number
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`fulfillmentStatus` | string
-`fulfillmentsCount` | object
-`latestFulfillment` | [OrderFulfillmentResource](OrderFulfillmentResource.md)
-`customer` | [CustomerResource](CustomerResource.md)
-`admin` | [AdminUserLiteResource](AdminUserLiteResource.md)
-`status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
-`lineItems` | [Array<AdminOrderLineItemResource>](AdminOrderLineItemResource.md)
-`coupons` | [Array<CartCouponResource>](CartCouponResource.md)
-`discounts` | [Array<DiscountResource>](DiscountResource.md)
-`transactions` | [Array<TransactionLiteResource>](TransactionLiteResource.md)
-`shippingAddress` | [AddressResource](AddressResource.md)
-`billingAddress` | [AddressResource](AddressResource.md)
-`omnisendSync` | [OmnisendSyncLiteResource](OmnisendSyncLiteResource.md)
-
-## Example
-
-```typescript
-import type { AdminOrderResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "cartId": null,
-  "placedAt": null,
-  "createdAt": null,
-  "updatedAt": null,
-  "source": null,
-  "paymentToken": null,
-  "shippingType": null,
-  "shippingSubtotal": null,
-  "overrideShipping": null,
-  "lockedInsuranceAmount": null,
-  "includeInsurance": null,
-  "overrideInsurance": null,
-  "useAsBillingAddress": null,
-  "netsuiteId": null,
-  "isNetsuiteLocked": null,
-  "subtotal": null,
-  "productDiscountAmount": null,
-  "subtotalDiscountAmount": null,
-  "shippingDiscountAmount": null,
-  "shippingAmount": null,
-  "total": null,
-  "discountAmount": null,
-  "finalTotalAmount": null,
-  "totalAmount": null,
-  "totalShipping": null,
-  "grandTotal": null,
-  "totalPaid": null,
-  "totalOutstanding": null,
-  "insuranceEstimate": null,
-  "site": null,
-  "fulfillmentStatus": null,
-  "fulfillmentsCount": null,
-  "latestFulfillment": null,
-  "customer": null,
-  "admin": null,
-  "status": null,
-  "lineItems": null,
-  "coupons": null,
-  "discounts": null,
-  "transactions": null,
-  "shippingAddress": null,
-  "billingAddress": null,
-  "omnisendSync": null,
-} satisfies AdminOrderResource
-
-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 AdminOrderResource
-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/AdminOrderResourceArrayResponse.md

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

@@ -1,44 +0,0 @@
-
-# AdminResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`user` | [UserLiteResource](UserLiteResource.md)
-`roles` | [Array<RoleLiteResource>](RoleLiteResource.md)
-`permissions` | object
-`createdAt` | Date
-`updatedAt` | Date
-
-## Example
-
-```typescript
-import type { AdminResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "user": null,
-  "roles": null,
-  "permissions": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies AdminResource
-
-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 AdminResource
-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/AdminResourceArrayResponse.md

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

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

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