import type { StateChangeRequestResponse } from '../models/StateChangeRequestResponse';
import type { TopicAddressEnum } from '../models/TopicAddressEnum';
import type { TopicAddressEnumResponse } from '../models/TopicAddressEnumResponse';
import type { TopicAddressEnumsResponse } from '../models/TopicAddressEnumsResponse';
import type { TopicAddressEnumVersion } from '../models/TopicAddressEnumVersion';
import type { TopicAddressEnumVersionResponse } from '../models/TopicAddressEnumVersionResponse';
import type { TopicAddressEnumVersionsResponse } from '../models/TopicAddressEnumVersionsResponse';
import type { VersionedObjectStateChangeRequest } from '../models/VersionedObjectStateChangeRequest';
import type { CancelablePromise } from '../core/CancelablePromise';
export declare class EnumsService {
/**
* Get a list of enumerations
* Use this API to get a list of enumerations based on certain criteria.
Token Permissions: [ `event_designer:access` ]
* @returns TopicAddressEnumsResponse Get a list of enumerations and the accompanying metadata.
* @throws ApiError
*/
static getEnums({ xContextId, pageSize, pageNumber, ids, applicationDomainId, applicationDomainIds, names, shared, sort, customAttributes, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of enumerations to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** The IDs of the enumerations. **/
ids?: Array;
/** The application domain ID of the enumerations. **/
applicationDomainId?: string;
/** Match only enumerations in the given application domain ids. **/
applicationDomainIds?: Array;
/** The names of the enumerations. **/
names?: Array;
/** Match only with shared or unshared enumerations. **/
shared?: boolean;
/** 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 enumeration
* An enumeration is a bounded variable with a limited set of literal values. Use this API to create an enumeration to define acceptable values for a level in a topic address or topic domain.
Token Permissions: [ `ep_enum:create:*` ]
* @returns TopicAddressEnumResponse Created an enumeration. The newly saved enumeration is returned in the response body.
* @throws ApiError
*/
static createEnum({ requestBody, xContextId, }: {
/** Enumeration description. **/
requestBody: TopicAddressEnum;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an enumeration
* Use this API to get a single enumeration by its ID.
Token Permissions: [ `ep_enum:get:*` ]
* @returns TopicAddressEnumResponse The enumeration.
* @throws ApiError
*/
static getEnum({ id, xContextId, }: {
/** The ID of the enumeration. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete an enumeration
* Use this API to delete an enumeration. The enumeration must not have any versions or else it cannot be deleted.
Token Permissions: [ `ep_enum:delete:*` ]
* @returns void
* @throws ApiError
*/
static deleteEnum({ id, xContextId, }: {
/** The ID of the enumeration. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an enumeration
* Use this API to update an enumeration object. You only need to specify the fields that need to be updated.
Token Permissions: [ `ep_enum:update:*` ]
* @returns TopicAddressEnumResponse Updated an enumeration. The newly saved enumeration is returned in the response body.
* @throws ApiError
*/
static updateEnum({ id, requestBody, xContextId, }: {
/** The ID of the enumeration. **/
id: string;
/** Enumeration updates. **/
requestBody: TopicAddressEnum;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get a list of enumeration versions
* Use this API to get a list of enumeration versions that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns TopicAddressEnumVersionsResponse Get a list of enumeration versions and the accompanying metadata.
* @throws ApiError
*/
static getEnumVersions({ xContextId, pageSize, pageNumber, enumIds, ids, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of enumeration versions to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** Match only enumeration versions of these enumeration IDs, separated by commas. **/
enumIds?: Array;
/** Match only enumeration versions with the given IDs, separated by commas. **/
ids?: Array;
}): CancelablePromise;
/**
* Create an enumeration version
* Create an enumeration version.
Token Permissions: [ `ep_enum:update:*` ]
* @returns TopicAddressEnumVersionResponse Created an enumeration version and its values. The newly saved enumeration version is returned in the response body.
* @throws ApiError
*/
static createEnumVersion({ requestBody, xContextId, }: {
/** Enumeration version description with its values. **/
requestBody: TopicAddressEnumVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete an enumeration version
* Use this API to delete an enumeration version. The version must not be in use by any events else it cannot be deleted. This also deletes the version's values.
Token Permissions: [ `ep_enum:update:*` ]
* @returns void
* @throws ApiError
*/
static deleteEnumVersion({ id, xContextId, }: {
/** The ID of the enumeration version. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an enumeration version
* Use this API to update an enumeration version. You only need to specify the fields that need to be updated.
Token Permissions: [ `ep_enum:update:*` ]
* @returns TopicAddressEnumVersionResponse The updated enumeration version.
* @throws ApiError
*/
static updateEnumVersion({ id, requestBody, xContextId, }: {
/** The ID of the enumeration version to update. **/
id: string;
/** The enumeration version. **/
requestBody: TopicAddressEnumVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update the state of an enumeration version
* Use this API to update the state of an enumeration version. You only need to specify the target stateId field.
Token Permissions: [ `ep_enum:update_state:*` ]
* @returns StateChangeRequestResponse The updated state of the enumeration version.
* @throws ApiError
*/
static updateEnumVersionState({ id, requestBody, xContextId, }: {
/** The ID of the enumeration version to update. **/
id: string;
/** The state object. **/
requestBody: VersionedObjectStateChangeRequest;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an enumeration version
* Use this API to get a single enumeration version by its ID.
Token Permissions: [ `ep_enum:get:*` ]
* @returns TopicAddressEnumVersionResponse The enumeration version.
* @throws ApiError
*/
static getEnumVersion({ versionId, xContextId, }: {
/** The ID of the enumeration version. **/
versionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
}