@digital8/lighting-illusions-ts-sdk 0.0.2378 → 0.0.2379

package/docs/CreateCouponRequest.md

@@ -1,62 +0,0 @@
-
-# CreateCouponRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`siteId` | number
-`name` | string
-`code` | string
-`type` | string
-`discountType` | string
-`discountAmount` | number
-`minAmount` | number
-`minProducts` | number
-`totalUseLimit` | number
-`customerUseLimit` | number
-`startDate` | string
-`endDate` | string
-`isForAllProducts` | boolean
-`isForAllCustomers` | boolean
-`couponables` | [Array<CreateCouponRequestCouponablesInner>](CreateCouponRequestCouponablesInner.md)
-
-## Example
-
-```typescript
-import type { CreateCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "siteId": null,
-  "name": null,
-  "code": null,
-  "type": null,
-  "discountType": null,
-  "discountAmount": null,
-  "minAmount": null,
-  "minProducts": null,
-  "totalUseLimit": null,
-  "customerUseLimit": null,
-  "startDate": null,
-  "endDate": null,
-  "isForAllProducts": null,
-  "isForAllCustomers": null,
-  "couponables": null,
-} satisfies CreateCouponRequest
-
-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 CreateCouponRequest
-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/CreateCouponRequestCouponablesInner.md

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

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

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

@@ -1,50 +0,0 @@
-
-# SearchAllCouponsRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`type` | Array<string>
-`siteId` | Array<string>
-`isAbandonedCart` | Array<string>
-
-## Example
-
-```typescript
-import type { SearchAllCouponsRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "type": null,
-  "siteId": null,
-  "isAbandonedCart": null,
-} satisfies SearchAllCouponsRequest
-
-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 SearchAllCouponsRequest
-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/SearchCouponsRequest.md

