@digital8/lighting-illusions-ts-sdk 0.0.1693 → 0.0.1694

package/dist/models/UpdateReviewRequest.d.ts

@@ -1,62 +0,0 @@
-/**
- * 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.
- */
-/**
- *
- * @export
- * @interface UpdateReviewRequest
- */
-export interface UpdateReviewRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateReviewRequest
-     */
-    reviewerName: string;
-    /**
-     *
-     * @type {number}
-     * @memberof UpdateReviewRequest
-     */
-    rating: number;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateReviewRequest
-     */
-    comment?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateReviewRequest
-     */
-    replyFromAdmin?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateReviewRequest
-     */
-    location?: string | null;
-    /**
-     *
-     * @type {boolean}
-     * @memberof UpdateReviewRequest
-     */
-    approved?: boolean;
-}
-/**
- * Check if a given object implements the UpdateReviewRequest interface.
- */
-export declare function instanceOfUpdateReviewRequest(value: object): value is UpdateReviewRequest;
-export declare function UpdateReviewRequestFromJSON(json: any): UpdateReviewRequest;
-export declare function UpdateReviewRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateReviewRequest;
-export declare function UpdateReviewRequestToJSON(json: any): UpdateReviewRequest;
-export declare function UpdateReviewRequestToJSONTyped(value?: UpdateReviewRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateReviewRequest.js

@@ -1,63 +0,0 @@
-"use strict";
-/* 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOfUpdateReviewRequest = instanceOfUpdateReviewRequest;
-exports.UpdateReviewRequestFromJSON = UpdateReviewRequestFromJSON;
-exports.UpdateReviewRequestFromJSONTyped = UpdateReviewRequestFromJSONTyped;
-exports.UpdateReviewRequestToJSON = UpdateReviewRequestToJSON;
-exports.UpdateReviewRequestToJSONTyped = UpdateReviewRequestToJSONTyped;
-/**
- * Check if a given object implements the UpdateReviewRequest interface.
- */
-function instanceOfUpdateReviewRequest(value) {
-    if (!('reviewerName' in value) || value['reviewerName'] === undefined)
-        return false;
-    if (!('rating' in value) || value['rating'] === undefined)
-        return false;
-    return true;
-}
-function UpdateReviewRequestFromJSON(json) {
-    return UpdateReviewRequestFromJSONTyped(json, false);
-}
-function UpdateReviewRequestFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'reviewerName': json['reviewer_name'],
-        'rating': json['rating'],
-        'comment': json['comment'] == null ? undefined : json['comment'],
-        'replyFromAdmin': json['reply_from_admin'] == null ? undefined : json['reply_from_admin'],
-        'location': json['location'] == null ? undefined : json['location'],
-        'approved': json['approved'] == null ? undefined : json['approved'],
-    };
-}
-function UpdateReviewRequestToJSON(json) {
-    return UpdateReviewRequestToJSONTyped(json, false);
-}
-function UpdateReviewRequestToJSONTyped(value, ignoreDiscriminator) {
-    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
-    if (value == null) {
-        return value;
-    }
-    return {
-        'reviewer_name': value['reviewerName'],
-        'rating': value['rating'],
-        'comment': value['comment'],
-        'reply_from_admin': value['replyFromAdmin'],
-        'location': value['location'],
-        'approved': value['approved'],
-    };
-}

package/docs/ReviewApi.md

@@ -1,539 +0,0 @@
-# ReviewApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyReview**](ReviewApi.md#destroyreview) | **DELETE** /admin-api/review/{review}/delete | Auto-generated: destroyReview |
-| [**exportReview**](ReviewApi.md#exportreview) | **POST** /admin-api/review/export | Auto-generated: exportReview |
-| [**getAllReview**](ReviewApi.md#getallreview) | **POST** /admin-api/review/all | Auto-generated: getAllReview |
-| [**importReview**](ReviewApi.md#importreview) | **POST** /admin-api/review/import | Auto-generated: importReview |
-| [**indexReview**](ReviewApi.md#indexreviewoperation) | **POST** /admin-api/review/list | Auto-generated: indexReview |
-| [**showReview**](ReviewApi.md#showreview) | **GET** /admin-api/review/{review} | Auto-generated: showReview |
-| [**storeReview**](ReviewApi.md#storereviewoperation) | **POST** /admin-api/review/create | Auto-generated: storeReview |
-| [**updateReview**](ReviewApi.md#updatereviewoperation) | **PUT** /admin-api/review/{review}/update | Auto-generated: updateReview |
-
-
-
-## destroyReview
-
-> GenericResponse destroyReview(review)
-
-Auto-generated: destroyReview
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-
-  const body = {
-    // number | The id of the review
-    review: 56,
-  } satisfies DestroyReviewRequest;
-
-  try {
-    const data = await api.destroyReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **review** | `number` | The id of the review | [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)
-
-
-## exportReview
-
-> Blob exportReview(indexReviewRequest)
-
-Auto-generated: exportReview
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ExportReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-
-  const body = {
-    // IndexReviewRequest (optional)
-    indexReviewRequest: ...,
-  } satisfies ExportReviewRequest;
-
-  try {
-    const data = await api.exportReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
-
-### Return type
-
-**Blob**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: `application/json`
-- **Accept**: ``
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | File download () |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## getAllReview
-
-> ReviewLiteResourceArrayResponse getAllReview(indexReviewRequest)
-
-Auto-generated: getAllReview
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-
-  const body = {
-    // IndexReviewRequest (optional)
-    indexReviewRequest: ...,
-  } satisfies GetAllReviewRequest;
-
-  try {
-    const data = await api.getAllReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ReviewLiteResourceArrayResponse**](ReviewLiteResourceArrayResponse.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)
-
-
-## importReview
-
-> GenericResponse importReview(file)
-
-Auto-generated: importReview
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ImportReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-
-  const body = {
-    // Blob
-    file: BINARY_DATA_HERE,
-  } satisfies ImportReviewRequest;
-
-  try {
-    const data = await api.importReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **file** | `Blob` |  | [Defaults to `undefined`] |
-
-### Return type
-
-[**GenericResponse**](GenericResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: `application/x-www-form-urlencoded`
-- **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)
-
-
-## indexReview
-
-> PaginatedReviewListResourceResponse indexReview(indexReviewRequest)
-
-Auto-generated: indexReview
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-
-  const body = {
-    // IndexReviewRequest (optional)
-    indexReviewRequest: ...,
-  } satisfies IndexReviewOperationRequest;
-
-  try {
-    const data = await api.indexReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedReviewListResourceResponse**](PaginatedReviewListResourceResponse.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<\\ReviewListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## showReview
-
-> ReviewResource showReview(review)
-
-Auto-generated: showReview
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-
-  const body = {
-    // number | The id of the review
-    review: 56,
-  } satisfies ShowReviewRequest;
-
-  try {
-    const data = await api.showReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **review** | `number` | The id of the review | [Defaults to `undefined`] |
-
-### Return type
-
-[**ReviewResource**](ReviewResource.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)
-
-
-## storeReview
-
-> ReviewResource storeReview(storeReviewRequest)
-
-Auto-generated: storeReview
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-
-  const body = {
-    // StoreReviewRequest (optional)
-    storeReviewRequest: ...,
-  } satisfies StoreReviewOperationRequest;
-
-  try {
-    const data = await api.storeReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeReviewRequest** | [StoreReviewRequest](StoreReviewRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ReviewResource**](ReviewResource.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)
-
-
-## updateReview
-
-> ReviewResource updateReview(review, updateReviewRequest)
-
-Auto-generated: updateReview
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ReviewApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ReviewApi();
-
-  const body = {
-    // number | The id of the review
-    review: 56,
-    // UpdateReviewRequest (optional)
-    updateReviewRequest: ...,
-  } satisfies UpdateReviewOperationRequest;
-
-  try {
-    const data = await api.updateReview(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **review** | `number` | The id of the review | [Defaults to `undefined`] |
-| **updateReviewRequest** | [UpdateReviewRequest](UpdateReviewRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ReviewResource**](ReviewResource.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)
-