import type { EventManagementAgent } from '../models/EventManagementAgent'; import type { EventManagementAgentResponse } from '../models/EventManagementAgentResponse'; import type { EventManagementAgentsResponse } from '../models/EventManagementAgentsResponse'; import type { CancelablePromise } from '../core/CancelablePromise'; export declare class EventManagementAgentsService { /** * Get a list of EMAs * Use this API to get a list of EMAs that match the given parameters.

Token Permissions: [ `event_management_agent:read` ] * @returns EventManagementAgentsResponse The list of EMAs and the accompanying metadata. * @throws ApiError */ static getEventManagementAgents({ xContextId, pageSize, pageNumber, sort, ids, createdBy, eventManagementAgentRegionId, include, expand, }: { /** Optional context id the request is running. **/ xContextId?: string; /** The number of EMAs to get per page. **/ pageSize?: number; /** The page number to get. **/ pageNumber?: number; /** Sort based on the provided parameters.
The value can be either a standalone field name (`?sort=`) or a field and direction, delimited by a colon (`?sort=:`). If the direction is not specified, the default is ascending. **/ sort?: string; /** The IDs of the EMAs. **/ ids?: Array; /** Match only EMAs created by this user **/ createdBy?: string; /** Match only EMAs in the given EMA-Region **/ eventManagementAgentRegionId?: string; /** Specify extra data to be included, options are: referencedByMessagingServiceIds. *
Replacement: Use expand instead. *
Reason: The change is to align with the API specification design. *
Removal Date: 2024-11-03 18:00:00.000. * **/ include?: string; /** Specify extra data to be included, options are: referencedByMessagingServiceIds. **/ expand?: string; }): CancelablePromise; /** * Create an EMA object * Use this API to create an EMA object.

Token Permissions: [ `event_management_agent:write` ] * @returns EventManagementAgentResponse Created an EMA. The newly saved EMA object is returned in the response body. * @throws ApiError */ static createEventManagementAgent({ requestBody, xContextId, }: { /** The EMA object. **/ requestBody: EventManagementAgent; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Get an EMA object * Use this API to get a single EMA by its ID.

Token Permissions: [ `event_management_agent:read` ] * @returns EventManagementAgentResponse The EMA object. * @throws ApiError */ static getEventManagementAgent({ id, xContextId, include, expand, }: { /** The ID of the EMA object. **/ id: string; /** Optional context id the request is running. **/ xContextId?: string; /** Specify extra data to be included, options are: referencedByMessagingServiceIds. *
Replacement: Use expand instead. *
Reason: The change is to align with the API specification design. *
Removal Date: 2024-11-03 18:00:00.000. * **/ include?: string; /** Specify extra data to be included, options are: referencedByMessagingServiceIds. **/ expand?: string; }): CancelablePromise; /** * Delete an EMA object * Use this API to delete an EMA.

Token Permissions: [ `event_management_agent:write` ] * @returns void * @throws ApiError */ static deleteEventManagementAgent({ id, xContextId, }: { /** The ID of the EMA object. **/ id: string; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Update an EMA object * Use this API to update an EMA. You only need to specify the fields that need to be updated.

Token Permissions: [ `event_management_agent:write` ] * @returns EventManagementAgentResponse The updated EMA object. * @throws ApiError */ static updateEventManagementAgent({ id, requestBody, xContextId, }: { /** The ID of the EMA object to update. **/ id: string; /** The EMA object. **/ requestBody: EventManagementAgent; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Get the raw configs in string format for an EMA object * Use this API to get the raw configs for a single EMA by its ID.

Token Permissions: [ `event_management_agent:read` ] * @returns string The EMA config in yaml structure. * @throws ApiError */ static getEventManagementAgentConfigRaw({ id, xContextId, configFileType, }: { /** The ID of the EMA object. **/ id: string; /** Optional context id the request is running. **/ xContextId?: string; configFileType?: 'connected' | 'standalone'; }): CancelablePromise; /** * Get the raw configs in file format for an EMA object * Use this API to get the raw configs for a single EMA by its ID.

Token Permissions: [ `event_management_agent:read` ] * @returns string The EMA config in a yaml file named application.yml. * @throws ApiError */ static getEventManagementAgentConfigFile({ id, xContextId, configFileType, }: { /** The ID of the EMA object. **/ id: string; /** Optional context id the request is running. **/ xContextId?: string; configFileType?: 'connected' | 'standalone'; }): CancelablePromise; }