@digital8/lighting-illusions-ts-sdk 0.0.2183 → 0.0.2184

package/dist/models/UpdateCouponRequest.d.ts

@@ -0,0 +1,128 @@
+/**
+ * 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 type { CreateCouponRequestCouponablesInner } from './CreateCouponRequestCouponablesInner';
+/**
+ *
+ * @export
+ * @interface UpdateCouponRequest
+ */
+export interface UpdateCouponRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateCouponRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateCouponRequest
+     */
+    code: string;
+    /**
+     *
+     * @type {UpdateCouponRequestTypeEnum}
+     * @memberof UpdateCouponRequest
+     */
+    type: UpdateCouponRequestTypeEnum;
+    /**
+     *
+     * @type {UpdateCouponRequestDiscountTypeEnum}
+     * @memberof UpdateCouponRequest
+     */
+    discountType: UpdateCouponRequestDiscountTypeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdateCouponRequest
+     */
+    discountAmount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdateCouponRequest
+     */
+    minAmount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdateCouponRequest
+     */
+    minProducts: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdateCouponRequest
+     */
+    totalUseLimit: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdateCouponRequest
+     */
+    customerUseLimit: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof UpdateCouponRequest
+     */
+    startDate?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof UpdateCouponRequest
+     */
+    endDate?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateCouponRequest
+     */
+    isForAllProducts?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateCouponRequest
+     */
+    isForAllCustomers?: boolean;
+    /**
+     *
+     * @type {Array<CreateCouponRequestCouponablesInner>}
+     * @memberof UpdateCouponRequest
+     */
+    couponables?: Array<CreateCouponRequestCouponablesInner>;
+}
+/**
+ * @export
+ */
+export declare const UpdateCouponRequestTypeEnum: {
+    readonly Subtotal: "subtotal";
+    readonly Product: "product";
+    readonly Shipping: "shipping";
+};
+export type UpdateCouponRequestTypeEnum = typeof UpdateCouponRequestTypeEnum[keyof typeof UpdateCouponRequestTypeEnum];
+/**
+ * @export
+ */
+export declare const UpdateCouponRequestDiscountTypeEnum: {
+    readonly Dollar: "$";
+    readonly Percent: "%";
+};
+export type UpdateCouponRequestDiscountTypeEnum = typeof UpdateCouponRequestDiscountTypeEnum[keyof typeof UpdateCouponRequestDiscountTypeEnum];
+/**
+ * Check if a given object implements the UpdateCouponRequest interface.
+ */
+export declare function instanceOfUpdateCouponRequest(value: object): value is UpdateCouponRequest;
+export declare function UpdateCouponRequestFromJSON(json: any): UpdateCouponRequest;
+export declare function UpdateCouponRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateCouponRequest;
+export declare function UpdateCouponRequestToJSON(json: any): UpdateCouponRequest;
+export declare function UpdateCouponRequestToJSONTyped(value?: UpdateCouponRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateCouponRequest.js

@@ -0,0 +1,110 @@
+"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.UpdateCouponRequestDiscountTypeEnum = exports.UpdateCouponRequestTypeEnum = void 0;
+exports.instanceOfUpdateCouponRequest = instanceOfUpdateCouponRequest;
+exports.UpdateCouponRequestFromJSON = UpdateCouponRequestFromJSON;
+exports.UpdateCouponRequestFromJSONTyped = UpdateCouponRequestFromJSONTyped;
+exports.UpdateCouponRequestToJSON = UpdateCouponRequestToJSON;
+exports.UpdateCouponRequestToJSONTyped = UpdateCouponRequestToJSONTyped;
+var CreateCouponRequestCouponablesInner_1 = require("./CreateCouponRequestCouponablesInner");
+/**
+ * @export
+ */
+exports.UpdateCouponRequestTypeEnum = {
+    Subtotal: 'subtotal',
+    Product: 'product',
+    Shipping: 'shipping'
+};
+/**
+ * @export
+ */
+exports.UpdateCouponRequestDiscountTypeEnum = {
+    Dollar: '$',
+    Percent: '%'
+};
+/**
+ * Check if a given object implements the UpdateCouponRequest interface.
+ */
+function instanceOfUpdateCouponRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('discountType' in value) || value['discountType'] === undefined)
+        return false;
+    if (!('discountAmount' in value) || value['discountAmount'] === undefined)
+        return false;
+    if (!('minAmount' in value) || value['minAmount'] === undefined)
+        return false;
+    if (!('minProducts' in value) || value['minProducts'] === undefined)
+        return false;
+    if (!('totalUseLimit' in value) || value['totalUseLimit'] === undefined)
+        return false;
+    if (!('customerUseLimit' in value) || value['customerUseLimit'] === undefined)
+        return false;
+    return true;
+}
+function UpdateCouponRequestFromJSON(json) {
+    return UpdateCouponRequestFromJSONTyped(json, false);
+}
+function UpdateCouponRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'code': json['code'],
+        'type': json['type'],
+        'discountType': json['discount_type'],
+        'discountAmount': json['discount_amount'],
+        'minAmount': json['min_amount'],
+        'minProducts': json['min_products'],
+        'totalUseLimit': json['total_use_limit'],
+        'customerUseLimit': json['customer_use_limit'],
+        'startDate': json['start_date'] == null ? undefined : (new Date(json['start_date'])),
+        'endDate': json['end_date'] == null ? undefined : (new Date(json['end_date'])),
+        'isForAllProducts': json['is_for_all_products'] == null ? undefined : json['is_for_all_products'],
+        'isForAllCustomers': json['is_for_all_customers'] == null ? undefined : json['is_for_all_customers'],
+        'couponables': json['couponables'] == null ? undefined : (json['couponables'].map(CreateCouponRequestCouponablesInner_1.CreateCouponRequestCouponablesInnerFromJSON)),
+    };
+}
+function UpdateCouponRequestToJSON(json) {
+    return UpdateCouponRequestToJSONTyped(json, false);
+}
+function UpdateCouponRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'code': value['code'],
+        'type': value['type'],
+        'discount_type': value['discountType'],
+        'discount_amount': value['discountAmount'],
+        'min_amount': value['minAmount'],
+        'min_products': value['minProducts'],
+        'total_use_limit': value['totalUseLimit'],
+        'customer_use_limit': value['customerUseLimit'],
+        'start_date': value['startDate'] == null ? value['startDate'] : value['startDate'].toISOString(),
+        'end_date': value['endDate'] == null ? value['endDate'] : value['endDate'].toISOString(),
+        'is_for_all_products': value['isForAllProducts'],
+        'is_for_all_customers': value['isForAllCustomers'],
+        'couponables': value['couponables'] == null ? undefined : (value['couponables'].map(CreateCouponRequestCouponablesInner_1.CreateCouponRequestCouponablesInnerToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -79,6 +79,13 @@ export * from './CategoryFrontendResourceArrayResponse';
 export * from './CategoryWithChildrenFrontendResource';
 export * from './CategoryWithChildrenFrontendResourceArrayResponse';
 export * from './CouponDiscountType';
+export * from './CouponListResource';
+export * from './CouponListResourceArrayResponse';
+export * from './CouponLiteResource';
+export * from './CouponLiteResourceArrayResponse';
+export * from './CouponResource';
+export * from './CouponResourceArrayResponse';
+export * from './CouponType';
 export * from './CreateAssetFileRequest';
 export * from './CreateAssetForAssetableRequest';
 export * from './CreateAttributeRequest';
@@ -89,6 +96,8 @@ export * from './CreateBlogCategoryRequestSeoInner';
 export * from './CreateCartRequest';
 export * from './CreateCartRequestItemsInner';
 export * from './CreateCartRequestShippingAddress';
+export * from './CreateCouponRequest';
+export * from './CreateCouponRequestCouponablesInner';
 export * from './CreateCustomerRequest';
 export * from './CreateDefinitionRequest';
 export * from './CreateDocumentFileRequest';
@@ -280,6 +289,9 @@ export * from './PaginatedBlogCategoryResourceResponse';
 export * from './PaginatedBlogFrontendResourceResponse';
 export * from './PaginatedCartListResourceResponse';
 export * from './PaginatedCategoryFrontendResourceResponse';
+export * from './PaginatedCouponListResourceResponse';
+export * from './PaginatedCouponLiteResourceResponse';
+export * from './PaginatedCouponResourceResponse';
 export * from './PaginatedCustomerListResourceResponse';
 export * from './PaginatedCustomerReviewableItemFrontendResourceResponse';
 export * from './PaginatedDefinitionListResourceResponse';
@@ -478,6 +490,7 @@ export * from './SearchAdminNotesRequest';
 export * from './SearchAllAttributeValuesRequest';
 export * from './SearchAllAttributesRequest';
 export * from './SearchAllBlogCategoriesRequest';
+export * from './SearchAllCouponsRequest';
 export * from './SearchAllDefinitionsRequest';
 export * from './SearchAllDocumentsRequest';
 export * from './SearchAllFrontendComponentsRequest';
@@ -499,6 +512,7 @@ export * from './SearchAttributeValuesRequest';
 export * from './SearchAttributesRequest';
 export * from './SearchBlogCategoriesRequest';
 export * from './SearchCartsRequest';
+export * from './SearchCouponsRequest';
 export * from './SearchCustomersRequest';
 export * from './SearchDefinitionsRequest';
 export * from './SearchDocumentsRequest';
@@ -596,6 +610,7 @@ export * from './UpdateAttributeRequest';
 export * from './UpdateAttributeValueRequest';
 export * from './UpdateBlogCategoryRequest';
 export * from './UpdateCartRequest';
+export * from './UpdateCouponRequest';
 export * from './UpdateDefinitionRequest';
 export * from './UpdateDocumentRequest';
 export * from './UpdateLabelRequest';

package/dist/models/index.js

@@ -97,6 +97,13 @@ __exportStar(require("./CategoryFrontendResourceArrayResponse"), exports);
 __exportStar(require("./CategoryWithChildrenFrontendResource"), exports);
 __exportStar(require("./CategoryWithChildrenFrontendResourceArrayResponse"), exports);
 __exportStar(require("./CouponDiscountType"), exports);
+__exportStar(require("./CouponListResource"), exports);
+__exportStar(require("./CouponListResourceArrayResponse"), exports);
+__exportStar(require("./CouponLiteResource"), exports);
+__exportStar(require("./CouponLiteResourceArrayResponse"), exports);
+__exportStar(require("./CouponResource"), exports);
+__exportStar(require("./CouponResourceArrayResponse"), exports);
+__exportStar(require("./CouponType"), exports);
 __exportStar(require("./CreateAssetFileRequest"), exports);
 __exportStar(require("./CreateAssetForAssetableRequest"), exports);
 __exportStar(require("./CreateAttributeRequest"), exports);
@@ -107,6 +114,8 @@ __exportStar(require("./CreateBlogCategoryRequestSeoInner"), exports);
 __exportStar(require("./CreateCartRequest"), exports);
 __exportStar(require("./CreateCartRequestItemsInner"), exports);
 __exportStar(require("./CreateCartRequestShippingAddress"), exports);
+__exportStar(require("./CreateCouponRequest"), exports);
+__exportStar(require("./CreateCouponRequestCouponablesInner"), exports);
 __exportStar(require("./CreateCustomerRequest"), exports);
 __exportStar(require("./CreateDefinitionRequest"), exports);
 __exportStar(require("./CreateDocumentFileRequest"), exports);
@@ -298,6 +307,9 @@ __exportStar(require("./PaginatedBlogCategoryResourceResponse"), exports);
 __exportStar(require("./PaginatedBlogFrontendResourceResponse"), exports);
 __exportStar(require("./PaginatedCartListResourceResponse"), exports);
 __exportStar(require("./PaginatedCategoryFrontendResourceResponse"), exports);
+__exportStar(require("./PaginatedCouponListResourceResponse"), exports);
+__exportStar(require("./PaginatedCouponLiteResourceResponse"), exports);
+__exportStar(require("./PaginatedCouponResourceResponse"), exports);
 __exportStar(require("./PaginatedCustomerListResourceResponse"), exports);
 __exportStar(require("./PaginatedCustomerReviewableItemFrontendResourceResponse"), exports);
 __exportStar(require("./PaginatedDefinitionListResourceResponse"), exports);
@@ -496,6 +508,7 @@ __exportStar(require("./SearchAdminNotesRequest"), exports);
 __exportStar(require("./SearchAllAttributeValuesRequest"), exports);
 __exportStar(require("./SearchAllAttributesRequest"), exports);
 __exportStar(require("./SearchAllBlogCategoriesRequest"), exports);
+__exportStar(require("./SearchAllCouponsRequest"), exports);
 __exportStar(require("./SearchAllDefinitionsRequest"), exports);
 __exportStar(require("./SearchAllDocumentsRequest"), exports);
 __exportStar(require("./SearchAllFrontendComponentsRequest"), exports);
@@ -517,6 +530,7 @@ __exportStar(require("./SearchAttributeValuesRequest"), exports);
 __exportStar(require("./SearchAttributesRequest"), exports);
 __exportStar(require("./SearchBlogCategoriesRequest"), exports);
 __exportStar(require("./SearchCartsRequest"), exports);
+__exportStar(require("./SearchCouponsRequest"), exports);
 __exportStar(require("./SearchCustomersRequest"), exports);
 __exportStar(require("./SearchDefinitionsRequest"), exports);
 __exportStar(require("./SearchDocumentsRequest"), exports);
@@ -614,6 +628,7 @@ __exportStar(require("./UpdateAttributeRequest"), exports);
 __exportStar(require("./UpdateAttributeValueRequest"), exports);
 __exportStar(require("./UpdateBlogCategoryRequest"), exports);
 __exportStar(require("./UpdateCartRequest"), exports);
+__exportStar(require("./UpdateCouponRequest"), exports);
 __exportStar(require("./UpdateDefinitionRequest"), exports);
 __exportStar(require("./UpdateDocumentRequest"), exports);
 __exportStar(require("./UpdateLabelRequest"), exports);

package/docs/CouponListResource.md

@@ -0,0 +1,52 @@
+
+# CouponListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`code` | string
+`type` | object
+`discountType` | object
+`discountAmount` | number
+`startDate` | Date
+`endDate` | Date
+`isAbandonedCart` | boolean
+`site` | [SiteLiteResource](SiteLiteResource.md)
+
+## Example
+
+```typescript
+import type { CouponListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "code": null,
+  "type": null,
+  "discountType": null,
+  "discountAmount": null,
+  "startDate": null,
+  "endDate": null,
+  "isAbandonedCart": null,
+  "site": null,
+} satisfies CouponListResource
+
+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 CouponListResource
+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/CouponListResourceArrayResponse.md

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

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

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

@@ -0,0 +1,78 @@
+
+# CouponResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`siteId` | number
+`name` | string
+`code` | string
+`type` | object
+`discountType` | object
+`discountAmount` | number
+`minAmount` | number
+`minProducts` | number
+`totalUseLimit` | number
+`customerUseLimit` | number
+`isAbandonedCart` | boolean
+`isForAllProducts` | boolean
+`isForAllCustomers` | boolean
+`startDate` | Date
+`endDate` | Date
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`productChildren` | object
+`categories` | object
+`suppliers` | object
+`customers` | [Array<CustomerListResource>](CustomerListResource.md)
+`ordersCount` | number
+`cartsCount` | number
+
+## Example
+
+```typescript
+import type { CouponResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "siteId": null,
+  "name": null,
+  "code": null,
+  "type": null,
+  "discountType": null,
+  "discountAmount": null,
+  "minAmount": null,
+  "minProducts": null,
+  "totalUseLimit": null,
+  "customerUseLimit": null,
+  "isAbandonedCart": null,
+  "isForAllProducts": null,
+  "isForAllCustomers": null,
+  "startDate": null,
+  "endDate": null,
+  "site": null,
+  "productChildren": null,
+  "categories": null,
+  "suppliers": null,
+  "customers": null,
+  "ordersCount": null,
+  "cartsCount": null,
+} satisfies CouponResource
+
+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 CouponResource
+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/CouponResourceArrayResponse.md

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

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