import type { MessagingService } from '../models/MessagingService';
import type { MessagingServiceOperation } from '../models/MessagingServiceOperation';
import type { MessagingServiceOperationResponse } from '../models/MessagingServiceOperationResponse';
import type { MessagingServiceRemoveAssociation } from '../models/MessagingServiceRemoveAssociation';
import type { MessagingServiceResponse } from '../models/MessagingServiceResponse';
import type { MessagingServicesResponse } from '../models/MessagingServicesResponse';
import type { CancelablePromise } from '../core/CancelablePromise';
export declare class MessagingServicesService {
/**
* Get a list of messaging services
* Use this API to get a list of messaging services that match the given parameters.
Token Permissions: [ `messaging_service:read` ]
* @returns MessagingServicesResponse The list of messaging services and the accompanying metadata.
* @throws ApiError
*/
static getMessagingServices({ xContextId, pageSize, pageNumber, sort, ids, messagingServiceType, runtimeAgentId, eventMeshId, eventManagementAgentId, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of messaging services 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 messaging services. **/
ids?: Array;
/** Match only messaging services of the given type, options are: solace, kafka. **/
messagingServiceType?: string;
/** Match only messaging services in the given runtimeAgentId **/
runtimeAgentId?: string;
/** Match only messaging services in the given eventMeshId **/
eventMeshId?: string;
eventManagementAgentId?: string;
}): CancelablePromise;
/**
* Create a messaging service
* Use this API to create a messaging service.
Token Permissions: [ `messaging_service:write` ]
* @returns MessagingServiceResponse Created a messaging service. The newly saved messaging service is returned in the response body.
* @throws ApiError
*/
static createMessagingService({ requestBody, xContextId, }: {
/** The messaging service. **/
requestBody: MessagingService;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get a messaging service
* Use this API to get a single messaging service by its ID.
Token Permissions: [ `messaging_service:read` ]
* @returns MessagingServiceResponse The messaging service.
* @throws ApiError
*/
static getMessagingService({ id, xContextId, }: {
/** The ID of the messaging service. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete a messaging service
* Use this API to delete a messaging service.
Token Permissions: [ `messaging_service:write` ]
* @returns void
* @throws ApiError
*/
static deleteMessagingService({ id, xContextId, }: {
/** The ID of the messaging service. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update a messaging service
* Use this API to update a messaging service. You only need to specify the fields that need to be updated. However, if you want to update anything under subObjects (i.e. anything inside messagingServiceConnections object), you need to provide the original messagingServiceConnections with the updated fields instead of just providing the changed fields.
Token Permissions: [ `messaging_service:write` ]
* @returns MessagingServiceResponse The updated messaging service.
* @throws ApiError
*/
static updateMessagingService({ id, requestBody, xContextId, }: {
/** The ID of the messaging service to update. **/
id: string;
/** The messaging service. **/
requestBody: MessagingService;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Remove an association between an messaging service and the requested entity
* Use this API to remove the association between a messaging service and either of EVENT_MESH or EVENT_MANAGEMENT_AGENT.
Token Permissions: [ `messaging_service:write` ]
* @returns MessagingServiceResponse The updated messaging service, e.g. if the API request body had "association": "EVENT_MESH" then the resulting object would not have eventMeshId attribute.
* @throws ApiError
*/
static removeAssociationMessagingService({ id, requestBody, xContextId, }: {
/** The ID of the messaging service. **/
id: string;
/** The association object with the value matching either EVENT_MESH or EVENT_MANAGEMENT_AGENT. **/
requestBody: MessagingServiceRemoveAssociation;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Initiate a scan request to run against a messaging service
* Use this API to make a scan request on a messaging service.
Token Permissions: [ `messaging_service:write` ]
* @returns MessagingServiceOperationResponse Requested a scan on the messaging service. The operation object with ID set as ID of the created scan Object is returned in the response body.
* @throws ApiError
*/
static scanStartMessagingService({ messagingServiceId, requestBody, xContextId, }: {
/** The ID of the messaging service. **/
messagingServiceId: string;
/** The messaging service. **/
requestBody: MessagingServiceOperation;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
}