import type { EventApi } from '../models/EventApi';
import type { EventApiResponse } from '../models/EventApiResponse';
import type { EventApisResponse } from '../models/EventApisResponse';
import type { EventApiVersion } from '../models/EventApiVersion';
import type { EventApiVersionResponse } from '../models/EventApiVersionResponse';
import type { EventApiVersionsResponse } from '../models/EventApiVersionsResponse';
import type { StateChangeRequestResponse } from '../models/StateChangeRequestResponse';
import type { VersionedObjectStateChangeRequest } from '../models/VersionedObjectStateChangeRequest';
import type { CancelablePromise } from '../core/CancelablePromise';
export declare class EventApIsService {
/**
* Get a List of Event APIs
* Use this API to get a list of event APIs that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns EventApisResponse Get a list of event APIs and the accompanying metadata.
* @throws ApiError
*/
static getEventApis({ xContextId, pageSize, pageNumber, name, ids, applicationDomainId, applicationDomainIds, eventApiVersionIds, availableWithinApplicationDomainIds, shared, brokerType, sort, customAttributes, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of event APIs to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** Name of the event API to match on. **/
name?: string;
/** Match only event APIs with the given IDs separated by commas. **/
ids?: Array;
/** Match only event APIs in the given application domain. **/
applicationDomainId?: string;
/** Match only event APIs in the given application domains. **/
applicationDomainIds?: Array;
/** Match only event APIs in the given event API version ids. **/
eventApiVersionIds?: Array;
/** Additionally match any shared event APIs in any application domain. **/
availableWithinApplicationDomainIds?: boolean;
/** Match only with shared or unshared event APIs. **/
shared?: boolean;
/** Match only event APIs with the given broker type. **/
brokerType?: string;
/** 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;
}): CancelablePromise;
/**
* Create an Event API
* Use this API to create an event API.
Token Permissions: [ `event_api:create:*` ]
* @returns EventApiResponse Created an event API. The newly saved event API is returned in the response body.
* @throws ApiError
*/
static createEventApi({ requestBody, xContextId, }: {
/** The event API. **/
requestBody: EventApi;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an Event API
* Use this API to get a single event API by its ID.
Token Permissions: [ `event_api:get:*` ]
* @returns EventApiResponse The event API.
* @throws ApiError
*/
static getEventApi({ id, xContextId, }: {
/** The ID of the event API. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete an Event API
* Use this API to delete an event API.
Token Permissions: [ `event_api:delete:*` ]
* @returns void
* @throws ApiError
*/
static deleteEventApi({ id, xContextId, }: {
/** The ID of the event API. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an Event API
* Use this API to update an event API. You only need to specify the fields that need to be updated.
Token Permissions: [ `event_api:update:*` ]
* @returns EventApiResponse The updated event API.
* @throws ApiError
*/
static updateEventApi({ id, requestBody, xContextId, }: {
/** The ID of the event API to update. **/
id: string;
/** The event API. **/
requestBody: EventApi;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get a List of Event API Versions
* Use this API to get a list of event API versions that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns EventApiVersionsResponse Get a list of event API versions.
* @throws ApiError
*/
static getEventApiVersions({ xContextId, pageSize, pageNumber, eventApiIds, ids, include, stateId, customAttributes, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of results to return in one page of results. **/
pageSize?: number;
/** The page number to get results from based on the page size. **/
pageNumber?: number;
/** Match only event API versions of these event API IDs, separated by commas. **/
eventApiIds?: Array;
/** Match event API versions with the given IDs, separated by commas. **/
ids?: Array;
/** A list of additional entities to include in the response. **/
include?: string;
/** Match event API versions with the given state ID. **/
stateId?: 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;
}): CancelablePromise;
/**
* Create an Event API Version
* Use this API to create an event API version.
Token Permissions: [ `event_api:update:*` ]
* @returns EventApiVersionResponse Created an event API version. Returns the newly saved event API version in the response body.
* @throws ApiError
*/
static createEventApiVersion({ requestBody, xContextId, }: {
/** Event API version. **/
requestBody: EventApiVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an Event API Version
* Use this API to get a single event API version by its ID.
Token Permissions: [ `event_api:get:*` ]
* @returns EventApiVersionResponse The event API version.
* @throws ApiError
*/
static getEventApiVersion({ versionId, xContextId, include, }: {
/** The ID of the event API version. **/
versionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
/** A list of additional entities to include in the response. **/
include?: string;
}): CancelablePromise;
/**
* Delete an Event API Version
* Use this API to delete an event API version by event API version ID.
Token Permissions: [ `event_api:update:*` ]
* @returns void
* @throws ApiError
*/
static deleteEventApiVersion({ versionId, xContextId, }: {
/** The ID of the event API version. **/
versionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an Event API by Event API Version ID
* Use this API to update an event API version by event API version ID.You only need to specify the fields that need to be updated.
Token Permissions: [ `event_api:update:*` ]
* @returns EventApiVersionResponse The updated event API version.
* @throws ApiError
*/
static updateEventApiVersion({ versionId, requestBody, xContextId, }: {
/** The ID of the event API version. **/
versionId: string;
/** The event API version. **/
requestBody: EventApiVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Get a List of Event API Versions
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to get a list of event API versions under a particular event API matching the given parameters.
* @returns EventApiVersionsResponse Get a list of event API versions.
* @throws ApiError
*/
static getEventApiVersionsForEventApi({ eventApiId, id, xContextId, displayName, ids, version, stateId, customAttributes, }: {
/** The ID of the parent event API. **/
eventApiId: string;
/** The ID of the event API version. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
/** Match event API versions with the given display name. **/
displayName?: string;
/** Match event API versions with the given IDs separated by commas. **/
ids?: Array;
/** Match event API versions with the given version. **/
version?: string;
/** Match event API versions with the given state ID. **/
stateId?: 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;
}): CancelablePromise;
/**
* @deprecated
* Create an Event API Version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to create an event API version.
* @returns EventApiVersionResponse Created an event API version. Returns the newly saved event API version in the response body.
* @throws ApiError
*/
static createEventApiVersionForEventApi({ eventApiId, requestBody, xContextId, }: {
/** The ID of the parent event API. **/
eventApiId: string;
/** Event API version. **/
requestBody: EventApiVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update the State of an Event API Version by Event API Version ID
* Use this API to update the state of an event API version. You only need to specify the state ID field with the desired state ID.
Token Permissions: [ `event_api:update_state:*` ]
* @returns StateChangeRequestResponse The updated state of the event API version.
* @throws ApiError
*/
static updateEventApiVersionState({ versionId, requestBody, xContextId, }: {
/** The ID of the event API version. **/
versionId: string;
/** The Event API version. **/
requestBody: EventApiVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Get an Event API Version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to get a single event API version using the parent ID and the version's ID.
* @returns EventApiVersionResponse The event API version.
* @throws ApiError
*/
static getEventApiVersionForEventApi({ eventApiId, id, xContextId, }: {
/** The ID of the parent event API. **/
eventApiId: string;
/** The ID of the event API version. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Delete an Event API Version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to delete an event API version.
* @returns void
* @throws ApiError
*/
static deleteEventApiVersionForEventApi({ eventApiId, id, xContextId, }: {
/** The ID of the parent event API. **/
eventApiId: string;
/** The ID of the event API version. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Update an Event API Version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to update an event API version. You only need to specify the fields that need to be updated.
* @returns EventApiVersionResponse The updated event API version.
* @throws ApiError
*/
static updateEventApiVersionForEventApi({ eventApiId, id, requestBody, xContextId, }: {
/** The ID of the parent event API. **/
eventApiId: string;
/** The ID of the event API version to update. **/
id: string;
/** The event API version. **/
requestBody: EventApiVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Update the State of an Event API Version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to update the state of an event API version. You only need to specify the state ID field with the desired state ID.
* @returns VersionedObjectStateChangeRequest The updated state of the event API version.
* @throws ApiError
*/
static updateEventApiVersionStateForEventApi({ eventApiId, id, requestBody, xContextId, }: {
/** The ID of the parent event API. **/
eventApiId: string;
/** The ID of the event API version to update. **/
id: string;
/** The event API version. **/
requestBody: EventApiVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* @deprecated
* Get the AsyncAPI Specification for an Event API Version
* *Deprecation Date: 2022-11-01
Removal Date: 2023-12-01
Reason: Replaced by another endpoint.
*Use this API to get the AsyncAPI specification for an event API version using the parent ID and the version's ID.
* @returns string The AsyncAPI specification for the event API version.
* @throws ApiError
*/
static getEventApiVersionAsyncApiForEventApi({ eventApiId, id, xContextId, showVersioning, includedExtensions, format, version, eventApiProductVersionId, planId, gatewayMessagingServiceIds, }: {
/** The ID of the parent event API. **/
eventApiId: string;
/** The ID of the event API version. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
/** 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 format in which to get the AsyncAPI specification. Possible values are yaml and json. **/
format?: 'json' | 'yaml';
/** The version of AsyncAPI to use. **/
version?: '2.0.0' | '2.2.0' | '2.5.0';
/** The ID of the event API Product Version to use for generating bindings. **/
eventApiProductVersionId?: string;
/** The ID of the plan to use for generating bindings. **/
planId?: string;
/** The list IDs of gateway messaging services for generating bindings. **/
gatewayMessagingServiceIds?: Array;
}): CancelablePromise;
/**
* Get the AsyncAPI Specification for an Event API Version
* Use this API to get the AsyncAPI specification for an event API version annotated with Event Portal metadata.
Token Permissions: [ `event_api:generate_async_api:*` ]
* @returns string The AsyncAPI specification for the event API version.
* @throws ApiError
*/
static getAsyncApiForEventApiVersion({ eventApiVersionId, xContextId, showVersioning, format, includedExtensions, asyncApiVersion, eventApiProductVersionId, planId, gatewayMessagingServiceIds, }: {
/** The ID of the event API version. **/
eventApiVersionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
/** Include versions in each AsyncAPI object's name when only one version is present **/
showVersioning?: boolean;
/** The format in which to get the AsyncAPI specification. Possible values are yaml and json. **/
format?: 'json' | 'yaml';
/** 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';
/** The ID of the event API Product Version to use for generating bindings. **/
eventApiProductVersionId?: string;
/** The ID of the plan to use for generating bindings. **/
planId?: string;
/** The list IDs of gateway messaging services for generating bindings. **/
gatewayMessagingServiceIds?: Array;
}): CancelablePromise;
}