@teemill/inserts 0.4.1 → 0.4.3

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.4.1
+ * The version of the OpenAPI document: 0.4.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,121 +13,56 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
-/**
- *
- * @export
- * @interface ApiError
- */
 export interface ApiError {
-    /**
-     *
-     * @type {string}
-     * @memberof ApiError
-     */
     'message': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ApiError
-     */
     'code': string;
 }
-/**
- *
- * @export
- * @interface CreateInsertRequest
- */
 export interface CreateInsertRequest {
     /**
      * Whether the insert is enabled
-     * @type {boolean}
-     * @memberof CreateInsertRequest
      */
     'enabled': boolean;
     /**
      * A reference to the variant that will be inserted into the order when this insert rule is triggered
-     * @type {string}
-     * @memberof CreateInsertRequest
      */
     'variantRef': string;
     /**
      * A reference to the insert type that will be inserted into the order when this insert rule is triggered
-     * @type {string}
-     * @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;
 }
@@ -137,159 +72,65 @@ export declare const CreateInsertRequestConfigCouponTypeEnum: {
     readonly Item: "item";
 };
 export type CreateInsertRequestConfigCouponTypeEnum = typeof CreateInsertRequestConfigCouponTypeEnum[keyof typeof CreateInsertRequestConfigCouponTypeEnum];
-/**
- *
- * @export
- * @interface InlineObject
- */
-export interface InlineObject {
-    /**
-     *
-     * @type {Array<InsertType>}
-     * @memberof InlineObject
-     */
-    'insertTypes': Array<InsertType>;
-    /**
-     * The token referencing the next page number
-     * @type {number}
-     * @memberof InlineObject
-     */
-    'nextPageToken': number | null;
-}
-/**
- *
- * @export
- * @interface InlineObject1
- */
-export interface InlineObject1 {
-    /**
-     *
-     * @type {Array<Insert>}
-     * @memberof InlineObject1
-     */
-    'inserts': Array<Insert>;
-    /**
-     * The token referencing the next page number
-     * @type {number}
-     * @memberof InlineObject1
-     */
-    'nextPageToken': number | null;
-}
-/**
- *
- * @export
- * @interface Insert
- */
 export interface Insert {
     /**
      * Unique object identifier
-     * @type {string}
-     * @memberof Insert
      */
     'id': string;
     /**
      * Whether the insert is enabled
-     * @type {boolean}
-     * @memberof Insert
      */
     'enabled': boolean;
     /**
      * A reference to the variant that will be inserted into the order when this insert rule is triggered
-     * @type {string}
-     * @memberof Insert
      */
     '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}
-     * @memberof Insert
      */
     'createdAt': string;
     /**
      * ISO 8601 Timestamp
-     * @type {string}
-     * @memberof 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: {
@@ -298,133 +139,84 @@ export declare const InsertConfigCouponTypeEnum: {
     readonly Item: "item";
 };
 export type InsertConfigCouponTypeEnum = typeof InsertConfigCouponTypeEnum[keyof typeof InsertConfigCouponTypeEnum];
-/**
- *
- * @export
- * @interface InsertType
- */
 export interface InsertType {
     /**
      * Unique object identifier
-     * @type {string}
-     * @memberof InsertType
      */
     'id': string;
     /**
      * The name of the insert type
-     * @type {string}
-     * @memberof InsertType
      */
     'name': string;
     /**
      * The code of the insert type
-     * @type {string}
-     * @memberof InsertType
      */
     'code': string;
     /**
      * The description of the insert type
-     * @type {string}
-     * @memberof InsertType
      */
     'description': string;
 }
-/**
- *
- * @export
- * @interface UpdateInsertRequest
- */
+export interface ListInsertTypes200Response {
+    'insertTypes': Array<InsertType>;
+    /**
+     * The token referencing the next page number
+     */
+    'nextPageToken': number | null;
+}
+export interface ListInserts200Response {
+    'inserts': Array<Insert>;
+    /**
+     * The token referencing the next page number
+     */
+    'nextPageToken': number | null;
+}
 export interface UpdateInsertRequest {
     /**
      * Whether the insert is enabled
-     * @type {boolean}
-     * @memberof UpdateInsertRequest
      */
     'enabled'?: boolean;
     /**
      * A reference to the variant that will be inserted into the order when this insert rule is triggered
-     * @type {string}
-     * @memberof UpdateInsertRequest
      */
     'variantRef'?: string;
     /**
      * A reference to the insert type that will be inserted into the order when this insert rule is triggered
-     * @type {string}
-     * @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;
 }
@@ -437,12 +229,10 @@ export type UpdateInsertRequestConfigCouponTypeEnum = typeof UpdateInsertRequest
 /**
  * @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
  */
 export declare const InsertsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -487,7 +277,6 @@ export declare const InsertsApiAxiosParamCreator: (configuration?: Configuration
 };
 /**
  * InsertsApi - functional programming interface
- * @export
  */
 export declare const InsertsApiFp: (configuration?: Configuration) => {
     /**
@@ -518,7 +307,7 @@ export declare const InsertsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listInserts(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject1>>;
+    listInserts(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInserts200Response>>;
     /**
      * Update an insert for a project
      * @summary Update an insert
@@ -532,7 +321,6 @@ export declare const InsertsApiFp: (configuration?: Configuration) => {
 };
 /**
  * InsertsApi - factory interface
- * @export
  */
 export declare const InsertsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -558,7 +346,7 @@ export declare const InsertsApiFactory: (configuration?: Configuration, basePath
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject1>;
+    listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInserts200Response>;
     /**
      * Update an insert for a project
      * @summary Update an insert
@@ -570,103 +358,58 @@ export declare const InsertsApiFactory: (configuration?: Configuration, basePath
 };
 /**
  * Request parameters for createInsert operation in InsertsApi.
- * @export
- * @interface InsertsApiCreateInsertRequest
  */
 export interface InsertsApiCreateInsertRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof InsertsApiCreateInsert
-     */
     readonly project: string;
     /**
      * Create an insert
-     * @type {CreateInsertRequest}
-     * @memberof InsertsApiCreateInsert
      */
     readonly createInsertRequest: CreateInsertRequest;
 }
 /**
  * Request parameters for getInsert operation in InsertsApi.
- * @export
- * @interface InsertsApiGetInsertRequest
  */
 export interface InsertsApiGetInsertRequest {
     /**
      * Filter by insert ID
-     * @type {string}
-     * @memberof InsertsApiGetInsert
      */
     readonly insertId: string;
-    /**
-     *
-     * @type {string}
-     * @memberof InsertsApiGetInsert
-     */
     readonly project: string;
 }
 /**
  * Request parameters for listInserts operation in InsertsApi.
- * @export
- * @interface InsertsApiListInsertsRequest
  */
 export interface InsertsApiListInsertsRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof InsertsApiListInserts
-     */
     readonly project: string;
     /**
      * Page reference token
-     * @type {number}
-     * @memberof InsertsApiListInserts
      */
     readonly pageToken?: number;
     /**
      * Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @type {number}
-     * @memberof InsertsApiListInserts
      */
     readonly pageSize?: number;
     /**
      * Search for inserts by id or name
-     * @type {string}
-     * @memberof InsertsApiListInserts
      */
     readonly search?: string;
 }
 /**
  * Request parameters for updateInsert operation in InsertsApi.
- * @export
- * @interface InsertsApiUpdateInsertRequest
  */
 export interface InsertsApiUpdateInsertRequest {
     /**
      * Filter by insert ID
-     * @type {string}
-     * @memberof InsertsApiUpdateInsert
      */
     readonly insertId: string;
-    /**
-     *
-     * @type {string}
-     * @memberof InsertsApiUpdateInsert
-     */
     readonly project: string;
     /**
      * Update an insert
-     * @type {UpdateInsertRequest}
-     * @memberof InsertsApiUpdateInsert
      */
     readonly updateInsertRequest: UpdateInsertRequest;
 }
 /**
  * InsertsApi - object-oriented interface
- * @export
- * @class InsertsApi
- * @extends {BaseAPI}
  */
 export declare class InsertsApi extends BaseAPI {
     /**
@@ -675,40 +418,35 @@ export declare class InsertsApi extends BaseAPI {
      * @param {InsertsApiCreateInsertRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InsertsApi
      */
-    createInsert(requestParameters: InsertsApiCreateInsertRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Insert, any>>;
+    createInsert(requestParameters: InsertsApiCreateInsertRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Insert, any, {}>>;
     /**
      * Retrieve details for a specific insert for a project
      * @summary Retrieve an insert for a project
      * @param {InsertsApiGetInsertRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InsertsApi
      */
-    getInsert(requestParameters: InsertsApiGetInsertRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Insert, any>>;
+    getInsert(requestParameters: InsertsApiGetInsertRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Insert, any, {}>>;
     /**
      * List your project inserts
      * @summary List project inserts
      * @param {InsertsApiListInsertsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InsertsApi
      */
-    listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject1, any>>;
+    listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInserts200Response, any, {}>>;
     /**
      * Update an insert for a project
      * @summary Update an insert
      * @param {InsertsApiUpdateInsertRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InsertsApi
      */
-    updateInsert(requestParameters: InsertsApiUpdateInsertRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Insert, any>>;
+    updateInsert(requestParameters: InsertsApiUpdateInsertRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Insert, any, {}>>;
 }
 /**
  * InsertsTypesApi - axios parameter creator
- * @export
  */
 export declare const InsertsTypesApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -734,7 +472,6 @@ export declare const InsertsTypesApiAxiosParamCreator: (configuration?: Configur
 };
 /**
  * InsertsTypesApi - functional programming interface
- * @export
  */
 export declare const InsertsTypesApiFp: (configuration?: Configuration) => {
     /**
@@ -756,11 +493,10 @@ export declare const InsertsTypesApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listInsertTypes(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
+    listInsertTypes(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInsertTypes200Response>>;
 };
 /**
  * InsertsTypesApi - factory interface
- * @export
  */
 export declare const InsertsTypesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -778,63 +514,38 @@ export declare const InsertsTypesApiFactory: (configuration?: Configuration, bas
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
+    listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInsertTypes200Response>;
 };
 /**
  * Request parameters for getInsertType operation in InsertsTypesApi.
- * @export
- * @interface InsertsTypesApiGetInsertTypeRequest
  */
 export interface InsertsTypesApiGetInsertTypeRequest {
     /**
      * Filter by insert type ID
-     * @type {string}
-     * @memberof InsertsTypesApiGetInsertType
      */
     readonly insertTypeId: string;
-    /**
-     *
-     * @type {string}
-     * @memberof InsertsTypesApiGetInsertType
-     */
     readonly project: string;
 }
 /**
  * Request parameters for listInsertTypes operation in InsertsTypesApi.
- * @export
- * @interface InsertsTypesApiListInsertTypesRequest
  */
 export interface InsertsTypesApiListInsertTypesRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof InsertsTypesApiListInsertTypes
-     */
     readonly project: string;
     /**
      * Page reference token
-     * @type {number}
-     * @memberof InsertsTypesApiListInsertTypes
      */
     readonly pageToken?: number;
     /**
      * Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @type {number}
-     * @memberof InsertsTypesApiListInsertTypes
      */
     readonly pageSize?: number;
     /**
      * Search for inserts by id or name
-     * @type {string}
-     * @memberof InsertsTypesApiListInsertTypes
      */
     readonly search?: string;
 }
 /**
  * InsertsTypesApi - object-oriented interface
- * @export
- * @class InsertsTypesApi
- * @extends {BaseAPI}
  */
 export declare class InsertsTypesApi extends BaseAPI {
     /**
@@ -843,16 +554,14 @@ export declare class InsertsTypesApi extends BaseAPI {
      * @param {InsertsTypesApiGetInsertTypeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InsertsTypesApi
      */
-    getInsertType(requestParameters: InsertsTypesApiGetInsertTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsertType, any>>;
+    getInsertType(requestParameters: InsertsTypesApiGetInsertTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsertType, any, {}>>;
     /**
      * List all insert types
      * @summary List insert types
      * @param {InsertsTypesApiListInsertTypesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InsertsTypesApi
      */
-    listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
+    listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInsertTypes200Response, any, {}>>;
 }