@@ -1,62 +0,0 @@
-
-# SearchCouponsRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`type` | Array<string>
-`siteId` | Array<string>
-`isAbandonedCart` | Array<string>
-`beforeStartDate` | Date
-`afterStartDate` | Date
-`beforeEndDate` | Date
-`afterEndDate` | Date
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { SearchCouponsRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "type": null,
-  "siteId": null,
-  "isAbandonedCart": null,
-  "beforeStartDate": null,
-  "afterStartDate": null,
-  "beforeEndDate": null,
-  "afterEndDate": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies SearchCouponsRequest
-
-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 SearchCouponsRequest
-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/UpdateCouponRequest.md

@@ -1,60 +0,0 @@
-
-# UpdateCouponRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`name` | string
-`code` | string
-`type` | string
-`discountType` | string
-`discountAmount` | number
-`minAmount` | number
-`minProducts` | number
-`totalUseLimit` | number
-`customerUseLimit` | number
-`startDate` | string
-`endDate` | string
-`isForAllProducts` | boolean
-`isForAllCustomers` | boolean
-`couponables` | [Array<CreateCouponRequestCouponablesInner>](CreateCouponRequestCouponablesInner.md)
-
-## Example
-
-```typescript
-import type { UpdateCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "name": null,
-  "code": null,
-  "type": null,
-  "discountType": null,
-  "discountAmount": null,
-  "minAmount": null,
-  "minProducts": null,
-  "totalUseLimit": null,
-  "customerUseLimit": null,
-  "startDate": null,
-  "endDate": null,
-  "isForAllProducts": null,
-  "isForAllCustomers": null,
-  "couponables": null,
-} satisfies UpdateCouponRequest
-
-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 UpdateCouponRequest
-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/CouponsApi.ts

@@ -1,345 +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 CouponLiteResourceArrayResponse,
-    CouponLiteResourceArrayResponseFromJSON,
-    CouponLiteResourceArrayResponseToJSON,
-} from '../models/CouponLiteResourceArrayResponse';
-import {
-    type CouponResource,
-    CouponResourceFromJSON,
-    CouponResourceToJSON,
-} from '../models/CouponResource';
-import {
-    type CreateCouponRequest,
-    CreateCouponRequestFromJSON,
-    CreateCouponRequestToJSON,
-} from '../models/CreateCouponRequest';
-import {
-    type GenericResponse,
-    GenericResponseFromJSON,
-    GenericResponseToJSON,
-} from '../models/GenericResponse';
-import {
-    type PaginatedCouponListResourceResponse,
-    PaginatedCouponListResourceResponseFromJSON,
-    PaginatedCouponListResourceResponseToJSON,
-} from '../models/PaginatedCouponListResourceResponse';
-import {
-    type SearchAllCouponsRequest,
-    SearchAllCouponsRequestFromJSON,
-    SearchAllCouponsRequestToJSON,
-} from '../models/SearchAllCouponsRequest';
-import {
-    type SearchCouponsRequest,
-    SearchCouponsRequestFromJSON,
-    SearchCouponsRequestToJSON,
-} from '../models/SearchCouponsRequest';
-import {
-    type UpdateCouponRequest,
-    UpdateCouponRequestFromJSON,
-    UpdateCouponRequestToJSON,
-} from '../models/UpdateCouponRequest';
-
-export interface DestroyCouponRequest {
-    coupon: number;
-}
-
-export interface GetAllCouponRequest {
-    searchAllCouponsRequest?: SearchAllCouponsRequest;
-}
-
-export interface IndexCouponRequest {
-    searchCouponsRequest?: SearchCouponsRequest;
-}
-
-export interface ShowCouponRequest {
-    coupon: number;
-}
-
-export interface StoreCouponRequest {
-    createCouponRequest?: CreateCouponRequest;
-}
-
-export interface UpdateCouponOperationRequest {
-    coupon: number;
-    updateCouponRequest?: UpdateCouponRequest;
-}
-
-/**
- * 
- */
-export class CouponsApi extends runtime.BaseAPI {
-
-    /**
-     * Creates request options for destroyCoupon without sending the request
-     */
-    async destroyCouponRequestOpts(requestParameters: DestroyCouponRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['coupon'] == null) {
-            throw new runtime.RequiredError(
-                'coupon',
-                'Required parameter "coupon" was null or undefined when calling destroyCoupon().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-
-        let urlPath = `/admin-api/coupons/{coupon}/delete`;
-        urlPath = urlPath.replace('{coupon}', encodeURIComponent(String(requestParameters['coupon'])));
-
-        return {
-            path: urlPath,
-            method: 'DELETE',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-
-    /**
-     * Auto-generated: destroyCoupon
-     */
-    async destroyCouponRaw(requestParameters: DestroyCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
-        const requestOptions = await this.destroyCouponRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: destroyCoupon
-     */
-    async destroyCoupon(requestParameters: DestroyCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
-        const response = await this.destroyCouponRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for getAllCoupon without sending the request
-     */
-    async getAllCouponRequestOpts(requestParameters: GetAllCouponRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/coupons/all`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: SearchAllCouponsRequestToJSON(requestParameters['searchAllCouponsRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: getAllCoupon
-     */
-    async getAllCouponRaw(requestParameters: GetAllCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CouponLiteResourceArrayResponse>> {
-        const requestOptions = await this.getAllCouponRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => CouponLiteResourceArrayResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: getAllCoupon
-     */
-    async getAllCoupon(requestParameters: GetAllCouponRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CouponLiteResourceArrayResponse> {
-        const response = await this.getAllCouponRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for indexCoupon without sending the request
-     */
-    async indexCouponRequestOpts(requestParameters: IndexCouponRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/coupons/list`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: SearchCouponsRequestToJSON(requestParameters['searchCouponsRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: indexCoupon
-     */
-    async indexCouponRaw(requestParameters: IndexCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedCouponListResourceResponse>> {
-        const requestOptions = await this.indexCouponRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedCouponListResourceResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: indexCoupon
-     */
-    async indexCoupon(requestParameters: IndexCouponRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedCouponListResourceResponse> {
-        const response = await this.indexCouponRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for showCoupon without sending the request
-     */
-    async showCouponRequestOpts(requestParameters: ShowCouponRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['coupon'] == null) {
-            throw new runtime.RequiredError(
-                'coupon',
-                'Required parameter "coupon" was null or undefined when calling showCoupon().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-
-        let urlPath = `/admin-api/coupons/{coupon}`;
-        urlPath = urlPath.replace('{coupon}', encodeURIComponent(String(requestParameters['coupon'])));
-
-        return {
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-
-    /**
-     * Auto-generated: showCoupon
-     */
-    async showCouponRaw(requestParameters: ShowCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CouponResource>> {
-        const requestOptions = await this.showCouponRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => CouponResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: showCoupon
-     */
-    async showCoupon(requestParameters: ShowCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CouponResource> {
-        const response = await this.showCouponRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for storeCoupon without sending the request
-     */
-    async storeCouponRequestOpts(requestParameters: StoreCouponRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/coupons/create`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: CreateCouponRequestToJSON(requestParameters['createCouponRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: storeCoupon
-     */
-    async storeCouponRaw(requestParameters: StoreCouponRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CouponResource>> {
-        const requestOptions = await this.storeCouponRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => CouponResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: storeCoupon
-     */
-    async storeCoupon(requestParameters: StoreCouponRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CouponResource> {
-        const response = await this.storeCouponRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for updateCoupon without sending the request
-     */
-    async updateCouponRequestOpts(requestParameters: UpdateCouponOperationRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['coupon'] == null) {
-            throw new runtime.RequiredError(
-                'coupon',
-                'Required parameter "coupon" was null or undefined when calling updateCoupon().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/coupons/{coupon}/update`;
-        urlPath = urlPath.replace('{coupon}', encodeURIComponent(String(requestParameters['coupon'])));
-
-        return {
-            path: urlPath,
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: UpdateCouponRequestToJSON(requestParameters['updateCouponRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: updateCoupon
-     */
-    async updateCouponRaw(requestParameters: UpdateCouponOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CouponResource>> {
-        const requestOptions = await this.updateCouponRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => CouponResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: updateCoupon
-     */
-    async updateCoupon(requestParameters: UpdateCouponOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CouponResource> {
-        const response = await this.updateCouponRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}