@digital8/lighting-illusions-ts-sdk 0.0.2188 → 0.0.2189

package/docs/CartsApi.md

@@ -1,821 +0,0 @@
-# CartsApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**attachCouponCart**](CartsApi.md#attachcouponcart) | **POST** /admin-api/carts/{cart}/coupons/attach | Auto-generated: attachCouponCart |
-| [**attachItemCart**](CartsApi.md#attachitemcart) | **POST** /admin-api/carts/{cart}/items/attach | Auto-generated: attachItemCart |
-| [**destroyCart**](CartsApi.md#destroycart) | **DELETE** /admin-api/carts/{cart}/delete | Auto-generated: destroyCart |
-| [**detachCouponCart**](CartsApi.md#detachcouponcart) | **DELETE** /admin-api/carts/{cart}/coupons/detach | Auto-generated: detachCouponCart |
-| [**detachItemCart**](CartsApi.md#detachitemcart) | **DELETE** /admin-api/carts/{cart}/items/{lineItem}/detach | Auto-generated: detachItemCart |
-| [**indexCart**](CartsApi.md#indexcart) | **POST** /admin-api/carts/list | Auto-generated: indexCart |
-| [**sendPaymentLinkCart**](CartsApi.md#sendpaymentlinkcart) | **POST** /admin-api/carts/{cart}/send-payment-link | Auto-generated: sendPaymentLinkCart |
-| [**showCart**](CartsApi.md#showcart) | **GET** /admin-api/carts/{cart} | Auto-generated: showCart |
-| [**storeCart**](CartsApi.md#storecart) | **POST** /admin-api/carts/create | Auto-generated: storeCart |
-| [**storeFromCartOrder**](CartsApi.md#storefromcartorder) | **POST** /admin-api/carts/{cart}/place-order | Auto-generated: storeFromCartOrder |
-| [**updateCart**](CartsApi.md#updatecartoperation) | **PUT** /admin-api/carts/{cart}/update | Auto-generated: updateCart |
-| [**updateItemCart**](CartsApi.md#updateitemcart) | **PUT** /admin-api/carts/{cart}/items/{lineItem}/update | Auto-generated: updateItemCart |
-
-
-
-## attachCouponCart
-
-> CartResource attachCouponCart(cart, attachCouponRequest)
-
-Auto-generated: attachCouponCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachCouponCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-    // AttachCouponRequest (optional)
-    attachCouponRequest: ...,
-  } satisfies AttachCouponCartRequest;
-
-  try {
-    const data = await api.attachCouponCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-| **attachCouponRequest** | [AttachCouponRequest](AttachCouponRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CartResource**](CartResource.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)
-
-
-## attachItemCart
-
-> CartResource attachItemCart(cart, attachLineItemRequest)
-
-Auto-generated: attachItemCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachItemCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-    // AttachLineItemRequest (optional)
-    attachLineItemRequest: ...,
-  } satisfies AttachItemCartRequest;
-
-  try {
-    const data = await api.attachItemCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-| **attachLineItemRequest** | [AttachLineItemRequest](AttachLineItemRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CartResource**](CartResource.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)
-
-
-## destroyCart
-
-> GenericResponse destroyCart(cart)
-
-Auto-generated: destroyCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-  } satisfies DestroyCartRequest;
-
-  try {
-    const data = await api.destroyCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [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)
-
-
-## detachCouponCart
-
-> CartResource detachCouponCart(cart, detachCouponRequest)
-
-Auto-generated: detachCouponCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachCouponCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-    // DetachCouponRequest (optional)
-    detachCouponRequest: ...,
-  } satisfies DetachCouponCartRequest;
-
-  try {
-    const data = await api.detachCouponCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-| **detachCouponRequest** | [DetachCouponRequest](DetachCouponRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CartResource**](CartResource.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)
-
-
-## detachItemCart
-
-> CartResource detachItemCart(cart, lineItem)
-
-Auto-generated: detachItemCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachItemCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-    // number | The id of the lineItem
-    lineItem: 56,
-  } satisfies DetachItemCartRequest;
-
-  try {
-    const data = await api.detachItemCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-| **lineItem** | `number` | The id of the lineItem | [Defaults to `undefined`] |
-
-### Return type
-
-[**CartResource**](CartResource.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)
-
-
-## indexCart
-
-> PaginatedCartListResourceResponse indexCart(searchCartsRequest)
-
-Auto-generated: indexCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // SearchCartsRequest (optional)
-    searchCartsRequest: ...,
-  } satisfies IndexCartRequest;
-
-  try {
-    const data = await api.indexCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchCartsRequest** | [SearchCartsRequest](SearchCartsRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedCartListResourceResponse**](PaginatedCartListResourceResponse.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<\\CartListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## sendPaymentLinkCart
-
-> CartResource sendPaymentLinkCart(cart)
-
-Auto-generated: sendPaymentLinkCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { SendPaymentLinkCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-  } satisfies SendPaymentLinkCartRequest;
-
-  try {
-    const data = await api.sendPaymentLinkCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-
-### Return type
-
-[**CartResource**](CartResource.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)
-
-
-## showCart
-
-> CartResource showCart(cart)
-
-Auto-generated: showCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-  } satisfies ShowCartRequest;
-
-  try {
-    const data = await api.showCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-
-### Return type
-
-[**CartResource**](CartResource.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)
-
-
-## storeCart
-
-> CartResource storeCart(createCartRequest)
-
-Auto-generated: storeCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // CreateCartRequest (optional)
-    createCartRequest: ...,
-  } satisfies StoreCartRequest;
-
-  try {
-    const data = await api.storeCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **createCartRequest** | [CreateCartRequest](CreateCartRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CartResource**](CartResource.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)
-
-
-## storeFromCartOrder
-
-> AdminOrderResource storeFromCartOrder(cart)
-
-Auto-generated: storeFromCartOrder
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreFromCartOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-  } satisfies StoreFromCartOrderRequest;
-
-  try {
-    const data = await api.storeFromCartOrder(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [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)
-
-
-## updateCart
-
-> CartResource updateCart(cart, updateCartRequest)
-
-Auto-generated: updateCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateCartOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-    // UpdateCartRequest (optional)
-    updateCartRequest: ...,
-  } satisfies UpdateCartOperationRequest;
-
-  try {
-    const data = await api.updateCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-| **updateCartRequest** | [UpdateCartRequest](UpdateCartRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CartResource**](CartResource.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)
-
-
-## updateItemCart
-
-> CartResource updateItemCart(cart, lineItem, updateLineItemRequest)
-
-Auto-generated: updateItemCart
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CartsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateItemCartRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CartsApi();
-
-  const body = {
-    // number | The id of the cart
-    cart: 56,
-    // number | The id of the lineItem
-    lineItem: 56,
-    // UpdateLineItemRequest (optional)
-    updateLineItemRequest: ...,
-  } satisfies UpdateItemCartRequest;
-
-  try {
-    const data = await api.updateItemCart(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-| **lineItem** | `number` | The id of the lineItem | [Defaults to `undefined`] |
-| **updateLineItemRequest** | [UpdateLineItemRequest](UpdateLineItemRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CartResource**](CartResource.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)
-