@teemill/inserts 0.2.1 → 0.4.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/inserts@0.2.1
+## @teemill/inserts@0.4.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/inserts@0.2.1 --save
+npm install @teemill/inserts@0.4.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,3 +44,56 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
+
+### Documentation for API Endpoints
+
+All URIs are relative to *https://api.localhost:8080*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*InsertsApi* | [**createInsert**](docs/InsertsApi.md#createinsert) | **POST** /v1/inserts | Create an insert
+*InsertsApi* | [**getInsert**](docs/InsertsApi.md#getinsert) | **GET** /v1/inserts/{insertId} | Retrieve an insert for a project
+*InsertsApi* | [**listInserts**](docs/InsertsApi.md#listinserts) | **GET** /v1/inserts | List project inserts
+*InsertsApi* | [**updateInsert**](docs/InsertsApi.md#updateinsert) | **PATCH** /v1/inserts/{insertId} | Update an insert
+*InsertsTypesApi* | [**getInsertType**](docs/InsertsTypesApi.md#getinserttype) | **GET** /v1/inserts/types/{insertTypeId} | Retrieve an insert type
+*InsertsTypesApi* | [**listInsertTypes**](docs/InsertsTypesApi.md#listinserttypes) | **GET** /v1/inserts/types | List insert types
+
+
+### Documentation For Models
+
+ - [ApiError](docs/ApiError.md)
+ - [CreateInsertRequest](docs/CreateInsertRequest.md)
+ - [CreateInsertRequestConfig](docs/CreateInsertRequestConfig.md)
+ - [CreateInsertRequestConfigCoupon](docs/CreateInsertRequestConfigCoupon.md)
+ - [Insert](docs/Insert.md)
+ - [InsertConfig](docs/InsertConfig.md)
+ - [InsertConfigCoupon](docs/InsertConfigCoupon.md)
+ - [InsertType](docs/InsertType.md)
+ - [ListInsertTypes200Response](docs/ListInsertTypes200Response.md)
+ - [ListInserts200Response](docs/ListInserts200Response.md)
+ - [UpdateInsertRequest](docs/UpdateInsertRequest.md)
+ - [UpdateInsertRequestConfig](docs/UpdateInsertRequestConfig.md)
+ - [UpdateInsertRequestConfigCoupon](docs/UpdateInsertRequestConfigCoupon.md)
+ - [Value](docs/Value.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="api-key"></a>
+### api-key
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+<a id="session-oauth"></a>
+### session-oauth
+
+- **Type**: OAuth
+- **Flow**: password
+- **Authorization URL**: 
+- **Scopes**: N/A
+

package/api.ts

@@ -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.1
+ * The version of the OpenAPI document: 0.4.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -66,7 +66,90 @@ 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 number of hours after creation which the coupon will expire
+     * @type {number}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'expiryHours': number;
+    /**
+     * The number of times the coupon can be used
+     * @type {number}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'numberOfUses': number;
+    /**
+     * 
+     * @type {Value}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'value': Value;
+    /**
+     * The minimum order value to apply the coupon to
+     * @type {number}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'minimumOrderValue': number;
+    /**
+     * A list of delivery methods that will be used for the discount. **Note:** Adding delivery methods requires the delivery integration to be installed on your project.
+     * @type {Array<string>}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'freeDeliveryMethods'?: Array<string>;
+    /**
+     * The description of the coupon to apply to the insert
+     * @type {string}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'description': string;
 }
+
+export const CreateInsertRequestConfigCouponTypeEnum = {
+    Percentage: 'percentage',
+    Fixed: 'fixed',
+    Item: 'item'
+} as const;
+
+export type CreateInsertRequestConfigCouponTypeEnum = typeof CreateInsertRequestConfigCouponTypeEnum[keyof typeof CreateInsertRequestConfigCouponTypeEnum];
+
 /**
  * 
  * @export
@@ -97,6 +180,12 @@ export interface Insert {
      * @memberof Insert
      */
     'typeRef': string;
+    /**
+     * 
+     * @type {InsertConfig}
+     * @memberof Insert
+     */
+    'config': InsertConfig | null;
     /**
      * ISO 8601 Timestamp
      * @type {string}
@@ -110,6 +199,83 @@ 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 number of hours after creation which the coupon will expire
+     * @type {number}
+     * @memberof InsertConfigCoupon
+     */
+    'expiryHours': number;
+    /**
+     * The number of times the coupon can be used
+     * @type {number}
+     * @memberof InsertConfigCoupon
+     */
+    'numberOfUses': number;
+    /**
+     * A list of delivery methods for the discount.
+     * @type {Array<string>}
+     * @memberof InsertConfigCoupon
+     */
+    'freeDeliveryMethods'?: Array<string> | null;
+    /**
+     * 
+     * @type {Value}
+     * @memberof InsertConfigCoupon
+     */
+    'value': Value;
+    /**
+     * The minimum order value to apply the coupon to
+     * @type {number}
+     * @memberof InsertConfigCoupon
+     */
+    'minimumOrderValue': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof InsertConfigCoupon
+     */
+    'description': string;
+}
+
+export const InsertConfigCouponTypeEnum = {
+    Percentage: 'percentage',
+    Fixed: 'fixed',
+    Item: 'item'
+} as const;
+
+export type InsertConfigCouponTypeEnum = typeof InsertConfigCouponTypeEnum[keyof typeof InsertConfigCouponTypeEnum];
+
 /**
  * 
  * @export
@@ -203,8 +369,98 @@ 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 number of times the coupon can be used
+     * @type {number}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'numberOfUses': number;
+    /**
+     * The number of hours after creation which the coupon will expire
+     * @type {number}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'expiryHours': number;
+    /**
+     * The type of coupon to apply to the insert
+     * @type {string}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'type': UpdateInsertRequestConfigCouponTypeEnum;
+    /**
+     * 
+     * @type {Value}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'value': Value;
+    /**
+     * The minimum order value to apply the coupon to
+     * @type {number}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'minimumOrderValue': number;
+    /**
+     * A list of delivery methods that will be used for the discount. **Note:** Adding delivery methods requires the delivery integration to be installed on your project.
+     * @type {Array<string>}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'freeDeliveryMethods'?: Array<string> | null;
+    /**
+     * The description of the coupon to apply to the insert
+     * @type {string}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'description': string;
 }
 
+export const UpdateInsertRequestConfigCouponTypeEnum = {
+    Percentage: 'percentage',
+    Fixed: 'fixed',
+    Item: 'item'
+} as const;
+
+export type UpdateInsertRequestConfigCouponTypeEnum = typeof UpdateInsertRequestConfigCouponTypeEnum[keyof typeof UpdateInsertRequestConfigCouponTypeEnum];
+
+/**
+ * @type Value
+ * The value of the discount. For percentage discounts, this is the percentage (0-100). For fixed discounts, this is the fixed amount. For item discounts, this is the product reference.
+ * @export
+ */
+export type Value = number | string;
+
+
 /**
  * InsertsApi - axios parameter creator
  * @export

package/base.ts

@@ -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.1
+ * The version of the OpenAPI document: 0.4.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -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.1
+ * The version of the OpenAPI document: 0.4.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -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.1
+ * The version of the OpenAPI document: 0.4.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/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.1
+ * The version of the OpenAPI document: 0.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -56,7 +56,87 @@ 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 number of hours after creation which the coupon will expire
+     * @type {number}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'expiryHours': number;
+    /**
+     * The number of times the coupon can be used
+     * @type {number}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'numberOfUses': number;
+    /**
+     *
+     * @type {Value}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'value': Value;
+    /**
+     * The minimum order value to apply the coupon to
+     * @type {number}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'minimumOrderValue': number;
+    /**
+     * A list of delivery methods that will be used for the discount. **Note:** Adding delivery methods requires the delivery integration to be installed on your project.
+     * @type {Array<string>}
+     * @memberof CreateInsertRequestConfigCoupon
+     */
+    'freeDeliveryMethods'?: Array<string>;
+    /**
+     * 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";
+    readonly Item: "item";
+};
+export type CreateInsertRequestConfigCouponTypeEnum = typeof CreateInsertRequestConfigCouponTypeEnum[keyof typeof CreateInsertRequestConfigCouponTypeEnum];
 /**
  *
  * @export
@@ -87,6 +167,12 @@ export interface Insert {
      * @memberof Insert
      */
     'typeRef': string;
+    /**
+     *
+     * @type {InsertConfig}
+     * @memberof Insert
+     */
+    'config': InsertConfig | null;
     /**
      * ISO 8601 Timestamp
      * @type {string}
@@ -100,6 +186,80 @@ 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 number of hours after creation which the coupon will expire
+     * @type {number}
+     * @memberof InsertConfigCoupon
+     */
+    'expiryHours': number;
+    /**
+     * The number of times the coupon can be used
+     * @type {number}
+     * @memberof InsertConfigCoupon
+     */
+    'numberOfUses': number;
+    /**
+     * A list of delivery methods for the discount.
+     * @type {Array<string>}
+     * @memberof InsertConfigCoupon
+     */
+    'freeDeliveryMethods'?: Array<string> | null;
+    /**
+     *
+     * @type {Value}
+     * @memberof InsertConfigCoupon
+     */
+    'value': Value;
+    /**
+     * 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";
+    readonly Item: "item";
+};
+export type InsertConfigCouponTypeEnum = typeof InsertConfigCouponTypeEnum[keyof typeof InsertConfigCouponTypeEnum];
 /**
  *
  * @export
@@ -193,7 +353,93 @@ 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 number of times the coupon can be used
+     * @type {number}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'numberOfUses': number;
+    /**
+     * The number of hours after creation which the coupon will expire
+     * @type {number}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'expiryHours': number;
+    /**
+     * The type of coupon to apply to the insert
+     * @type {string}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'type': UpdateInsertRequestConfigCouponTypeEnum;
+    /**
+     *
+     * @type {Value}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'value': Value;
+    /**
+     * The minimum order value to apply the coupon to
+     * @type {number}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'minimumOrderValue': number;
+    /**
+     * A list of delivery methods that will be used for the discount. **Note:** Adding delivery methods requires the delivery integration to be installed on your project.
+     * @type {Array<string>}
+     * @memberof UpdateInsertRequestConfigCoupon
+     */
+    'freeDeliveryMethods'?: Array<string> | null;
+    /**
+     * 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";
+    readonly Item: "item";
+};
+export type UpdateInsertRequestConfigCouponTypeEnum = typeof UpdateInsertRequestConfigCouponTypeEnum[keyof typeof UpdateInsertRequestConfigCouponTypeEnum];
+/**
+ * @type Value
+ * The value of the discount. For percentage discounts, this is the percentage (0-100). For fixed discounts, this is the fixed amount. For item discounts, this is the product reference.
+ * @export
+ */
+export type Value = number | string;
 /**
  * InsertsApi - axios parameter creator
  * @export