import type { Consumer } from '../models/Consumer';
import type { ConsumerResponse } from '../models/ConsumerResponse';
import type { ConsumersResponse } from '../models/ConsumersResponse';
import type { CancelablePromise } from '../core/CancelablePromise';
export declare class ConsumersService {
/**
* Get a list of consumers
* Use this API to get a list of consumers that match the given parameters.
Token Permissions: [ `event_designer:access` ]
* @returns ConsumersResponse Get a list of consumers and the accompanying metadata.
* @throws ApiError
*/
static getConsumers({ xContextId, pageSize, pageNumber, applicationVersionIds, ids, }: {
/** Optional context id the request is running. **/
xContextId?: string;
/** The number of consumers to get per page. **/
pageSize?: number;
/** The page number to get. **/
pageNumber?: number;
/** Match only consumers with the given application version IDs, separated by commas. **/
applicationVersionIds?: Array;
/** Match only consumers with the given IDs separated by commas. **/
ids?: Array;
}): CancelablePromise;
/**
* Create a consumer
* Use this API to create a consumer.
Token Permissions: [ `application:update:*` ]
* @returns ConsumerResponse Created a consumer. Returns the newly saved consumer in the response body.
* @throws ApiError
*/
static createConsumer({ requestBody, xContextId, }: {
/** The consumer. **/
requestBody: Consumer;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Get a consumer
* Use this API to get a single consumer by its ID.
Token Permissions: [ `application:get:*` ]
* @returns ConsumerResponse The consumer.
* @throws ApiError
*/
static getConsumer({ id, xContextId, }: {
/** The ID of the consumer. **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Delete a consumer
* Use this API to delete a consumer.
Token Permissions: [ `application:update:*` ]
* @returns void
* @throws ApiError
*/
static deleteConsumer({ id, xContextId, }: {
/** The ID of the consumer **/
id: string;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
/**
* Update a consumer
* Use this API to update a consumer.
Token Permissions: [ `application:update:*` ]
* @returns ConsumerResponse Updated a consumer. Returns the newly saved consumer in the response body.
* @throws ApiError
*/
static updateConsumer({ id, requestBody, xContextId, }: {
/** The ID of the consumer. **/
id: string;
/** The consumer. **/
requestBody: Consumer;
/** Optional context id the request is running. **/
xContextId?: string;
}): CancelablePromise;
}