@teemill/inserts 0.1.1

package/dist/esm/api.d.ts

@@ -0,0 +1,612 @@
+/**
+ * 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.1.1
+ *
+ *
+ * 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 { 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 product that will be inserted into the order when this insert rule is triggered
+     * @type {string}
+     * @memberof CreateInsertRequest
+     */
+    'productRef': string | null;
+    /**
+     * 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 | 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 product that will be inserted into the order when this insert rule is triggered
+     * @type {string}
+     * @memberof Insert
+     */
+    'productRef': 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 | null;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof Insert
+     */
+    'createdAt': string;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof Insert
+     */
+    'updatedAt': string | null;
+}
+/**
+ *
+ * @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 ListInsertTypes200Response
+ */
+export interface ListInsertTypes200Response {
+    /**
+     *
+     * @type {Array<InsertType>}
+     * @memberof ListInsertTypes200Response
+     */
+    'insertTypes': Array<InsertType>;
+    /**
+     * The token referencing the next page number
+     * @type {number}
+     * @memberof ListInsertTypes200Response
+     */
+    'nextPageToken': number | null;
+}
+/**
+ *
+ * @export
+ * @interface ListInserts200Response
+ */
+export interface ListInserts200Response {
+    /**
+     *
+     * @type {Array<Insert>}
+     * @memberof ListInserts200Response
+     */
+    'inserts': Array<Insert>;
+    /**
+     * The token referencing the next page number
+     * @type {number}
+     * @memberof ListInserts200Response
+     */
+    'nextPageToken': number | null;
+}
+/**
+ *
+ * @export
+ * @interface UpdateInsertRequest
+ */
+export interface UpdateInsertRequest {
+    /**
+     * Whether the insert is enabled
+     * @type {boolean}
+     * @memberof UpdateInsertRequest
+     */
+    'enabled'?: boolean;
+    /**
+     * A reference to the product that will be inserted into the order when this insert rule is triggered
+     * @type {string}
+     * @memberof UpdateInsertRequest
+     */
+    'productRef'?: string | null;
+    /**
+     * 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 | null;
+}
+/**
+ * InsertsApi - axios parameter creator
+ * @export
+ */
+export declare const InsertsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create an insert for a project
+     * @summary Create an insert
+     * @param {string} project
+     * @param {CreateInsertRequest} createInsertRequest Create an insert
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createInsert: (project: string, createInsertRequest: CreateInsertRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve details for a specific insert for a project
+     * @summary Retrieve an insert for a project
+     * @param {string} insertId Filter by insert ID
+     * @param {string} project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInsert: (insertId: string, project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List your project inserts
+     * @summary List project inserts
+     * @param {string} project
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search for inserts by id or name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInserts: (project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update an insert for a project
+     * @summary Update an insert
+     * @param {string} insertId Filter by insert ID
+     * @param {string} project
+     * @param {UpdateInsertRequest} updateInsertRequest Update an insert
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateInsert: (insertId: string, project: string, updateInsertRequest: UpdateInsertRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * InsertsApi - functional programming interface
+ * @export
+ */
+export declare const InsertsApiFp: (configuration?: Configuration) => {
+    /**
+     * Create an insert for a project
+     * @summary Create an insert
+     * @param {string} project
+     * @param {CreateInsertRequest} createInsertRequest Create an insert
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createInsert(project: string, createInsertRequest: CreateInsertRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Insert>>;
+    /**
+     * Retrieve details for a specific insert for a project
+     * @summary Retrieve an insert for a project
+     * @param {string} insertId Filter by insert ID
+     * @param {string} project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInsert(insertId: string, project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Insert>>;
+    /**
+     * List your project inserts
+     * @summary List project inserts
+     * @param {string} project
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search for inserts by id or name
+     * @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<ListInserts200Response>>;
+    /**
+     * Update an insert for a project
+     * @summary Update an insert
+     * @param {string} insertId Filter by insert ID
+     * @param {string} project
+     * @param {UpdateInsertRequest} updateInsertRequest Update an insert
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateInsert(insertId: string, project: string, updateInsertRequest: UpdateInsertRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Insert>>;
+};
+/**
+ * InsertsApi - factory interface
+ * @export
+ */
+export declare const InsertsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create an insert for a project
+     * @summary Create an insert
+     * @param {InsertsApiCreateInsertRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createInsert(requestParameters: InsertsApiCreateInsertRequest, options?: RawAxiosRequestConfig): AxiosPromise<Insert>;
+    /**
+     * 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}
+     */
+    getInsert(requestParameters: InsertsApiGetInsertRequest, options?: RawAxiosRequestConfig): AxiosPromise<Insert>;
+    /**
+     * List your project inserts
+     * @summary List project inserts
+     * @param {InsertsApiListInsertsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInserts200Response>;
+    /**
+     * Update an insert for a project
+     * @summary Update an insert
+     * @param {InsertsApiUpdateInsertRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateInsert(requestParameters: InsertsApiUpdateInsertRequest, options?: RawAxiosRequestConfig): AxiosPromise<Insert>;
+};
+/**
+ * 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 {
+    /**
+     * Create an insert for a project
+     * @summary Create an insert
+     * @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>>;
+    /**
+     * 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>>;
+    /**
+     * 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<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>>;
+}
+/**
+ * InsertsTypesApi - axios parameter creator
+ * @export
+ */
+export declare const InsertsTypesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Retrieve details for a specific insert type
+     * @summary Retrieve an insert type
+     * @param {string} insertTypeId Filter by insert type ID
+     * @param {string} project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInsertType: (insertTypeId: string, project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all insert types
+     * @summary List insert types
+     * @param {string} project
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search for inserts by id or name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInsertTypes: (project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * InsertsTypesApi - functional programming interface
+ * @export
+ */
+export declare const InsertsTypesApiFp: (configuration?: Configuration) => {
+    /**
+     * Retrieve details for a specific insert type
+     * @summary Retrieve an insert type
+     * @param {string} insertTypeId Filter by insert type ID
+     * @param {string} project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInsertType(insertTypeId: string, project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsertType>>;
+    /**
+     * List all insert types
+     * @summary List insert types
+     * @param {string} project
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search for inserts by id or name
+     * @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<ListInsertTypes200Response>>;
+};
+/**
+ * InsertsTypesApi - factory interface
+ * @export
+ */
+export declare const InsertsTypesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Retrieve details for a specific insert type
+     * @summary Retrieve an insert type
+     * @param {InsertsTypesApiGetInsertTypeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInsertType(requestParameters: InsertsTypesApiGetInsertTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<InsertType>;
+    /**
+     * List all insert types
+     * @summary List insert types
+     * @param {InsertsTypesApiListInsertTypesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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 {
+    /**
+     * Retrieve details for a specific insert type
+     * @summary Retrieve an insert type
+     * @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>>;
+    /**
+     * 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<ListInsertTypes200Response, any>>;
+}