import type { ApplicationDomain } from '../models/ApplicationDomain';
import type { ApplicationDomainExportDTO } from '../models/ApplicationDomainExportDTO';
import type { ApplicationDomainImportDTO } from '../models/ApplicationDomainImportDTO';
import type { ApplicationDomainResponse } from '../models/ApplicationDomainResponse';
import type { ApplicationDomainsResponse } from '../models/ApplicationDomainsResponse';
import type { CancelablePromise } from '../core/CancelablePromise';
export declare class ApplicationDomainsService {
/**
* Get a list of the application domains
* Use this API to get a list of application domains that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns ApplicationDomainsResponse Get a list of application domains and the accompanying metadata.
* @throws ApiError
*/
static getApplicationDomains({ xContextId, pageSize, pageNumber, name, ids, include, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of application domains to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** Name to be used to match the application domain. **/
name?: string;
/** Match only application domains with the given IDs separated by commas. **/
ids?: Array;
/** Specify extra data to be included, options are: stats **/
include?: Array;
}): CancelablePromise;
/**
* Create an application domain
* To help keep your event-driven architecture organized, use application domains to create namespaces for your applications, events and schemas.
Token Permissions: [ `application_domain:create:*` ]
* @returns ApplicationDomainResponse Created. The newly saved application domain is returned in the response body.
* @throws ApiError
*/
static createApplicationDomain({ requestBody, xContextId, }: {
/** Application domains have a name and topic domain. **/
requestBody: ApplicationDomain;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get an application domain
* Use this API to get a single application domain by its ID.
Token Permissions: [ `application_domain:get:*` ]
* @returns ApplicationDomainResponse The application domain.
* @throws ApiError
*/
static getApplicationDomain({ id, xContextId, include, }: {
/** The ID of the application domain. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
/** Specify extra data to be included, options are: stats **/
include?: Array;
}): CancelablePromise;
/**
* Delete an application domain
* Use this API to delete an application domain. This action also deletes all applications, events, and schemas in the application domain. You cannot undo this operation.
Token Permissions: [ `application_domain:delete:*` ]
* @returns void
* @throws ApiError
*/
static deleteApplicationDomain({ id, xContextId, }: {
/** The ID of the application domain. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update an application domain
* Use this API to update an application domain. You only need to specify the fields that need to be updated.
Token Permissions: [ `application_domain:update:*` ]
* @returns ApplicationDomainResponse The updated application domain.
* @throws ApiError
*/
static updateApplicationDomain({ id, requestBody, xContextId, }: {
/** The ID of the application domain. **/
id: string;
/** The application domain. **/
requestBody: ApplicationDomain;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* (Beta) Create application domains and their entities from import
* Use this API to import application domains and their nested entities. Please note that this endpoint is in beta and could be subject to change in the future
Token Permissions: [ `application_domain:import:*` ]
* @returns any Successfully registered import job with location identified in the response header
* @throws ApiError
*/
static importApplicationDomains({ requestBody, xContextId, }: {
/** Application domain import file **/
requestBody: ApplicationDomainImportDTO;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* (Beta) Get application domains and their entities for export
* Use this API to export application domains and their nested entities. Please note that this endpoint is in beta and could be subject to change in the future
Token Permissions: [ `application_domain:export:*` ]
* @returns ApplicationDomainExportDTO Export file containing the application domains and accompanying entities
* @throws ApiError
*/
static exportApplicationDomains({ ids, xContextId, }: {
/** The IDs of the application domains to export **/
ids: Array;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
}