import type { CustomAttributeDefinition } from '../models/CustomAttributeDefinition'; import type { CustomAttributeDefinitionResponse } from '../models/CustomAttributeDefinitionResponse'; import type { CustomAttributeDefinitionsResponse } from '../models/CustomAttributeDefinitionsResponse'; import type { CancelablePromise } from '../core/CancelablePromise'; export declare class CustomAttributeDefinitionsService { /** * Get a list of custom attribute definitions * Use this API to get a list of custom attribute definitions that match the given parameters.

Token Permissions: [ `event_designer:access` ] * @returns CustomAttributeDefinitionsResponse Get a list of custom attribute definitions and the accompanying metadata. * @throws ApiError */ static getCustomAttributeDefinitions({ xContextId, pageSize, pageNumber, associatedEntityTypes, }: { /** Optional context id the request is running. **/ xContextId?: string; /** The number of custom attribute definitions to get per page. **/ pageSize?: number; /** The page number to get. **/ pageNumber?: number; /** Match only custom attribute definitions with the given associated entity type names separated by commas. **/ associatedEntityTypes?: Array; }): CancelablePromise; /** * Create a custom attribute definition * Use this API to create a custom attribute definition.

Token Permissions: [ `custom_attribute:write` ] * @returns CustomAttributeDefinitionResponse Created a custom attribute definition. Returns the newly saved custom attribute definition in the response body. * @throws ApiError */ static createCustomAttributeDefinition({ requestBody, xContextId, }: { /** The custom attribute definition. **/ requestBody: CustomAttributeDefinition; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Get a custom attribute definition * Use this API to get a single custom attribute definition by its ID.

Token Permissions: [ `event_designer:access` ] * @returns CustomAttributeDefinitionResponse The custom attribute definition. * @throws ApiError */ static getCustomAttributeDefinition({ id, xContextId, }: { /** The ID of the custom attribute definition. **/ id: string; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Delete a custom attribute definition * Use this API to delete a custom attribute definition.

Token Permissions: [ `custom_attribute:write` ] * @returns void * @throws ApiError */ static deleteCustomAttributeDefinition({ id, xContextId, }: { /** The ID of the custom attribute definition **/ id: string; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Update a custom attribute definition * Use this API to update a custom attribute definition. You can only update the associated entity types.

Token Permissions: [ `custom_attribute:write` ] * @returns CustomAttributeDefinitionResponse The updated custom attribute definition. * @throws ApiError */ static updateCustomAttributeDefinition({ id, requestBody, xContextId, }: { /** The ID of the custom attribute definition to update. **/ id: string; /** The custom attribute definition. **/ requestBody: CustomAttributeDefinition; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Get a list the custom attribute definitions of provided application domain * Use this API to get a list of custom attribute definitions that match the given parameters.

Token Permissions: [ `custom_attribute:get:*` ] * @returns CustomAttributeDefinitionsResponse Get a list of custom attribute definitions of a given application domain id. * @throws ApiError */ static getCustomAttributeDefinitionsByApplicationDomain({ applicationDomainId, xContextId, pageSize, pageNumber, }: { /** Match only custom attribute definitions with the given application domain Id **/ applicationDomainId: string; /** Optional context id the request is running. **/ xContextId?: string; /** The number of custom attribute definitions to get per page. **/ pageSize?: number; /** The page number to get. **/ pageNumber?: number; }): CancelablePromise; /** * Create a custom attribute definition for provided application domain * Use this API to create a custom attribute definition for provided application domain.

Token Permissions: [ `custom_attribute:create:*` ] * @returns CustomAttributeDefinitionResponse Created a custom attribute definition in provided application domain and Returns the newly saved custom attribute definition in the response body. * @throws ApiError */ static createCustomAttributeDefinitionByApplicationDomain({ applicationDomainId, requestBody, xContextId, }: { /** The ID of the application domain **/ applicationDomainId: string; /** The custom attribute definition. **/ requestBody: CustomAttributeDefinition; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Delete a custom attribute definition of provided application domain * Use this API to delete a custom attribute definition by given application domain.

Token Permissions: [ `custom_attribute:delete:*` ] * @returns void * @throws ApiError */ static deleteCustomAttributeDefinitionByApplicationDomain({ applicationDomainId, xContextId, }: { /** The ID of the application domain **/ applicationDomainId: string; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Delete a custom attribute definition of provided application domain * Use this API to delete a custom attribute definition of given application domain.

Token Permissions: [ `custom_attribute:delete:*` ] * @returns void * @throws ApiError */ static deleteCustomAttributeDefinitionOfApplicationDomain({ applicationDomainId, customAttributeId, xContextId, }: { /** The ID of the application domain **/ applicationDomainId: string; /** The ID of the custom attribute definition **/ customAttributeId: string; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; /** * Update a custom attribute definition for provided application domain * Use this API to update a custom attribute definition for provided application domain.

Token Permissions: [ `custom_attribute:update:*` ] * @returns CustomAttributeDefinitionResponse Updated a custom attribute definition in provided application domain and Returns the newly saved custom attribute definition in the response body. * @throws ApiError */ static updateCustomAttributeDefinitionByApplicationDomain({ applicationDomainId, customAttributeId, requestBody, xContextId, }: { /** The ID of the application domain **/ applicationDomainId: string; /** The ID of the custom attribute definition **/ customAttributeId: string; /** The custom attribute definition. **/ requestBody: CustomAttributeDefinition; /** Optional context id the request is running. **/ xContextId?: string; }): CancelablePromise; }