@digital8/lighting-illusions-ts-sdk 0.0.2362 → 0.0.2364

package/docs/SearchCouponsRequest.md

@@ -0,0 +1,62 @@
+
+# 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/SearchOrdersRequest.md

@@ -25,6 +25,7 @@ Name | Type
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
+`couponId` | number
 
 ## Example
 
@@ -52,6 +53,7 @@ const example = {
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
+  "couponId": null,
 } satisfies SearchOrdersRequest
 
 console.log(example)

package/docs/StoreSpecialDateFrontendResource.md

@@ -9,7 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `hours` | string
-`date` | object
+`date` | string
 `closed` | boolean
 `displayStartDate` | object
 `displayEndDate` | object

package/docs/UpdateCouponRequest.md

@@ -0,0 +1,60 @@
+
+# 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital8/lighting-illusions-ts-sdk",
-  "version": "0.0.2362",
+  "version": "0.0.2364",
   "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/CouponsApi.ts

@@ -0,0 +1,345 @@
+/* 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();
+    }
+
+}

package/src/apis/index.ts

@@ -7,6 +7,7 @@ export * from './AttributeApi';
 export * from './AuthApi';
 export * from './BlogCategoryApi';
 export * from './CartsApi';
+export * from './CouponsApi';
 export * from './CustomersApi';
 export * from './DefinitionApi';
 export * from './DocumentApi';

package/src/models/AddressResource.ts

@@ -48,7 +48,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    company: string;
+    company?: string | null;
     /**
      * 
      * @type {string}
@@ -98,7 +98,6 @@ export interface AddressResource {
  */
 export function instanceOfAddressResource(value: object): value is AddressResource {
     if (!('addresseeName' in value) || value['addresseeName'] === undefined) return false;
-    if (!('company' in value) || value['company'] === undefined) return false;
     if (!('line1' in value) || value['line1'] === undefined) return false;
     if (!('line2' in value) || value['line2'] === undefined) return false;
     if (!('postcode' in value) || value['postcode'] === undefined) return false;
@@ -123,7 +122,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         'type': json['type'] == null ? undefined : json['type'],
         'sourceAddressId': json['sourceAddressId'] == null ? undefined : json['sourceAddressId'],
         'addresseeName': json['addresseeName'],
-        'company': json['company'],
+        'company': json['company'] == null ? undefined : json['company'],
         'line1': json['line1'],
         'line2': json['line2'],
         'postcode': json['postcode'],

package/src/models/AdminOrderResource.ts

@@ -55,13 +55,6 @@ import {
     OrderStatusLiteResourceToJSON,
     OrderStatusLiteResourceToJSONTyped,
 } from './OrderStatusLiteResource';
-import type { CartCouponResource } from './CartCouponResource';
-import {
-    CartCouponResourceFromJSON,
-    CartCouponResourceFromJSONTyped,
-    CartCouponResourceToJSON,
-    CartCouponResourceToJSONTyped,
-} from './CartCouponResource';
 import type { CustomerResource } from './CustomerResource';
 import {
     CustomerResourceFromJSON,
@@ -327,10 +320,10 @@ export interface AdminOrderResource {
     lineItems: Array<AdminOrderLineItemResource> | null;
     /**
      * 
-     * @type {Array<CartCouponResource>}
+     * @type {object}
      * @memberof AdminOrderResource
      */
-    coupons: Array<CartCouponResource> | null;
+    coupons: object;
     /**
      * 
      * @type {Array<DiscountResource>}
@@ -457,7 +450,7 @@ export function AdminOrderResourceFromJSONTyped(json: any, ignoreDiscriminator:
         'admin': AdminUserLiteResourceFromJSON(json['admin']),
         'status': OrderStatusLiteResourceFromJSON(json['status']),
         'lineItems': (json['lineItems'] == null ? null : (json['lineItems'] as Array<any>).map(AdminOrderLineItemResourceFromJSON)),
-        'coupons': (json['coupons'] == null ? null : (json['coupons'] as Array<any>).map(CartCouponResourceFromJSON)),
+        'coupons': json['coupons'],
         'discounts': (json['discounts'] == null ? null : (json['discounts'] as Array<any>).map(DiscountResourceFromJSON)),
         'transactions': (json['transactions'] == null ? null : (json['transactions'] as Array<any>).map(TransactionLiteResourceFromJSON)),
         'shippingAddress': AddressResourceFromJSON(json['shippingAddress']),
@@ -515,7 +508,7 @@ export function AdminOrderResourceToJSONTyped(value?: AdminOrderResource | null,
         'admin': AdminUserLiteResourceToJSON(value['admin']),
         'status': OrderStatusLiteResourceToJSON(value['status']),
         'lineItems': (value['lineItems'] == null ? null : (value['lineItems'] as Array<any>).map(AdminOrderLineItemResourceToJSON)),
-        'coupons': (value['coupons'] == null ? null : (value['coupons'] as Array<any>).map(CartCouponResourceToJSON)),
+        'coupons': value['coupons'],
         'discounts': (value['discounts'] == null ? null : (value['discounts'] as Array<any>).map(DiscountResourceToJSON)),
         'transactions': (value['transactions'] == null ? null : (value['transactions'] as Array<any>).map(TransactionLiteResourceToJSON)),
         'shippingAddress': AddressResourceToJSON(value['shippingAddress']),

package/src/models/{CartCouponResource.ts → AppliedCouponResource.ts}

@@ -16,39 +16,39 @@ import { mapValues } from '../runtime';
 /**
  * 
  * @export
- * @interface CartCouponResource
+ * @interface AppliedCouponResource
  */
-export interface CartCouponResource {
+export interface AppliedCouponResource {
     /**
      * 
      * @type {number}
-     * @memberof CartCouponResource
+     * @memberof AppliedCouponResource
      */
     id: number;
     /**
      * 
      * @type {string}
-     * @memberof CartCouponResource
+     * @memberof AppliedCouponResource
      */
     code: string;
     /**
      * 
      * @type {string}
-     * @memberof CartCouponResource
+     * @memberof AppliedCouponResource
      */
     name: string;
     /**
      * 
      * @type {number}
-     * @memberof CartCouponResource
+     * @memberof AppliedCouponResource
      */
     discountTotal: number;
 }
 
 /**
- * Check if a given object implements the CartCouponResource interface.
+ * Check if a given object implements the AppliedCouponResource interface.
  */
-export function instanceOfCartCouponResource(value: object): value is CartCouponResource {
+export function instanceOfAppliedCouponResource(value: object): value is AppliedCouponResource {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('code' in value) || value['code'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
@@ -56,11 +56,11 @@ export function instanceOfCartCouponResource(value: object): value is CartCoupon
     return true;
 }
 
-export function CartCouponResourceFromJSON(json: any): CartCouponResource {
-    return CartCouponResourceFromJSONTyped(json, false);
+export function AppliedCouponResourceFromJSON(json: any): AppliedCouponResource {
+    return AppliedCouponResourceFromJSONTyped(json, false);
 }
 
-export function CartCouponResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): CartCouponResource {
+export function AppliedCouponResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppliedCouponResource {
     if (json == null) {
         return json;
     }
@@ -73,11 +73,11 @@ export function CartCouponResourceFromJSONTyped(json: any, ignoreDiscriminator:
     };
 }
 
-export function CartCouponResourceToJSON(json: any): CartCouponResource {
-    return CartCouponResourceToJSONTyped(json, false);
+export function AppliedCouponResourceToJSON(json: any): AppliedCouponResource {
+    return AppliedCouponResourceToJSONTyped(json, false);
 }
 
-export function CartCouponResourceToJSONTyped(value?: CartCouponResource | null, ignoreDiscriminator: boolean = false): any {
+export function AppliedCouponResourceToJSONTyped(value?: AppliedCouponResource | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }