@digital8/lighting-illusions-ts-sdk 0.0.1454 → 0.0.1456

package/docs/ProductRegistrationApi.md

@@ -1,275 +0,0 @@
-# ProductRegistrationApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**getAllProductRegistration**](ProductRegistrationApi.md#getallproductregistrationoperation) | **POST** /admin-api/product-registration/all | Auto-generated: getAllProductRegistration |
-| [**indexProductRegistration**](ProductRegistrationApi.md#indexproductregistrationoperation) | **POST** /admin-api/product-registration/list | Auto-generated: indexProductRegistration |
-| [**listAssetsProductRegistration**](ProductRegistrationApi.md#listassetsproductregistrationoperation) | **POST** /admin-api/product-registration/{productRegistration}/assets | Auto-generated: listAssetsProductRegistration |
-| [**showProductRegistration**](ProductRegistrationApi.md#showproductregistration) | **GET** /admin-api/product-registration/{productRegistration} | Auto-generated: showProductRegistration |
-
-
-
-## getAllProductRegistration
-
-> ProductRegistrationLiteResourceArrayResponse getAllProductRegistration(getAllProductRegistrationRequest)
-
-Auto-generated: getAllProductRegistration
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductRegistrationApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductRegistrationApi();
-
-  const body = {
-    // GetAllProductRegistrationRequest (optional)
-    getAllProductRegistrationRequest: ...,
-  } satisfies GetAllProductRegistrationOperationRequest;
-
-  try {
-    const data = await api.getAllProductRegistration(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllProductRegistrationRequest** | [GetAllProductRegistrationRequest](GetAllProductRegistrationRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductRegistrationLiteResourceArrayResponse**](ProductRegistrationLiteResourceArrayResponse.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)
-
-
-## indexProductRegistration
-
-> PaginatedProductRegistrationListResourceResponse indexProductRegistration(indexProductRegistrationRequest)
-
-Auto-generated: indexProductRegistration
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductRegistrationApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductRegistrationApi();
-
-  const body = {
-    // IndexProductRegistrationRequest (optional)
-    indexProductRegistrationRequest: ...,
-  } satisfies IndexProductRegistrationOperationRequest;
-
-  try {
-    const data = await api.indexProductRegistration(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexProductRegistrationRequest** | [IndexProductRegistrationRequest](IndexProductRegistrationRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedProductRegistrationListResourceResponse**](PaginatedProductRegistrationListResourceResponse.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<\\ProductRegistrationListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## listAssetsProductRegistration
-
-> PaginatedProductRegistrationAssetResourceResponse listAssetsProductRegistration(productRegistration, listAssetsProductRegistrationRequest)
-
-Auto-generated: listAssetsProductRegistration
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductRegistrationApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ListAssetsProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductRegistrationApi();
-
-  const body = {
-    // number | The id of the productRegistration
-    productRegistration: 56,
-    // ListAssetsProductRegistrationRequest (optional)
-    listAssetsProductRegistrationRequest: ...,
-  } satisfies ListAssetsProductRegistrationOperationRequest;
-
-  try {
-    const data = await api.listAssetsProductRegistration(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
-| **listAssetsProductRegistrationRequest** | [ListAssetsProductRegistrationRequest](ListAssetsProductRegistrationRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedProductRegistrationAssetResourceResponse**](PaginatedProductRegistrationAssetResourceResponse.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<\\ProductRegistrationAssetResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## showProductRegistration
-
-> ProductRegistrationResource showProductRegistration(productRegistration)
-
-Auto-generated: showProductRegistration
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductRegistrationApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductRegistrationApi();
-
-  const body = {
-    // number | The id of the productRegistration
-    productRegistration: 56,
-  } satisfies ShowProductRegistrationRequest;
-
-  try {
-    const data = await api.showProductRegistration(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
-
-### Return type
-
-[**ProductRegistrationResource**](ProductRegistrationResource.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)
-

package/docs/ProductRegistrationCustomerLiteResourceArrayResponse.md

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

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

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

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

@@ -1,48 +0,0 @@
-
-# ProductRegistrationResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`purchasedDate` | string
-`customer` | [ProductRegistrationCustomerResource](ProductRegistrationCustomerResource.md)
-`address` | [AddressResource](AddressResource.md)
-`productChildren` | object
-`assets` | object
-`createdAt` | string
-`updatedAt` | string
-
-## Example
-
-```typescript
-import type { ProductRegistrationResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "purchasedDate": null,
-  "customer": null,
-  "address": null,
-  "productChildren": null,
-  "assets": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies ProductRegistrationResource
-
-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 ProductRegistrationResource
-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/src/apis/ProductRegistrationApi.ts

@@ -1,238 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * My API
- * API documentation for my Laravel app
- *
- * The version of the OpenAPI document: 1.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-import * as runtime from '../runtime';
-import type {
-  GetAllProductRegistrationRequest,
-  IndexProductRegistrationRequest,
-  ListAssetsProductRegistrationRequest,
-  PaginatedProductRegistrationAssetResourceResponse,
-  PaginatedProductRegistrationListResourceResponse,
-  ProductRegistrationLiteResourceArrayResponse,
-  ProductRegistrationResource,
-} from '../models/index';
-import {
-    GetAllProductRegistrationRequestFromJSON,
-    GetAllProductRegistrationRequestToJSON,
-    IndexProductRegistrationRequestFromJSON,
-    IndexProductRegistrationRequestToJSON,
-    ListAssetsProductRegistrationRequestFromJSON,
-    ListAssetsProductRegistrationRequestToJSON,
-    PaginatedProductRegistrationAssetResourceResponseFromJSON,
-    PaginatedProductRegistrationAssetResourceResponseToJSON,
-    PaginatedProductRegistrationListResourceResponseFromJSON,
-    PaginatedProductRegistrationListResourceResponseToJSON,
-    ProductRegistrationLiteResourceArrayResponseFromJSON,
-    ProductRegistrationLiteResourceArrayResponseToJSON,
-    ProductRegistrationResourceFromJSON,
-    ProductRegistrationResourceToJSON,
-} from '../models/index';
-
-export interface GetAllProductRegistrationOperationRequest {
-    getAllProductRegistrationRequest?: GetAllProductRegistrationRequest;
-}
-
-export interface IndexProductRegistrationOperationRequest {
-    indexProductRegistrationRequest?: IndexProductRegistrationRequest;
-}
-
-export interface ListAssetsProductRegistrationOperationRequest {
-    productRegistration: number;
-    listAssetsProductRegistrationRequest?: ListAssetsProductRegistrationRequest;
-}
-
-export interface ShowProductRegistrationRequest {
-    productRegistration: number;
-}
-
-/**
- * 
- */
-export class ProductRegistrationApi extends runtime.BaseAPI {
-
-    /**
-     * Creates request options for getAllProductRegistration without sending the request
-     */
-    async getAllProductRegistrationRequestOpts(requestParameters: GetAllProductRegistrationOperationRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/product-registration/all`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: GetAllProductRegistrationRequestToJSON(requestParameters['getAllProductRegistrationRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: getAllProductRegistration
-     */
-    async getAllProductRegistrationRaw(requestParameters: GetAllProductRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductRegistrationLiteResourceArrayResponse>> {
-        const requestOptions = await this.getAllProductRegistrationRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => ProductRegistrationLiteResourceArrayResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: getAllProductRegistration
-     */
-    async getAllProductRegistration(requestParameters: GetAllProductRegistrationOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductRegistrationLiteResourceArrayResponse> {
-        const response = await this.getAllProductRegistrationRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for indexProductRegistration without sending the request
-     */
-    async indexProductRegistrationRequestOpts(requestParameters: IndexProductRegistrationOperationRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/product-registration/list`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: IndexProductRegistrationRequestToJSON(requestParameters['indexProductRegistrationRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: indexProductRegistration
-     */
-    async indexProductRegistrationRaw(requestParameters: IndexProductRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductRegistrationListResourceResponse>> {
-        const requestOptions = await this.indexProductRegistrationRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductRegistrationListResourceResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: indexProductRegistration
-     */
-    async indexProductRegistration(requestParameters: IndexProductRegistrationOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductRegistrationListResourceResponse> {
-        const response = await this.indexProductRegistrationRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for listAssetsProductRegistration without sending the request
-     */
-    async listAssetsProductRegistrationRequestOpts(requestParameters: ListAssetsProductRegistrationOperationRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['productRegistration'] == null) {
-            throw new runtime.RequiredError(
-                'productRegistration',
-                'Required parameter "productRegistration" was null or undefined when calling listAssetsProductRegistration().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/product-registration/{productRegistration}/assets`;
-        urlPath = urlPath.replace(`{${"productRegistration"}}`, encodeURIComponent(String(requestParameters['productRegistration'])));
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: ListAssetsProductRegistrationRequestToJSON(requestParameters['listAssetsProductRegistrationRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: listAssetsProductRegistration
-     */
-    async listAssetsProductRegistrationRaw(requestParameters: ListAssetsProductRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductRegistrationAssetResourceResponse>> {
-        const requestOptions = await this.listAssetsProductRegistrationRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductRegistrationAssetResourceResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: listAssetsProductRegistration
-     */
-    async listAssetsProductRegistration(requestParameters: ListAssetsProductRegistrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductRegistrationAssetResourceResponse> {
-        const response = await this.listAssetsProductRegistrationRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for showProductRegistration without sending the request
-     */
-    async showProductRegistrationRequestOpts(requestParameters: ShowProductRegistrationRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['productRegistration'] == null) {
-            throw new runtime.RequiredError(
-                'productRegistration',
-                'Required parameter "productRegistration" was null or undefined when calling showProductRegistration().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-
-        let urlPath = `/admin-api/product-registration/{productRegistration}`;
-        urlPath = urlPath.replace(`{${"productRegistration"}}`, encodeURIComponent(String(requestParameters['productRegistration'])));
-
-        return {
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-
-    /**
-     * Auto-generated: showProductRegistration
-     */
-    async showProductRegistrationRaw(requestParameters: ShowProductRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductRegistrationResource>> {
-        const requestOptions = await this.showProductRegistrationRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => ProductRegistrationResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: showProductRegistration
-     */
-    async showProductRegistration(requestParameters: ShowProductRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductRegistrationResource> {
-        const response = await this.showProductRegistrationRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}