/**
* Elastic Email REST API
* This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available here). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository here
*
* The version of the OpenAPI document: 4.0.0
* Contact: support@elasticemail.com
*
* 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, BaseAPI } from '../base';
import type { Webhook } from '../ee-api-models';
import type { WebhookCreatePayload } from '../ee-api-models';
import type { WebhookUpdatePayload } from '../ee-api-models';
/**
* WebhookApi - axios parameter creator
* @export
*/
export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Delete the specified notifications webhook. Required Access Level: ModifyWebNotifications
* @summary Delete Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookByPublicidDelete: (publicid: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Load notifications webhook details. Required Access Level: ViewWebNotifications
* @summary Load Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookByPublicidGet: (publicid: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Update notification webhook. Required Access Level: ModifyWebNotifications
* @summary Update Webhook
* @param {string} publicid
* @param {WebhookUpdatePayload} webhookUpdatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookByPublicidPut: (publicid: string, webhookUpdatePayload: WebhookUpdatePayload, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a list of notification webhooks. Required Access Level: ViewWebNotifications
* @summary Load Webhooks
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookGet: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Add a notification webhook. Required Access Level: ModifyWebNotifications
* @summary Add Webhook
* @param {WebhookCreatePayload} webhookCreatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookPost: (webhookCreatePayload: WebhookCreatePayload, options?: RawAxiosRequestConfig) => Promise;
};
/**
* WebhookApi - functional programming interface
* @export
*/
export declare const WebhookApiFp: (configuration?: Configuration) => {
/**
* Delete the specified notifications webhook. Required Access Level: ModifyWebNotifications
* @summary Delete Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookByPublicidDelete(publicid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Load notifications webhook details. Required Access Level: ViewWebNotifications
* @summary Load Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookByPublicidGet(publicid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update notification webhook. Required Access Level: ModifyWebNotifications
* @summary Update Webhook
* @param {string} publicid
* @param {WebhookUpdatePayload} webhookUpdatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookByPublicidPut(publicid: string, webhookUpdatePayload: WebhookUpdatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a list of notification webhooks. Required Access Level: ViewWebNotifications
* @summary Load Webhooks
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Add a notification webhook. Required Access Level: ModifyWebNotifications
* @summary Add Webhook
* @param {WebhookCreatePayload} webhookCreatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookPost(webhookCreatePayload: WebhookCreatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* WebhookApi - factory interface
* @export
*/
export declare const WebhookApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Delete the specified notifications webhook. Required Access Level: ModifyWebNotifications
* @summary Delete Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookByPublicidDelete(publicid: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Load notifications webhook details. Required Access Level: ViewWebNotifications
* @summary Load Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookByPublicidGet(publicid: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update notification webhook. Required Access Level: ModifyWebNotifications
* @summary Update Webhook
* @param {string} publicid
* @param {WebhookUpdatePayload} webhookUpdatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookByPublicidPut(publicid: string, webhookUpdatePayload: WebhookUpdatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of notification webhooks. Required Access Level: ViewWebNotifications
* @summary Load Webhooks
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add a notification webhook. Required Access Level: ModifyWebNotifications
* @summary Add Webhook
* @param {WebhookCreatePayload} webhookCreatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
webhookPost(webhookCreatePayload: WebhookCreatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* WebhookApi - interface
* @export
* @interface WebhookApi
*/
export interface WebhookApiInterface {
/**
* Delete the specified notifications webhook. Required Access Level: ModifyWebNotifications
* @summary Delete Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApiInterface
*/
webhookByPublicidDelete(publicid: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Load notifications webhook details. Required Access Level: ViewWebNotifications
* @summary Load Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApiInterface
*/
webhookByPublicidGet(publicid: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update notification webhook. Required Access Level: ModifyWebNotifications
* @summary Update Webhook
* @param {string} publicid
* @param {WebhookUpdatePayload} webhookUpdatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApiInterface
*/
webhookByPublicidPut(publicid: string, webhookUpdatePayload: WebhookUpdatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of notification webhooks. Required Access Level: ViewWebNotifications
* @summary Load Webhooks
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApiInterface
*/
webhookGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add a notification webhook. Required Access Level: ModifyWebNotifications
* @summary Add Webhook
* @param {WebhookCreatePayload} webhookCreatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApiInterface
*/
webhookPost(webhookCreatePayload: WebhookCreatePayload, options?: RawAxiosRequestConfig): AxiosPromise;
}
/**
* WebhookApi - object-oriented interface
* @export
* @class WebhookApi
* @extends {BaseAPI}
*/
export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
/**
* Delete the specified notifications webhook. Required Access Level: ModifyWebNotifications
* @summary Delete Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApi
*/
webhookByPublicidDelete(publicid: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Load notifications webhook details. Required Access Level: ViewWebNotifications
* @summary Load Webhook
* @param {string} publicid
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApi
*/
webhookByPublicidGet(publicid: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Update notification webhook. Required Access Level: ModifyWebNotifications
* @summary Update Webhook
* @param {string} publicid
* @param {WebhookUpdatePayload} webhookUpdatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApi
*/
webhookByPublicidPut(publicid: string, webhookUpdatePayload: WebhookUpdatePayload, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a list of notification webhooks. Required Access Level: ViewWebNotifications
* @summary Load Webhooks
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApi
*/
webhookGet(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise>;
/**
* Add a notification webhook. Required Access Level: ModifyWebNotifications
* @summary Add Webhook
* @param {WebhookCreatePayload} webhookCreatePayload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhookApi
*/
webhookPost(webhookCreatePayload: WebhookCreatePayload, options?: RawAxiosRequestConfig): Promise>;
}