@teemill/inserts 0.2.0 → 0.3.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -56,7 +56,68 @@ export interface CreateInsertRequest {
      * @memberof CreateInsertRequest
      */
     'typeRef': string;
+    /**
+     *
+     * @type {CreateInsertRequestConfig}
+     * @memberof CreateInsertRequest
+     */
+    'config'?: CreateInsertRequestConfig;
+}
+/**
+ *
+ * @export
+ * @interface CreateInsertRequestConfig
+ */
+export interface CreateInsertRequestConfig {
+    /**
+     *
+     * @type {CreateInsertRequestConfigCoupon}
+     * @memberof CreateInsertRequestConfig
+     */
+    'coupon'?: CreateInsertRequestConfigCoupon;
+}
+/**
+ *
+ * @export
+ * @interface CreateInsertRequestConfigCoupon
+ */
+export interface CreateInsertRequestConfigCoupon {
+    /**
+     * The prefix of the coupon code to apply to the insert
+     * @type {string}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'prefix': string;
+    /**
+     * The type of coupon to apply to the insert
+     * @type {string}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'type': CreateInsertRequestConfigCouponTypeEnum;
+    /**
+     * The value of the coupon to apply to the insert
+     * @type {number}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'value': number;
+    /**
+     * The minimum order value to apply the coupon to
+     * @type {number}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'minimumOrderValue': number;
+    /**
+     * The description of the coupon to apply to the insert
+     * @type {string}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'description': string;
 }
+export declare const CreateInsertRequestConfigCouponTypeEnum: {
+    readonly Percentage: "percentage";
+    readonly Fixed: "fixed";
+};
+export type CreateInsertRequestConfigCouponTypeEnum = typeof CreateInsertRequestConfigCouponTypeEnum[keyof typeof CreateInsertRequestConfigCouponTypeEnum];
 /**
  *
  * @export
@@ -80,13 +141,19 @@ export interface Insert {
      * @type {string}
      * @memberof Insert
      */
-    'variantRef': string;
+    'variantRef': string | null;
     /**
      * A reference to the insert type that will be inserted into the order when this insert rule is triggered
      * @type {string}
      * @memberof Insert
      */
     'typeRef': string;
+    /**
+     *
+     * @type {InsertConfig}
+     * @memberof Insert
+     */
+    'config': InsertConfig | null;
     /**
      * ISO 8601 Timestamp
      * @type {string}
@@ -100,6 +167,61 @@ export interface Insert {
      */
     'updatedAt': string | null;
 }
+/**
+ * The configuration of the insert
+ * @export
+ * @interface InsertConfig
+ */
+export interface InsertConfig {
+    /**
+     *
+     * @type {InsertConfigCoupon}
+     * @memberof InsertConfig
+     */
+    'coupon'?: InsertConfigCoupon | null;
+}
+/**
+ *
+ * @export
+ * @interface InsertConfigCoupon
+ */
+export interface InsertConfigCoupon {
+    /**
+     * The prefix of the coupon code to apply to the insert
+     * @type {string}
+     * @memberof InsertConfigCoupon
+     */
+    'prefix': string;
+    /**
+     * The type of coupon to apply to the insert
+     * @type {string}
+     * @memberof InsertConfigCoupon
+     */
+    'type': InsertConfigCouponTypeEnum;
+    /**
+     * The value of the coupon to apply to the insert
+     * @type {number}
+     * @memberof InsertConfigCoupon
+     */
+    'value': number;
+    /**
+     * The minimum order value to apply the coupon to
+     * @type {number}
+     * @memberof InsertConfigCoupon
+     */
+    'minimumOrderValue': number;
+    /**
+     *
+     * @type {string}
+     * @memberof InsertConfigCoupon
+     */
+    'description': string;
+}
+export declare const InsertConfigCouponTypeEnum: {
+    readonly Percentage: "percentage";
+    readonly Fixed: "fixed";
+};
+export type InsertConfigCouponTypeEnum = typeof InsertConfigCouponTypeEnum[keyof typeof InsertConfigCouponTypeEnum];
 /**
  *
  * @export
@@ -193,7 +315,68 @@ export interface UpdateInsertRequest {
      * @memberof UpdateInsertRequest
      */
     'typeRef'?: string;
+    /**
+     *
+     * @type {UpdateInsertRequestConfig}
+     * @memberof UpdateInsertRequest
+     */
+    'config'?: UpdateInsertRequestConfig | null;
 }
