import type { Event } from '../models/Event';
import type { EventResponse } from '../models/EventResponse';
import type { EventsResponse } from '../models/EventsResponse';
import type { EventVersion } from '../models/EventVersion';
import type { EventVersionResponse } from '../models/EventVersionResponse';
import type { EventVersionsResponse } from '../models/EventVersionsResponse';
import type { MessagingServiceAssociationDTO } from '../models/MessagingServiceAssociationDTO';
import type { MessagingServiceAssociationResponse } from '../models/MessagingServiceAssociationResponse';
import type { StateChangeRequestResponse } from '../models/StateChangeRequestResponse';
import type { VersionedObjectStateChangeRequest } from '../models/VersionedObjectStateChangeRequest';
import type { CancelablePromise } from '../core/CancelablePromise';
export declare class EventsService {
/**
* Get a list of events
* Use this API to get a list of events that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns EventsResponse Get a list of events and the accompanying metadata.
* @throws ApiError
*/
static getEvents({ xContextId, pageSize, pageNumber, name, shared, brokerType, applicationDomainId, applicationDomainIds, sort, customAttributes, ids, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of events to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** Name of the event to match on. **/
name?: string;
/** Match only with shared or unshared events. **/
shared?: boolean;
/** Match only events with the given broker type **/
brokerType?: string;
/** Match only events in the given application domain. **/
applicationDomainId?: string;
/** Match only events in the given application domain ids. **/
applicationDomainIds?: Array;
/** 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;
/** Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\-\. ]`. **/
customAttributes?: string;
/** Match only events with the given IDs separated by commas. **/
ids?: Array;
}): CancelablePromise;
/**
* Create an event
* Events are the primary building block of an event-driven architecture. Applications publish and subscribe to events and events reference schemas. In the Event Portal, an event is a type of event as opposed to a specific event instance.
Token Permissions: [ `event:create:*` ]
* @returns EventResponse Created an event. The newly saved event is returned in the response body.
* @throws ApiError
*/
static createEvent({ requestBody, xContextId, }: {
/** The event requires a name and an application domain ID. **/
requestBody: Event;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an event
* Use this API to get a single event by its ID.
Token Permissions: [ `event:get:*` ]
* @returns EventResponse The event.
* @throws ApiError
*/
static getEvent({ id, xContextId, }: {
/** The ID of the event. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete an event
* Use this API to delete an event.
Token Permissions: [ `event:delete:*` ]
* @returns void
* @throws ApiError
*/
static deleteEvent({ id, xContextId, }: {
/** The ID of the event. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an event
* Use this API to update an event. You only need to specify the fields that need to be updated.
Token Permissions: [ `event:update:*` ]
* @returns EventResponse The updated event.
* @throws ApiError
*/
static updateEvent({ id, requestBody, xContextId, }: {
/** The ID of the event to update. **/
id: string;
/** The event. **/
requestBody: Event;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get a list of event versions
* Use this API to get a list of event versions that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns EventVersionsResponse Get a list of event versions and the accompanying metadata.
* @throws ApiError
*/
static getEventVersions({ xContextId, pageSize, pageNumber, eventIds, ids, messagingServiceIds, customAttributes, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of event versions to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** Match only event versions of these event IDs, separated by commas. **/
eventIds?: Array;
/** Match only event versions with the given IDs, separated by commas. **/
ids?: Array;
/** Match only event versions with the given messaging service IDs, separated by commas. **/
messagingServiceIds?: Array;
/** Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\-\. ]`. **/
customAttributes?: string;
}): CancelablePromise;
/**
* Create an event version
* Create an event version
Token Permissions: [ `event:update:*` ]
* @returns EventVersionResponse Created an event version. Returns the newly saved event version in the response body.
* @throws ApiError
*/
static createEventVersion({ requestBody, xContextId, }: {
/** App version request body description **/
requestBody: EventVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an event version
* Use this API to get a single event version by its ID.
Token Permissions: [ `event:get:*` ]
* @returns EventVersionResponse The event version.
* @throws ApiError
*/
static getEventVersion({ id, xContextId, }: {
/** The ID of the event version. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete an event version
* Use this API to delete an event version.
Token Permissions: [ `event:update:*` ]
* @returns void
* @throws ApiError
*/
static deleteEventVersion({ id, xContextId, }: {
/** The ID of the event version **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an event version
* Use this API to update an event version. You only need to specify the fields that need to be updated.
Token Permissions: [ `event:update:*` ]
* @returns EventVersionResponse The updated event version.
* @throws ApiError
*/
static updateEventVersion({ id, requestBody, xContextId, }: {
/** The ID of the event version to update. **/
id: string;
/** The event version. **/
requestBody: EventVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update the state of an event version
* Use this API to update the state of event version. You only need to specify the target stateId field
Token Permissions: [ `event:update_state:*` ]
* @returns StateChangeRequestResponse The updated state of the event version.
* @throws ApiError
*/
static updateEventVersionState({ id, requestBody, xContextId, }: {
/** The ID of the event version to update. **/
id: string;
/** The state object. **/
requestBody: VersionedObjectStateChangeRequest;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Get a list of event versions for an event
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to get a list of event versions that match the given parameters.
* @returns EventVersionsResponse Get a list of event versions.
* @throws ApiError
*/
static getEventVersionsForEvent({ eventId, xContextId, customAttributes, displayName, ids, version, }: {
/** The ID of the parent event. **/
eventId: string;
/** Optional context id the request is running. **/
xContextId?: string;
/** Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\-\. ]`. **/
customAttributes?: string;
/** Match event versions with the given display name. **/
displayName?: string;
/** Match event versions with the given IDs separated by commas. **/
ids?: Array;
/** Match event versions with the given version. **/
version?: string;
}): CancelablePromise;
/**
* @deprecated
* Create an event version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Create an event version
* @returns EventVersionResponse Created an event version. Returns the newly saved event version in the response body.
* @throws ApiError
*/
static createEventVersionForEvent({ eventId, requestBody, xContextId, }: {
/** The ID of the parent event **/
eventId: string;
/** App version request body description **/
requestBody: EventVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Get an event version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to get a single event version by its ID.
* @returns EventVersionResponse The event version.
* @throws ApiError
*/
static getEventVersionForEvent({ eventId, id, xContextId, }: {
/** The ID of the parent event. **/
eventId: string;
/** The ID of the event version. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Delete an event version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to delete an event version.
* @returns void
* @throws ApiError
*/
static deleteEventVersionForEvent({ eventId, id, xContextId, }: {
/** The ID of the parent event **/
eventId: string;
/** The ID of the event version **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Update an event version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to update an event version. You only need to specify the fields that need to be updated.
* @returns EventVersionResponse The updated event version.
* @throws ApiError
*/
static updateEventVersionForEvent({ eventId, id, requestBody, xContextId, }: {
/** The ID of the parent event. **/
eventId: string;
/** The ID of the event version to update. **/
id: string;
/** The event version. **/
requestBody: EventVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Replace messaging service association for an event version
* Use this API to replace the messaging service association for an event version.
Token Permissions: [ `event_runtime:write` ]
* @returns MessagingServiceAssociationResponse The updated messaging service associations.
* @throws ApiError
*/
static updateMsgSvcAssociationForEventVersion({ id, requestBody, xContextId, }: {
/** The ID of the event version **/
id: string;
/** The messaging service association object **/
requestBody: MessagingServiceAssociationDTO;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Update the state of an event version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to update the state of event version. You only need to specify the target stateId field
* @returns VersionedObjectStateChangeRequest The updated state of the event version.
* @throws ApiError
*/
static updateEventVersionStateForEvent({ eventId, id, requestBody, xContextId, }: {
/** The ID of the parent event. **/
eventId: string;
/** The ID of the event version to update. **/
id: string;
/** The event version. **/
requestBody: EventVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
}