import type { Application } from '../models/Application';
import type { ApplicationResponse } from '../models/ApplicationResponse';
import type { ApplicationsResponse } from '../models/ApplicationsResponse';
import type { ApplicationVersion } from '../models/ApplicationVersion';
import type { ApplicationVersionResponse } from '../models/ApplicationVersionResponse';
import type { ApplicationVersionsResponse } from '../models/ApplicationVersionsResponse';
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 ApplicationsService {
/**
* Get a list of applications
* Use this API to get a list of applications that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns ApplicationsResponse Get a list of applications and the accompanying metadata.
* @throws ApiError
*/
static getApplications({ xContextId, pageSize, pageNumber, name, applicationDomainId, ids, sort, customAttributes, applicationType, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of applications to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** Name of the application to match on. **/
name?: string;
/** Match only applications in the given application domain. **/
applicationDomainId?: string;
/** Match only applications with the given IDs separated by commas. **/
ids?: 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 applications with the given applicationType. **/
applicationType?: string;
}): CancelablePromise;
/**
* Create an application
* To model your event-driven architecture, applications are a fundamental building block for modelling the producers and consumers of events. Use this API to create applications and model the events they produce and consume.
Token Permissions: [ `application:create:*` ]
* @returns ApplicationResponse Created an application. Returns the newly saved application in the response body.
* @throws ApiError
*/
static createApplication({ requestBody, xContextId, }: {
/** Applications have a name and live within an application domain. Events can be added to the application as produced or consumed. **/
requestBody: Application;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an application
* Use this API to get a single application by its ID.
Token Permissions: [ `application:get:*` ]
* @returns ApplicationResponse The application.
* @throws ApiError
*/
static getApplication({ id, xContextId, }: {
/** The ID of the application. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete an application
* Use this API to delete an application.
Token Permissions: [ `application:delete:*` ]
* @returns void
* @throws ApiError
*/
static deleteApplication({ id, xContextId, }: {
/** The ID of the application **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an application
* Use this API to update an application. You only need to specify the fields that need to be updated.
Token Permissions: [ `application:update:*` ]
* @returns ApplicationResponse The updated application.
* @throws ApiError
*/
static updateApplication({ id, requestBody, xContextId, }: {
/** The ID of the application to update. **/
id: string;
/** The application. **/
requestBody: Application;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get a list of application versions
* Use this API to get a list of application versions that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns ApplicationVersionsResponse Get a list of application versions and the accompanying metadata.
* @throws ApiError
*/
static getApplicationVersions({ xContextId, pageSize, pageNumber, applicationIds, ids, messagingServiceIds, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of application versions to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** Match only application versions of these application IDs, separated by commas. **/
applicationIds?: Array;
/** Match only application versions with the given IDs, separated by commas. **/
ids?: Array;
/** Match only application versions with the given messaging service IDs, separated by commas. **/
messagingServiceIds?: Array;
}): CancelablePromise;
/**
* Create an application version
* Create an application version
Token Permissions: [ `application:update:*` ]
* @returns ApplicationVersionResponse Created an application version. Returns the newly saved application version in the response body.
* @throws ApiError
*/
static createApplicationVersion({ requestBody, xContextId, }: {
/** App version request body description **/
requestBody: ApplicationVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an application version
* Use this API to get a single application version by its ID.
Token Permissions: [ `application:get:*` ]
* @returns ApplicationVersionResponse The application version.
* @throws ApiError
*/
static getApplicationVersion({ versionId, xContextId, }: {
/** The ID of the application version. **/
versionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete an application version
* Use this API to delete an application version.
Token Permissions: [ `application:update:*` ]
* @returns void
* @throws ApiError
*/
static deleteApplicationVersion({ versionId, xContextId, }: {
/** The ID of the application version **/
versionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an application version
* Use this API to update an application version. You only need to specify the fields that need to be updated.
Token Permissions: [ `application:update:*` ]
* @returns ApplicationVersionResponse The updated application version.
* @throws ApiError
*/
static updateApplicationVersion({ versionId, requestBody, xContextId, include, relationsBrokerType, }: {
/** The ID of the application version to update. **/
versionId: string;
/** The application version. **/
requestBody: ApplicationVersion;
/** Optional context id the request is running. **/
xContextId?: string;
include?: Array;
relationsBrokerType?: string;
}): CancelablePromise;
/**
* Update the state of an application version
* Use this API to update the state of an application version. You only need to specify the target stateId field.
Token Permissions: [ `application:update_state:*` ]
* @returns StateChangeRequestResponse The updated state of the application version.
* @throws ApiError
*/
static updateApplicationVersionState({ versionId, requestBody, xContextId, }: {
/** The ID of the application version to update. **/
versionId: string;
/** The state change object. **/
requestBody: VersionedObjectStateChangeRequest;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Replace messaging service association for an application version
* Use this API to replace the messaging service association for an application version.
Token Permissions: [ `event_runtime:write` ]
* @returns MessagingServiceAssociationResponse The updated messaging service associations.
* @throws ApiError
*/
static updateMsgSvcAssociationForAppVersion({ versionId, requestBody, xContextId, }: {
/** The ID of the application version **/
versionId: string;
/** The messaging service association object **/
requestBody: MessagingServiceAssociationDTO;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get the AsyncAPI specification for an application version
* Use this API to get the AsyncAPI specification for an application version annotated with Event Portal metadata.
Token Permissions: [ `application:generate_async_api:*` ]
* @returns string The AsyncAPI specification for the application version.
* @throws ApiError
*/
static getAsyncApiForApplicationVersion({ applicationVersionId, xContextId, format, showVersioning, includedExtensions, asyncApiVersion, environmentOptions, messagingServiceId, }: {
/** The ID of the application version. **/
applicationVersionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
/** The format in which to get the AsyncAPI specification. Possible values are yaml and json. **/
format?: 'json' | 'yaml';
/** Include versions in each AsyncAPI object's name when only one version is present **/
showVersioning?: boolean;
/** The event portal database keys to include for each AsyncAPI object. **/
includedExtensions?: 'all' | 'parent' | 'version' | 'none';
/** The version of AsyncAPI to use. **/
asyncApiVersion?: '2.0.0' | '2.2.0' | '2.5.0';
/** Determines whether bindings are applied to declared consumed events or published consumed events in the event mesh or both. **/
environmentOptions?: 'include_declared_and_attracted_events' | 'include_attracted_events_only';
/** Applies bindings from consumed events that are published in this messaging service's modeled event mesh. **/
messagingServiceId?: string;
}): CancelablePromise;
}