+/**
+ *
+ * @export
+ * @interface UpdateInsertRequestConfig
+ */
+export interface UpdateInsertRequestConfig {
+    /**
+     *
+     * @type {UpdateInsertRequestConfigCoupon}
+     * @memberof UpdateInsertRequestConfig
+     */
+    'coupon'?: UpdateInsertRequestConfigCoupon;
+}
+/**
+ *
+ * @export
+ * @interface UpdateInsertRequestConfigCoupon
+ */
+export interface UpdateInsertRequestConfigCoupon {
+    /**
+     * The prefix of the coupon code to apply to the insert
+     * @type {string}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'prefix': string;
+    /**
+     * The type of coupon to apply to the insert
+     * @type {string}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'type': UpdateInsertRequestConfigCouponTypeEnum;
+    /**
+     * The value of the coupon to apply to the insert
+     * @type {number}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'value': number;
+    /**
+     * The minimum order value to apply the coupon to
+     * @type {number}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'minimumOrderValue': number;
+    /**
+     * The description of the coupon to apply to the insert
+     * @type {string}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'description': string;
+}
+export declare const UpdateInsertRequestConfigCouponTypeEnum: {
+    readonly Percentage: "percentage";
+    readonly Fixed: "fixed";
+};
+export type UpdateInsertRequestConfigCouponTypeEnum = typeof UpdateInsertRequestConfigCouponTypeEnum[keyof typeof UpdateInsertRequestConfigCouponTypeEnum];
 /**
  * InsertsApi - axios parameter creator
  * @export

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,6 +26,18 @@ import globalAxios from 'axios';
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
 // @ts-ignore
 import { BASE_PATH, BaseAPI, operationServerMap } from './base';
+export const CreateInsertRequestConfigCouponTypeEnum = {
+    Percentage: 'percentage',
+    Fixed: 'fixed'
+};
+export const InsertConfigCouponTypeEnum = {
+    Percentage: 'percentage',
+    Fixed: 'fixed'
+};
+export const UpdateInsertRequestConfigCouponTypeEnum = {
+    Percentage: 'percentage',
+    Fixed: 'fixed'
+};
 /**
  * InsertsApi - axios parameter creator
  * @export

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -4,7 +4,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.0
+ * The version of the OpenAPI document: 0.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/ApiError.md

@@ -0,0 +1,22 @@
+# ApiError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to undefined]
+**code** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiError } from '@teemill/inserts';
+
+const instance: ApiError = {
+    message,
+    code,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateInsertRequest.md

@@ -0,0 +1,26 @@
+# CreateInsertRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** | Whether the insert is enabled | [default to undefined]
+**variantRef** | **string** | A reference to the variant that will be inserted into the order when this insert rule is triggered | [default to undefined]
+**typeRef** | **string** | A reference to the insert type that will be inserted into the order when this insert rule is triggered | [default to undefined]
+**config** | [**CreateInsertRequestConfig**](CreateInsertRequestConfig.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateInsertRequest } from '@teemill/inserts';
+
+const instance: CreateInsertRequest = {
+    enabled,
+    variantRef,
+    typeRef,
+    config,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateInsertRequestConfig.md

@@ -0,0 +1,20 @@
+# CreateInsertRequestConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**coupon** | [**CreateInsertRequestConfigCoupon**](CreateInsertRequestConfigCoupon.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateInsertRequestConfig } from '@teemill/inserts';
+
+const instance: CreateInsertRequestConfig = {
+    coupon,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateInsertRequestConfigCoupon.md

@@ -0,0 +1,28 @@
+# CreateInsertRequestConfigCoupon
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prefix** | **string** | The prefix of the coupon code to apply to the insert | [default to undefined]
+**type** | **string** | The type of coupon to apply to the insert | [default to undefined]
+**value** | **number** | The value of the coupon to apply to the insert | [default to undefined]
+**minimumOrderValue** | **number** | The minimum order value to apply the coupon to | [default to undefined]
+**description** | **string** | The description of the coupon to apply to the insert | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateInsertRequestConfigCoupon } from '@teemill/inserts';
+
+const instance: CreateInsertRequestConfigCoupon = {
+    prefix,
+    type,
+    value,
+    minimumOrderValue,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Insert.md

@@ -0,0 +1,32 @@
+# Insert
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**enabled** | **boolean** | Whether the insert is enabled | [default to undefined]
+**variantRef** | **string** | A reference to the variant that will be inserted into the order when this insert rule is triggered | [default to undefined]
+**typeRef** | **string** | A reference to the insert type that will be inserted into the order when this insert rule is triggered | [default to undefined]
+**config** | [**InsertConfig**](InsertConfig.md) |  | [default to undefined]
+**createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
+**updatedAt** | **string** | ISO 8601 Timestamp | [default to undefined]
+
+## Example
+
+```typescript
+import { Insert } from '@teemill/inserts';
+
+const instance: Insert = {
+    id,
+    enabled,
+    variantRef,
+    typeRef,
+    config,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/InsertConfig.md

@@ -0,0 +1,21 @@
+# InsertConfig
+
+The configuration of the insert
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**coupon** | [**InsertConfigCoupon**](InsertConfigCoupon.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InsertConfig } from '@teemill/inserts';
+
+const instance: InsertConfig = {
+    coupon,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/InsertConfigCoupon.md

@@ -0,0 +1,28 @@
+# InsertConfigCoupon
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prefix** | **string** | The prefix of the coupon code to apply to the insert | [default to undefined]
+**type** | **string** | The type of coupon to apply to the insert | [default to undefined]
+**value** | **number** | The value of the coupon to apply to the insert | [default to undefined]
+**minimumOrderValue** | **number** | The minimum order value to apply the coupon to | [default to undefined]
+**description** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { InsertConfigCoupon } from '@teemill/inserts';
+
+const instance: InsertConfigCoupon = {
+    prefix,
+    type,
+    value,
+    minimumOrderValue,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/InsertType.md

@@ -0,0 +1,26 @@
+# InsertType
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**name** | **string** | The name of the insert type | [default to undefined]
+**code** | **string** | The code of the insert type | [default to undefined]
+**description** | **string** | The description of the insert type | [default to undefined]
+
+## Example
+
+```typescript
+import { InsertType } from '@teemill/inserts';
+
+const instance: InsertType = {
+    id,
+    name,
+    code,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)