import type { EventApiProduct } from '../models/EventApiProduct';
import type { EventApiProductResponse } from '../models/EventApiProductResponse';
import type { EventApiProductsResponse } from '../models/EventApiProductsResponse';
import type { EventApiProductVersion } from '../models/EventApiProductVersion';
import type { EventApiProductVersionResponse } from '../models/EventApiProductVersionResponse';
import type { EventApiProductVersionsResponse } from '../models/EventApiProductVersionsResponse';
import type { GatewayMessagingService } from '../models/GatewayMessagingService';
import type { GatewayMessagingServiceResponse } from '../models/GatewayMessagingServiceResponse';
import type { StateChangeRequestResponse } from '../models/StateChangeRequestResponse';
import type { CancelablePromise } from '../core/CancelablePromise';
export declare class EventApiProductsService {
/**
* Get a List of Event API Products
* Use this API to get a list of Event API Products that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns EventApiProductsResponse The list of Event API Products and the accompanying metadata.
* @throws ApiError
*/
static getEventApiProducts({ xContextId, pageSize, pageNumber, brokerType, name, ids, applicationDomainId, applicationDomainIds, shared, sort, customAttributes, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of Event API Products to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** Match only Event API Products with the given broken type. **/
brokerType?: string;
/** Name of the Event API Product to match on. **/
name?: string;
/** Match only Event API Products with the given IDs separated by commas. **/
ids?: Array;
/** Match only Event API Products in the given application domain. **/
applicationDomainId?: string;
/** Match only Event API Products in the given application domains. **/
applicationDomainIds?: Array;
/** Match only with shared or unshared Event API Products. **/
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 Event API Product
* Use this API to create an Event API Product.
Token Permissions: [ `event_api_product:create:*` ]
* @returns EventApiProductResponse Created an Event API Product. The newly saved Event API Product is returned in the response body.
* @throws ApiError
*/
static createEventApiProduct({ requestBody, xContextId, }: {
/** The Event API Product. **/
requestBody: EventApiProduct;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an Event API Product
* Use this API to get a single Event API Product by its ID.
Token Permissions: [ `event_api_product:get:*` ]
* @returns EventApiProductResponse The Event API Product.
* @throws ApiError
*/
static getEventApiProduct({ id, xContextId, }: {
/** The ID of the Event API Product. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete an Event API Product
* Use this API to delete an Event API Product.
Token Permissions: [ `event_api_product:delete:*` ]
* @returns void
* @throws ApiError
*/
static deleteEventApiProduct({ id, xContextId, }: {
/** The ID of the Event API Product. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an Event API Product
* Use this API to update an Event API Product. You only need to specify the fields that need to be updated.
Token Permissions: [ `event_api_product:update:*` ]
* @returns EventApiProductResponse The updated Event API Product.
* @throws ApiError
*/
static updateEventApiProduct({ id, requestBody, xContextId, }: {
/** The ID of the Event API Product to update. **/
id: string;
/** The Event API Product. **/
requestBody: EventApiProduct;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* (Beta) Get a List of Event API Product Versions
* Use this API to get a list of Event API Product versions that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns EventApiProductVersionsResponse Get a list of Event API Product versions.
* @throws ApiError
*/
static getEventApiProductVersions({ xContextId, pageSize, pageNumber, eventApiProductIds, ids, include, stateId, messagingServiceId, clientAppId, shared, latest, 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 Product versions of these Event API Product IDs, separated by commas. **/
eventApiProductIds?: Array;
/** Match Event API Product 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 Product versions with the given state ID. **/
stateId?: string;
/** Match Event API Product versions with the given messagingServiceId. **/
messagingServiceId?: string;
/** Match Event API Product versions with the given clientAppId. **/
clientAppId?: string;
/** Match Event API Product versions with the parent objects shared setting. **/
shared?: boolean;
/** Only return the latest version of Event API Products. **/
latest?: boolean;
/** 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;
/**
* (Beta) Create an Event API Product Version
* Use this API to create an Event API Product version.
Token Permissions: [ `event_api_product:update:*` ]
* @returns EventApiProductVersionResponse Created an Event API Product version. Returns the newly saved Event API Product version in the response body.
* @throws ApiError
*/
static createEventApiProductVersion({ requestBody, xContextId, }: {
/** Event API Product version. **/
requestBody: EventApiProductVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* (Beta) Get an Event API Product Version
* Use this API to get a single Event API Product version by its ID.
Token Permissions: [ `event_api_product:get:*` ]
* @returns EventApiProductVersionResponse The Event API Product version.
* @throws ApiError
*/
static getEventApiProductVersion({ versionId, xContextId, include, clientAppId, }: {
/** The ID of the Event API Product version. **/
versionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
/** A list of additional entities to include in the response. **/
include?: string;
/** Match Event API Product versions with the given clientAppId. **/
clientAppId?: string;
}): CancelablePromise;
/**
* (Beta) Delete an Event API Product Version by ID
* Use this API to delete an Event API Product version by ID.
Token Permissions: [ `event_api_product:update:*` ]
* @returns void
* @throws ApiError
*/
static deleteEventApiProductVersion({ versionId, xContextId, }: {
/** The ID of the Event API Product version. **/
versionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* (Beta) Update an Event API Product Version by Version ID
* Use this API to update an Event API Product version. You only need to specify the fields that need to be updated.
Token Permissions: [ `event_api_product:update:*` ]
* @returns EventApiProductVersionResponse The updated Event API Product version.
* @throws ApiError
*/
static updateEventApiProductVersion({ versionId, requestBody, xContextId, }: {
/** The ID of the Event API Product version. **/
versionId: string;
/** The Event API Product version. **/
requestBody: EventApiProductVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update the State of an Event API Product Version by ID
* Use this API to update the state of an Event API Product version. You only need to specify the state ID field with the desired state ID.
Token Permissions: [ `event_api_product:update_state:*` ]
* @returns StateChangeRequestResponse The updated state of the Event API Product version.
* @throws ApiError
*/
static updateEventApiProductVersionState({ versionId, requestBody, xContextId, }: {
/** The ID of the Event API Product version. **/
versionId: string;
/** The Event API Product version. **/
requestBody: EventApiProductVersion;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an Event API Product Version To Be Published
* Use this API to publish Event API Product version. Cannot unset once it is published.
Token Permissions: [ `event_api_product:update_state:*` ]
* @returns StateChangeRequestResponse Updated the state of the Event API Product version to Published.
* @throws ApiError
*/
static publishEventApiProductVersion({ versionId, xContextId, requestBody, }: {
/** The ID of the Event API Product version. **/
versionId: string;
/** Optional context id the request is running. **/
xContextId?: string;
/** The Event API Product version. **/
requestBody?: EventApiProductVersion;
}): CancelablePromise;
/**
* (Beta) Delete an Association Between a Gateway Messaging Service and an Event API Product Version by Association ID
* Use this API to disassociate an Event API Product version and gateway messaging service by association ID.
Token Permissions: [ `event_api_product:update:*` ]
* @returns void
* @throws ApiError
*/
static disassociateGatewayMessagingServiceFromEventApiProductVersionById({ memAssociationId, xContextId, }: {
/** The association ID to perform the disassociation for. **/
memAssociationId: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* (Beta) Create an Association Between a Gateway Messaging Service and an Event API Product Version
* Use this API to associate an Event API Product version and gateway messaging service.
Token Permissions: [ `event_api_product:update:*` ]
* @returns GatewayMessagingServiceResponse Associated GatewayMessagingService to Event API Product version.
* @throws ApiError
*/
static associateGatewayMessagingServiceToEapVersion({ eventApiProductVersionId, requestBody, xContextId, }: {
/** The ID of the Event API Product version to associate. **/
eventApiProductVersionId: string;
/** Gateway messaging service Id and supported Protocols. **/
requestBody: GatewayMessagingService;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* (Beta) Delete an Association Between a Gateway Messaging Service and an Event API Product Version
* Use this API to disassociate an Event API Product version and gateway messaging service.
Token Permissions: [ `event_api_product:update:*` ]
* @returns void
* @throws ApiError
*/
static disassociateGatewayMessagingServiceToEapVersion({ eventApiProductVersionId, memAssociationId, xContextId, }: {
/** The ID of the Event API Product version to disassociate. **/
eventApiProductVersionId: string;
/** The MEM association ID to dissociate from. **/
memAssociationId: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
}