@digital8/lighting-illusions-ts-sdk 0.0.2373 → 0.0.2374

package/docs/ReturnResource.md

@@ -0,0 +1,66 @@
+
+# ReturnResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`quantity` | number
+`status` | string
+`reason` | string
+`returnMethod` | string
+`createdAt` | Date
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`customer` | [CustomerListResource](CustomerListResource.md)
+`order` | [OrderLiteResource](OrderLiteResource.md)
+`lineItem` | [LineItemListResource](LineItemListResource.md)
+`reviewer` | [AdminUserLiteResource](AdminUserLiteResource.md)
+`description` | string
+`assets` | object
+`netsuiteSync` | [NetsuiteSyncLiteResource](NetsuiteSyncLiteResource.md)
+`omnisendSync` | [OmnisendSyncLiteResource](OmnisendSyncLiteResource.md)
+`externalApiLogs` | object
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { ReturnResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "quantity": null,
+  "status": null,
+  "reason": null,
+  "returnMethod": null,
+  "createdAt": null,
+  "site": null,
+  "customer": null,
+  "order": null,
+  "lineItem": null,
+  "reviewer": null,
+  "description": null,
+  "assets": null,
+  "netsuiteSync": null,
+  "omnisendSync": null,
+  "externalApiLogs": null,
+  "updatedAt": null,
+} satisfies ReturnResource
+
+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 ReturnResource
+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/ReturnResourceArrayResponse.md

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

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

@@ -0,0 +1,545 @@
+# ReturnsApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**attachAssetsReturn**](ReturnsApi.md#attachassetsreturn) | **POST** /admin-api/returns/{productReturn}/assets/attach | Auto-generated: attachAssetsReturn |
+| [**destroyReturn**](ReturnsApi.md#destroyreturn) | **DELETE** /admin-api/returns/{productReturn}/delete | Auto-generated: destroyReturn |
+| [**detachAssetsReturn**](ReturnsApi.md#detachassetsreturn) | **POST** /admin-api/returns/{productReturn}/assets/detach | Auto-generated: detachAssetsReturn |
+| [**getAllReturn**](ReturnsApi.md#getallreturn) | **POST** /admin-api/returns/all | Auto-generated: getAllReturn |
+| [**indexReturn**](ReturnsApi.md#indexreturn) | **POST** /admin-api/returns/list | Auto-generated: indexReturn |
+| [**showReturn**](ReturnsApi.md#showreturn) | **GET** /admin-api/returns/{productReturn} | Auto-generated: showReturn |
+| [**storeReturn**](ReturnsApi.md#storereturn) | **POST** /admin-api/returns/create | Auto-generated: storeReturn |
+| [**updateReturn**](ReturnsApi.md#updatereturnoperation) | **PUT** /admin-api/returns/{productReturn}/update | Auto-generated: updateReturn |
+
+
+
+## attachAssetsReturn
+
+> ReturnResource attachAssetsReturn(productReturn, attachReturnAssetsRequest)
+
+Auto-generated: attachAssetsReturn
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReturnsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { AttachAssetsReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReturnsApi();
+
+  const body = {
+    // number | The id of the productReturn
+    productReturn: 56,
+    // AttachReturnAssetsRequest (optional)
+    attachReturnAssetsRequest: ...,
+  } satisfies AttachAssetsReturnRequest;
+
+  try {
+    const data = await api.attachAssetsReturn(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productReturn** | `number` | The id of the productReturn | [Defaults to `undefined`] |
+| **attachReturnAssetsRequest** | [AttachReturnAssetsRequest](AttachReturnAssetsRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ReturnResource**](ReturnResource.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)
+
+
+## destroyReturn
+
+> GenericResponse destroyReturn(productReturn)
+
+Auto-generated: destroyReturn
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReturnsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReturnsApi();
+
+  const body = {
+    // number | The id of the productReturn
+    productReturn: 56,
+  } satisfies DestroyReturnRequest;
+
+  try {
+    const data = await api.destroyReturn(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productReturn** | `number` | The id of the productReturn | [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)
+
+
+## detachAssetsReturn
+
+> ReturnResource detachAssetsReturn(productReturn, detachReturnAssetsRequest)
+
+Auto-generated: detachAssetsReturn
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReturnsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DetachAssetsReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReturnsApi();
+
+  const body = {
+    // number | The id of the productReturn
+    productReturn: 56,
+    // DetachReturnAssetsRequest (optional)
+    detachReturnAssetsRequest: ...,
+  } satisfies DetachAssetsReturnRequest;
+
+  try {
+    const data = await api.detachAssetsReturn(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productReturn** | `number` | The id of the productReturn | [Defaults to `undefined`] |
+| **detachReturnAssetsRequest** | [DetachReturnAssetsRequest](DetachReturnAssetsRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ReturnResource**](ReturnResource.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)
+
+
+## getAllReturn
+
+> ReturnLiteResourceArrayResponse getAllReturn(searchReturnsRequest)
+
+Auto-generated: getAllReturn
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReturnsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReturnsApi();
+
+  const body = {
+    // SearchReturnsRequest (optional)
+    searchReturnsRequest: ...,
+  } satisfies GetAllReturnRequest;
+
+  try {
+    const data = await api.getAllReturn(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchReturnsRequest** | [SearchReturnsRequest](SearchReturnsRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ReturnLiteResourceArrayResponse**](ReturnLiteResourceArrayResponse.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)
+
+
+## indexReturn
+
+> PaginatedReturnListResourceResponse indexReturn(searchReturnsRequest)
+
+Auto-generated: indexReturn
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReturnsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReturnsApi();
+
+  const body = {
+    // SearchReturnsRequest (optional)
+    searchReturnsRequest: ...,
+  } satisfies IndexReturnRequest;
+
+  try {
+    const data = await api.indexReturn(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchReturnsRequest** | [SearchReturnsRequest](SearchReturnsRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedReturnListResourceResponse**](PaginatedReturnListResourceResponse.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<\\ReturnListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showReturn
+
+> ReturnResource showReturn(productReturn)
+
+Auto-generated: showReturn
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReturnsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReturnsApi();
+
+  const body = {
+    // number | The id of the productReturn
+    productReturn: 56,
+  } satisfies ShowReturnRequest;
+
+  try {
+    const data = await api.showReturn(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productReturn** | `number` | The id of the productReturn | [Defaults to `undefined`] |
+
+### Return type
+
+[**ReturnResource**](ReturnResource.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)
+
+
+## storeReturn
+
+> ReturnResource storeReturn(createReturnRequest)
+
+Auto-generated: storeReturn
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReturnsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreReturnRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReturnsApi();
+
+  const body = {
+    // CreateReturnRequest (optional)
+    createReturnRequest: ...,
+  } satisfies StoreReturnRequest;
+
+  try {
+    const data = await api.storeReturn(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createReturnRequest** | [CreateReturnRequest](CreateReturnRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ReturnResource**](ReturnResource.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)
+
+
+## updateReturn
+
+> ReturnResource updateReturn(productReturn, updateReturnRequest)
+
+Auto-generated: updateReturn
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReturnsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateReturnOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReturnsApi();
+
+  const body = {
+    // number | The id of the productReturn
+    productReturn: 56,
+    // UpdateReturnRequest (optional)
+    updateReturnRequest: ...,
+  } satisfies UpdateReturnOperationRequest;
+
+  try {
+    const data = await api.updateReturn(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productReturn** | `number` | The id of the productReturn | [Defaults to `undefined`] |
+| **updateReturnRequest** | [UpdateReturnRequest](UpdateReturnRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ReturnResource**](ReturnResource.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)
+