@digital8/lighting-illusions-ts-sdk 0.0.2097 → 0.0.2099

package/docs/OrdersApi.md

@@ -1,879 +0,0 @@
-# OrdersApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**attachCouponOrder**](OrdersApi.md#attachcouponorder) | **POST** /admin-api/orders/{order}/coupons/attach | Auto-generated: attachCouponOrder |
-| [**attachItemOrder**](OrdersApi.md#attachitemorder) | **POST** /admin-api/orders/{order}/line-items/attach | Auto-generated: attachItemOrder |
-| [**destroyOrder**](OrdersApi.md#destroyorder) | **DELETE** /admin-api/orders/{order}/delete | Auto-generated: destroyOrder |
-| [**detachCouponOrder**](OrdersApi.md#detachcouponorder) | **DELETE** /admin-api/orders/{order}/coupons/detach | Auto-generated: detachCouponOrder |
-| [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
-| [**getAllOrder**](OrdersApi.md#getallorder) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
-| [**indexOrder**](OrdersApi.md#indexorder) | **POST** /admin-api/orders/list | Auto-generated: indexOrder |
-| [**pdfOrder**](OrdersApi.md#pdforder) | **POST** /admin-api/orders/{order}/pdf | Auto-generated: pdfOrder |
-| [**sendPaymentLinkOrder**](OrdersApi.md#sendpaymentlinkorder) | **POST** /admin-api/orders/{order}/send-payment-link | Auto-generated: sendPaymentLinkOrder |
-| [**showOrder**](OrdersApi.md#showorder) | **GET** /admin-api/orders/{order} | Auto-generated: showOrder |
-| [**statusesAllOrder**](OrdersApi.md#statusesallorder) | **POST** /admin-api/orders/statuses/all | Auto-generated: statusesAllOrder |
-| [**updateItemOrder**](OrdersApi.md#updateitemorder) | **PUT** /admin-api/orders/{order}/line-items/{lineItem}/update | Auto-generated: updateItemOrder |
-| [**updateOrder**](OrdersApi.md#updateorderoperation) | **PUT** /admin-api/orders/{order}/update | Auto-generated: updateOrder |
-
-
-
-## attachCouponOrder
-
-> AdminOrderResource attachCouponOrder(order, attachCouponRequest)
-
-Auto-generated: attachCouponOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachCouponOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-    // AttachCouponRequest (optional)
-    attachCouponRequest: ...,
-  } satisfies AttachCouponOrderRequest;
-
-  try {
-    const data = await api.attachCouponOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [Defaults to `undefined`] |
-| **attachCouponRequest** | [AttachCouponRequest](AttachCouponRequest.md) |  | [Optional] |
-
-### Return type
-
-[**AdminOrderResource**](AdminOrderResource.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)
-
-
-## attachItemOrder
-
-> AdminOrderResource attachItemOrder(order, attachLineItemRequest)
-
-Auto-generated: attachItemOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachItemOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-    // AttachLineItemRequest (optional)
-    attachLineItemRequest: ...,
-  } satisfies AttachItemOrderRequest;
-
-  try {
-    const data = await api.attachItemOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [Defaults to `undefined`] |
-| **attachLineItemRequest** | [AttachLineItemRequest](AttachLineItemRequest.md) |  | [Optional] |
-
-### Return type
-
-[**AdminOrderResource**](AdminOrderResource.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)
-
-
-## destroyOrder
-
-> GenericResponse destroyOrder(order)
-
-Auto-generated: destroyOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-  } satisfies DestroyOrderRequest;
-
-  try {
-    const data = await api.destroyOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [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)
-
-
-## detachCouponOrder
-
-> AdminOrderResource detachCouponOrder(order, detachCouponRequest)
-
-Auto-generated: detachCouponOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachCouponOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-    // DetachCouponRequest (optional)
-    detachCouponRequest: ...,
-  } satisfies DetachCouponOrderRequest;
-
-  try {
-    const data = await api.detachCouponOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [Defaults to `undefined`] |
-| **detachCouponRequest** | [DetachCouponRequest](DetachCouponRequest.md) |  | [Optional] |
-
-### Return type
-
-[**AdminOrderResource**](AdminOrderResource.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)
-
-
-## detachItemOrder
-
-> AdminOrderResource detachItemOrder(order, lineItem)
-
-Auto-generated: detachItemOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachItemOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-    // number | The id of the lineItem
-    lineItem: 56,
-  } satisfies DetachItemOrderRequest;
-
-  try {
-    const data = await api.detachItemOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [Defaults to `undefined`] |
-| **lineItem** | `number` | The id of the lineItem | [Defaults to `undefined`] |
-
-### Return type
-
-[**AdminOrderResource**](AdminOrderResource.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)
-
-
-## getAllOrder
-
-> OrderLiteResourceArrayResponse getAllOrder(searchAllOrdersRequest)
-
-Auto-generated: getAllOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // SearchAllOrdersRequest (optional)
-    searchAllOrdersRequest: ...,
-  } satisfies GetAllOrderRequest;
-
-  try {
-    const data = await api.getAllOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchAllOrdersRequest** | [SearchAllOrdersRequest](SearchAllOrdersRequest.md) |  | [Optional] |
-
-### Return type
-
-[**OrderLiteResourceArrayResponse**](OrderLiteResourceArrayResponse.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)
-
-
-## indexOrder
-
-> PaginatedOrderListResourceResponse indexOrder(searchOrdersRequest)
-
-Auto-generated: indexOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // SearchOrdersRequest (optional)
-    searchOrdersRequest: ...,
-  } satisfies IndexOrderRequest;
-
-  try {
-    const data = await api.indexOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchOrdersRequest** | [SearchOrdersRequest](SearchOrdersRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedOrderListResourceResponse**](PaginatedOrderListResourceResponse.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<\\OrderListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## pdfOrder
-
-> GenericResponse pdfOrder(order)
-
-Auto-generated: pdfOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { PdfOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-  } satisfies PdfOrderRequest;
-
-  try {
-    const data = await api.pdfOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [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** | \\Response |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## sendPaymentLinkOrder
-
-> AdminOrderResource sendPaymentLinkOrder(order)
-
-Auto-generated: sendPaymentLinkOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { SendPaymentLinkOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-  } satisfies SendPaymentLinkOrderRequest;
-
-  try {
-    const data = await api.sendPaymentLinkOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [Defaults to `undefined`] |
-
-### Return type
-
-[**AdminOrderResource**](AdminOrderResource.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)
-
-
-## showOrder
-
-> AdminOrderResource showOrder(order)
-
-Auto-generated: showOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-  } satisfies ShowOrderRequest;
-
-  try {
-    const data = await api.showOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [Defaults to `undefined`] |
-
-### Return type
-
-[**AdminOrderResource**](AdminOrderResource.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)
-
-
-## statusesAllOrder
-
-> OrderStatusWithCountResourceArrayResponse statusesAllOrder()
-
-Auto-generated: statusesAllOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StatusesAllOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  try {
-    const data = await api.statusesAllOrder();
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**OrderStatusWithCountResourceArrayResponse**](OrderStatusWithCountResourceArrayResponse.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)
-
-
-## updateItemOrder
-
-> AdminOrderResource updateItemOrder(order, lineItem, updateLineItemRequest)
-
-Auto-generated: updateItemOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateItemOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-    // number | The id of the lineItem
-    lineItem: 56,
-    // UpdateLineItemRequest (optional)
-    updateLineItemRequest: ...,
-  } satisfies UpdateItemOrderRequest;
-
-  try {
-    const data = await api.updateItemOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [Defaults to `undefined`] |
-| **lineItem** | `number` | The id of the lineItem | [Defaults to `undefined`] |
-| **updateLineItemRequest** | [UpdateLineItemRequest](UpdateLineItemRequest.md) |  | [Optional] |
-
-### Return type
-
-[**AdminOrderResource**](AdminOrderResource.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)
-
-
-## updateOrder
-
-> AdminOrderResource updateOrder(order, updateOrderRequest)
-
-Auto-generated: updateOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OrdersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateOrderOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new OrdersApi();
-
-  const body = {
-    // number | The id of the order
-    order: 56,
-    // UpdateOrderRequest (optional)
-    updateOrderRequest: ...,
-  } satisfies UpdateOrderOperationRequest;
-
-  try {
-    const data = await api.updateOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **order** | `number` | The id of the order | [Defaults to `undefined`] |
-| **updateOrderRequest** | [UpdateOrderRequest](UpdateOrderRequest.md) |  | [Optional] |
-
-### Return type
-
-[**AdminOrderResource**](AdminOrderResource.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)
-