import { TagAbstract, ClientAbstract, KnownStatusCodeException } from 'sdkgen-client'; /** * AgentItem automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Agent item */ interface AgentItem { type?: string; metadata?: Record; } /** * AgentItemBinary automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Binary agent message */ interface AgentItemBinary extends AgentItem { type: "binary"; mime?: string; data?: string; } /** * AgentItemObject automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Structured agent message */ interface AgentItemObject extends AgentItem { type: "object"; payload?: any; } /** * AgentItemText automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Text agent message */ interface AgentItemText extends AgentItem { type: "text"; content?: string; } /** * AgentItemToolCallFunction automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Concrete values for a function tool call */ interface AgentItemToolCallFunction { id?: string; name?: string; arguments?: string; } /** * AgentItemToolCall automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Tool call agent message */ interface AgentItemToolCall extends AgentItem { type: "tool_call"; functions?: Array; } /** * AgentItemChoice automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Choice agent message */ interface AgentItemChoice extends AgentItem { type: "choice"; items?: Array; } /** * AgentInput automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an agent input */ interface AgentInput { previousId?: string; item?: AgentItemBinary | AgentItemChoice | AgentItemObject | AgentItemText | AgentItemToolCall; } /** * AgentOutput automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an agent output */ interface AgentOutput { id?: string; item?: AgentItemBinary | AgentItemChoice | AgentItemObject | AgentItemText | AgentItemToolCall; } /** * CommonMetadata automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface CommonMetadata extends Record { } /** * BackendToken automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a token, this an access token which was requested by a user */ interface BackendToken { id?: number; status?: number; name?: string; scopes?: Array; ip?: string; expire?: string; date?: string; } /** * BackendApp automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an app to access the API on-behalf of a user */ interface BackendApp { id?: number; userId?: number; status?: number; name?: string; url?: string; parameters?: string; appKey?: string; appSecret?: string; metadata?: CommonMetadata; date?: string; scopes?: Array; tokens?: Array; } /** * BackendUser automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a user */ interface BackendUser { id?: number; roleId?: number; planId?: number; status?: number; name?: string; email?: string; points?: number; scopes?: Array; apps?: Array; metadata?: CommonMetadata; date?: string; } /** * CommonMessage automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Common error message */ interface CommonMessage { success?: boolean; message?: string; id?: string; } /** * AuthorizationTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class AuthorizationTag extends TagAbstract { /** * Returns user data of the current authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getWhoami(): Promise; /** * Revoke the access token of the current authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ revoke(): Promise; } /** * BackendAccountChangePassword automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendAccountChangePassword { oldPassword?: string; newPassword?: string; verifyPassword?: string; } /** * BackendUserUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendUserUpdate extends BackendUser { } /** * BackendAccountTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendAccountTag extends TagAbstract { /** * Changes the password of the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ changePassword(payload: BackendAccountChangePassword): Promise; /** * Returns user data of the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(): Promise; /** * Updates user data of the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(payload: BackendUserUpdate): Promise; } /** * BackendActionConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * The action configuration which contains arbitrary key-value entries */ interface BackendActionConfig extends Record { } /** * BackendAction automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents the business logic which can be executed either through an operation or cronjob */ interface BackendAction { id?: number; status?: number; name?: string; class?: string; async?: boolean; config?: BackendActionConfig; metadata?: CommonMetadata; } /** * CommonCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Base collection */ interface CommonCollection { totalResults?: number; startIndex?: number; itemsPerPage?: number; entry?: Array; } /** * BackendActionCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of action objects */ interface BackendActionCollection extends CommonCollection { } /** * BackendActionCommit automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * An action commit which represents a change in the action configuration */ interface BackendActionCommit { id?: number; user?: BackendUser; commitHash?: string; config?: BackendActionConfig; insertDate?: string; } /** * BackendActionCommitCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of action commit objects */ interface BackendActionCommitCollection extends CommonCollection { } /** * BackendActionCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendActionCreate extends BackendAction { } /** * BackendActionExecuteRequestBody automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a request body */ interface BackendActionExecuteRequestBody extends Record { } /** * BackendActionExecuteRequest automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a request to execute an action */ interface BackendActionExecuteRequest { method?: string; uriFragments?: string; parameters?: string; headers?: string; body?: BackendActionExecuteRequestBody; } /** * BackendActionExecuteResponseHeaders automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a map of headers */ interface BackendActionExecuteResponseHeaders extends Record { } /** * BackendActionExecuteResponseBody automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a response body */ interface BackendActionExecuteResponseBody extends Record { } /** * BackendActionExecuteResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents an action execution response */ interface BackendActionExecuteResponse { statusCode?: number; headers?: BackendActionExecuteResponseHeaders; body?: BackendActionExecuteResponseBody; } /** * BackendActionIndexEntry automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a concrete action class */ interface BackendActionIndexEntry { name?: string; class?: string; } /** * BackendActionIndex automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Contains all possible classes which can be used at an action as class */ interface BackendActionIndex { actions?: Array; } /** * BackendActionUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendActionUpdate extends BackendAction { } /** * CommonFormElement automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Form base element */ interface CommonFormElement { element?: string; name?: string; title?: string; help?: string; } /** * CommonFormElementCheckbox automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Form element which represents a checkbox element */ interface CommonFormElementCheckbox extends CommonFormElement { type: "checkbox"; } /** * CommonFormElementCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Form element which represents a collection element */ interface CommonFormElementCollection extends CommonFormElement { type: "collection"; } /** * CommonFormElementInput automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Form element which represents an input element */ interface CommonFormElementInput extends CommonFormElement { type: "input"; } /** * CommonFormElementMap automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Form element which represents a map element */ interface CommonFormElementMap extends CommonFormElement { type: "map"; } /** * CommonFormElementSelectOption automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a concrete option entry */ interface CommonFormElementSelectOption { key?: string; value?: string; } /** * CommonFormElementSelect automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Form element which represents a select element */ interface CommonFormElementSelect extends CommonFormElement { type: "select"; options?: Array; } /** * CommonFormElementTextArea automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Form element which represents a textarea */ interface CommonFormElementTextArea extends CommonFormElement { type: "textarea"; mode?: string; } /** * CommonFormElementTypeAPI automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Form element which represents a TypeAPI editor */ interface CommonFormElementTypeAPI extends CommonFormElement { type: "typeapi"; } /** * CommonFormElementTypeSchema automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Form element which represents a TypeSchema editor */ interface CommonFormElementTypeSchema extends CommonFormElement { type: "typeschema"; } /** * CommonFormContainer automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a config form with a list of elements */ interface CommonFormContainer { element?: Array; } /** * BackendActionTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendActionTag extends TagAbstract { /** * Creates a new action * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendActionCreate): Promise; /** * Deletes an existing action * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(actionId: string): Promise; /** * Executes a specific action. This method should be used to test an action configuration * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ execute(actionId: string, payload: BackendActionExecuteRequest): Promise; /** * Returns a specific action * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(actionId: string): Promise; /** * Returns a paginated list of actions * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Returns all available action classes * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getClasses(): Promise; /** * Returns a paginated list of action commits * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getCommits(actionId: string, startIndex?: number, count?: number, search?: string): Promise; /** * Returns the action config form * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getForm(_class?: string): Promise; /** * Updates an existing action * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(actionId: string, payload: BackendActionUpdate): Promise; } /** * BackendAgent automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an agent */ interface BackendAgent { id?: number; connection?: number; type?: number; public?: boolean; name?: string; description?: string; introduction?: string; temperature?: number; costs?: number; tools?: Array; outgoing?: string; action?: string; insertDate?: string; metadata?: CommonMetadata; } /** * BackendAgentCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a collection of agent messages */ interface BackendAgentCollection extends CommonCollection { } /** * BackendAgentCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendAgentCreate extends BackendAgent { } /** * BackendAgentMessage automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an agent message */ interface BackendAgentMessage { id?: number; chatId?: string; role?: string; item?: AgentItemBinary | AgentItemChoice | AgentItemObject | AgentItemText | AgentItemToolCall; insertDate?: string; } /** * BackendAgentMessageCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a collection of agent messages */ interface BackendAgentMessageCollection extends CommonCollection { } /** * BackendAgentMessageTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendAgentMessageTag extends TagAbstract { /** * Returns a paginated list of agent messages * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(agentId: string, chatId?: string): Promise; /** * Submits a new agent message * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ submit(agentId: string, payload: AgentInput): Promise; } /** * BackendAgentTool automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a concrete tool */ interface BackendAgentTool { name?: string; description?: string; } /** * BackendAgentTools automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a collection of available tools */ interface BackendAgentTools { tools?: Array; } /** * BackendAgentUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendAgentUpdate extends BackendAgent { } /** * BackendAgentTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendAgentTag extends TagAbstract { message(): BackendAgentMessageTag; /** * Creates a new agent * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendAgentCreate): Promise; /** * Deletes an existing agent * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(agentId: string): Promise; /** * Returns a specific agent * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(agentId: string): Promise; /** * Returns a paginated list of agents * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Returns available tools for an agent * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getTools(): Promise; /** * Updates an existing agent * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(agentId: string, payload: BackendAgentUpdate): Promise; } /** * BackendAppCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of app objects */ interface BackendAppCollection extends CommonCollection { } /** * BackendAppCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendAppCreate extends BackendApp { } /** * BackendAppUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendAppUpdate extends BackendApp { } /** * BackendAppTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendAppTag extends TagAbstract { /** * Creates a new app * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendAppCreate): Promise; /** * Deletes an existing app * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(appId: string): Promise; /** * Deletes an existing token from an app * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ deleteToken(appId: string, tokenId: string): Promise; /** * Returns a specific app * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(appId: string): Promise; /** * Returns a paginated list of apps * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing app * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(appId: string, payload: BackendAppUpdate): Promise; } /** * BackendAuditObject automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A key value object containing the changes */ interface BackendAuditObject extends Record { } /** * BackendAudit automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an audit which is created every time something was changed at the system */ interface BackendAudit { id?: number; app?: BackendApp; user?: BackendUser; event?: string; ip?: string; message?: string; content?: BackendAuditObject; date?: string; } /** * BackendAuditCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of audit objects */ interface BackendAuditCollection extends CommonCollection { } /** * BackendAuditTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendAuditTag extends TagAbstract { /** * Returns a specific audit * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(auditId: string): Promise; /** * Returns a paginated list of audits * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, from?: string, to?: string, appId?: number, userId?: number, event?: string, ip?: string, message?: string): Promise; } /** * BackendBackupExport automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Export of the complete system configuration */ interface BackendBackupExport { export?: string; } /** * BackendBackupImport automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Import a previously exported system configuration */ interface BackendBackupImport { import?: string; } /** * BackendBackupImportResult automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Result of a backup import operation */ interface BackendBackupImportResult { success?: boolean; message?: string; logs?: Array; } /** * BackendBackupTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendBackupTag extends TagAbstract { /** * Generates an backup of the current system * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ export(): Promise; /** * Imports an backup to the current system * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ import(payload: BackendBackupImport): Promise; } /** * BackendBundleConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendBundleConfig extends Record { } /** * BackendBundle automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a bundle which contains action, schema, event, cronjob and trigger configurations from you local instance */ interface BackendBundle { id?: number; name?: string; version?: string; icon?: string; summary?: string; description?: string; cost?: number; config?: BackendBundleConfig; } /** * BackendBundleCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of bundle objects */ interface BackendBundleCollection extends CommonCollection { } /** * BackendBundleCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendBundleCreate extends BackendBundle { } /** * BackendBundleUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendBundleUpdate extends BackendBundle { } /** * BackendBundleTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendBundleTag extends TagAbstract { /** * Creates a new bundle * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendBundleCreate): Promise; /** * Deletes an existing bundle * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(bundleId: string): Promise; /** * Returns a specific bundle * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(bundleId: string): Promise; /** * Returns a paginated list of bundles * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Publish an existing bundle to the marketplace * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ publish(bundleId: string): Promise; /** * Updates an existing bundle * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(bundleId: string, payload: BackendBundleUpdate): Promise; } /** * BackendCategory automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a category. Every user is assigned to a category and can only view objects which are also assigned to the same category, through this it is possible to build separate areas for external developers */ interface BackendCategory { id?: number; name?: string; } /** * BackendCategoryCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of category objects */ interface BackendCategoryCollection extends CommonCollection { } /** * BackendCategoryCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendCategoryCreate extends BackendCategory { } /** * BackendCategoryUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendCategoryUpdate extends BackendCategory { } /** * BackendCategoryTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendCategoryTag extends TagAbstract { /** * Creates a new category * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendCategoryCreate): Promise; /** * Deletes an existing category * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(categoryId: string): Promise; /** * Returns a specific category * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(categoryId: string): Promise; /** * Returns a paginated list of categories * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing category * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(categoryId: string, payload: BackendCategoryUpdate): Promise; } /** * BackendConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a system configuration */ interface BackendConfig { id?: number; type?: number; name?: string; description?: string; value?: any; } /** * BackendConfigCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of config objects */ interface BackendConfigCollection extends CommonCollection { } /** * BackendConfigUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendConfigUpdate extends BackendConfig { } /** * BackendConfigTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendConfigTag extends TagAbstract { /** * Returns a specific config * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(configId: string): Promise; /** * Returns a paginated list of configuration values * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing config value * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(configId: string, payload: BackendConfigUpdate): Promise; } /** * BackendConnectionConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * The connection configuration which contains arbitrary key-value entries */ interface BackendConnectionConfig extends Record { } /** * BackendConnection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a connection to an external system like i.e. a database, message-queue or client-sdk */ interface BackendConnection { id?: number; name?: string; class?: string; oauth2?: boolean; config?: BackendConnectionConfig; metadata?: CommonMetadata; } /** * BackendConnectionAgentTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendConnectionAgentTag extends TagAbstract { /** * Sends a message to an agent * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ send(connectionId: string, payload: AgentInput): Promise; } /** * BackendConnectionCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of connection objects */ interface BackendConnectionCollection extends CommonCollection { } /** * BackendConnectionCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendConnectionCreate extends BackendConnection { } /** * BackendDatabaseRow automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a row on a relational table */ interface BackendDatabaseRow extends Record { } /** * BackendDatabaseRowCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of database rows */ interface BackendDatabaseRowCollection extends CommonCollection { } /** * BackendDatabaseTableColumn automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a column at a relation table */ interface BackendDatabaseTableColumn { name?: string; type?: string; length?: number; precision?: number; scale?: number; unsigned?: boolean; fixed?: boolean; notNull?: boolean; autoIncrement?: boolean; default?: any; comment?: string; } /** * BackendDatabaseTableIndex automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a table index on a relational database */ interface BackendDatabaseTableIndex { name?: string; unique?: boolean; columns?: Array; } /** * BackendDatabaseTableForeignKeyConstraint automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a foreign key constraint on a relational database */ interface BackendDatabaseTableForeignKeyConstraint { name?: string; foreignTable?: string; localColumnNames?: Array; foreignColumnNames?: Array; } /** * BackendDatabaseTable automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a relational table on a database connection */ interface BackendDatabaseTable { name?: string; columns?: Array; primaryKey?: string; indexes?: Array; foreignKeys?: Array; } /** * BackendDatabaseTableCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendDatabaseTableCollection extends CommonCollection { } /** * BackendConnectionDatabaseTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendConnectionDatabaseTag extends TagAbstract { /** * Creates a new row at a table on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ createRow(connectionId: string, tableName: string, payload: BackendDatabaseRow): Promise; /** * Creates a new table on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ createTable(connectionId: string, payload: BackendDatabaseTable): Promise; /** * Deletes an existing row at a table on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ deleteRow(connectionId: string, tableName: string, id: string): Promise; /** * Deletes an existing table on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ deleteTable(connectionId: string, tableName: string): Promise; /** * Returns a specific row at a table on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getRow(connectionId: string, tableName: string, id: string): Promise; /** * Returns paginated rows at a table on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getRows(connectionId: string, tableName: string, startIndex?: number, count?: number, filterBy?: string, filterOp?: string, filterValue?: string, sortBy?: string, sortOrder?: string, columns?: string): Promise; /** * Returns the schema of a specific table on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getTable(connectionId: string, tableName: string): Promise; /** * Returns all available tables on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getTables(connectionId: string, startIndex?: number, count?: number): Promise; /** * Updates an existing row at a table on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ updateRow(connectionId: string, tableName: string, id: string, payload: BackendDatabaseRow): Promise; /** * Updates an existing table on a database * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ updateTable(connectionId: string, tableName: string, payload: BackendDatabaseTable): Promise; } /** * BackendFile automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a file on the filesystem */ interface BackendFile { id?: string; name?: string; contentType?: string; checksum?: string; lastModified?: string; } /** * BackendFileCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of file objects */ interface BackendFileCollection extends CommonCollection { } /** * BackendConnectionFilesystemTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendConnectionFilesystemTag extends TagAbstract { /** * Uploads one or more files on the filesystem connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(connectionId: string, payload: FormData): Promise; /** * Deletes an existing file on the filesystem connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(connectionId: string, fileId: string): Promise; /** * Returns the content of the provided file id on the filesystem connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(connectionId: string, fileId: string): Promise; /** * Returns all available files on the filesystem connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(connectionId: string, startIndex?: number, count?: number): Promise; /** * Updates an existing file on the filesystem connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(connectionId: string, fileId: string, payload: FormData): Promise; } /** * BackendHttpRequest automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a HTTP request */ interface BackendHttpRequest { method?: string; uri?: string; headers?: Record; body?: string; } /** * BackendHttpResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a HTTP response */ interface BackendHttpResponse { statusCode?: number; headers?: Record; body?: string; } /** * BackendConnectionHttpTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendConnectionHttpTag extends TagAbstract { /** * Sends an arbitrary HTTP request to the connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ execute(connectionId: string, payload: BackendHttpRequest): Promise; } /** * BackendConnectionIndexEntry automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a concrete connection class */ interface BackendConnectionIndexEntry { name?: string; class?: string; } /** * BackendConnectionIndex automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Contains all possible classes which can be used at an connection as class */ interface BackendConnectionIndex { connections?: Array; } /** * BackendConnectionRedirectResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Redirect response to initiate an OAuth2 flow */ interface BackendConnectionRedirectResponse { redirectUri?: string; } /** * Passthru automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * No schema information available */ interface Passthru extends Record { } /** * BackendConnectionSdkTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendConnectionSdkTag extends TagAbstract { /** * Returns the SDK specification * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(connectionId: string): Promise; } /** * BackendConnectionUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendConnectionUpdate extends BackendConnection { } /** * BackendConnectionTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendConnectionTag extends TagAbstract { agent(): BackendConnectionAgentTag; database(): BackendConnectionDatabaseTag; filesystem(): BackendConnectionFilesystemTag; http(): BackendConnectionHttpTag; sdk(): BackendConnectionSdkTag; /** * Creates a new connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendConnectionCreate): Promise; /** * Deletes an existing connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(connectionId: string): Promise; /** * Returns a specific connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(connectionId: string): Promise; /** * Returns a paginated list of connections * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, _class?: string): Promise; /** * Returns all available connection classes * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getClasses(): Promise; /** * Returns the connection config form * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getForm(_class?: string): Promise; /** * Returns a redirect url to start the OAuth2 authorization flow for the given connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getRedirect(connectionId: string): Promise; /** * Updates an existing connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(connectionId: string, payload: BackendConnectionUpdate): Promise; } /** * BackendCronjobError automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents an error which occurred on cronjob execution */ interface BackendCronjobError { message?: string; trace?: string; file?: string; line?: number; } /** * BackendCronjob automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a cronjob which can invoke an action at a specific interval */ interface BackendCronjob { id?: number; name?: string; cron?: string; action?: string; executeDate?: string; exitCode?: number; metadata?: CommonMetadata; errors?: Array; } /** * BackendCronjobCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of cronjob objects */ interface BackendCronjobCollection extends CommonCollection { } /** * BackendCronjobCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendCronjobCreate extends BackendCronjob { } /** * BackendCronjobUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendCronjobUpdate extends BackendCronjob { } /** * BackendCronjobTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendCronjobTag extends TagAbstract { /** * Creates a new cronjob * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendCronjobCreate): Promise; /** * Deletes an existing cronjob * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(cronjobId: string): Promise; /** * Returns a specific cronjob * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(cronjobId: string): Promise; /** * Returns a paginated list of cronjobs * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, taxonomy?: number): Promise; /** * Updates an existing cronjob * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(cronjobId: string, payload: BackendCronjobUpdate): Promise; } /** * BackendStatisticChartSeries automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendStatisticChartSeries { name?: string; data?: Array; } /** * BackendStatisticChart automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendStatisticChart { labels?: Array; series?: Array; } /** * BackendDashboard automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents an object containing all widget data for the dashboard */ interface BackendDashboard { errorsPerOperation?: BackendStatisticChart; incomingRequests?: BackendStatisticChart; incomingTransactions?: BackendStatisticChart; mostUsedOperations?: BackendStatisticChart; timePerOperation?: BackendStatisticChart; testCoverage?: BackendStatisticChart; mostUsedActivities?: BackendStatisticChart; activitiesPerUser?: BackendStatisticChart; userRegistrations?: BackendStatisticChart; } /** * BackendDashboardTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendDashboardTag extends TagAbstract { /** * Returns all available dashboard widgets * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(): Promise; } /** * BackendEvent automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an event which can be triggered by an action */ interface BackendEvent { id?: number; name?: string; description?: string; schema?: string; metadata?: CommonMetadata; } /** * BackendEventCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of event objects */ interface BackendEventCollection extends CommonCollection { } /** * BackendEventCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendEventCreate extends BackendEvent { } /** * BackendEventUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendEventUpdate extends BackendEvent { } /** * BackendEventTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendEventTag extends TagAbstract { /** * Creates a new event * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendEventCreate): Promise; /** * Deletes an existing event * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(eventId: string): Promise; /** * Returns a specific event * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(eventId: string): Promise; /** * Returns a paginated list of events * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, taxonomy?: number): Promise; /** * Updates an existing event * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(eventId: string, payload: BackendEventUpdate): Promise; } /** * BackendFirewall automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a firewall rule which blocks specific IP addresses */ interface BackendFirewall { id?: number; name?: string; type?: number; ip?: string; expire?: string; metadata?: CommonMetadata; } /** * BackendFirewallCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of firewall objects */ interface BackendFirewallCollection extends CommonCollection { } /** * BackendFirewallCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendFirewallCreate extends BackendFirewall { } /** * BackendFirewallUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendFirewallUpdate extends BackendFirewall { } /** * BackendFirewallTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendFirewallTag extends TagAbstract { /** * Creates a new firewall rule * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendFirewallCreate): Promise; /** * Deletes an existing firewall rule * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(firewallId: string): Promise; /** * Returns a specific firewall rule * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(firewallId: string): Promise; /** * Returns a paginated list of firewall rules * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing firewall rule * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(firewallId: string, payload: BackendFirewallUpdate): Promise; } /** * BackendForm automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a form which helps to dynamically generate a form at a frontend app */ interface BackendForm { id?: number; status?: number; name?: string; operationId?: number; uiSchema?: any; metadata?: CommonMetadata; } /** * BackendFormCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of form objects */ interface BackendFormCollection extends CommonCollection { } /** * BackendFormCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendFormCreate extends BackendForm { } /** * BackendFormUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendFormUpdate extends BackendForm { } /** * BackendFormTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendFormTag extends TagAbstract { /** * Creates a new form * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendFormCreate): Promise; /** * Deletes an existing form * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(formId: string): Promise; /** * Returns a specific form * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(formId: string): Promise; /** * Returns a paginated list of forms * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing form * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(formId: string, payload: BackendFormUpdate): Promise; } /** * BackendGeneratorIndexProvider automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a concrete generator class */ interface BackendGeneratorIndexProvider { name?: string; class?: string; } /** * BackendGeneratorIndexProviders automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Contains all possible classes which can be used at an generator as class */ interface BackendGeneratorIndexProviders { providers?: Array; } /** * BackendGeneratorProviderConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendGeneratorProviderConfig extends Record { } /** * BackendGeneratorProvider automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendGeneratorProvider { path?: string; scopes?: Array; public?: boolean; config?: BackendGeneratorProviderConfig; } /** * BackendSchemaSource automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Contains the TypeSchema specification */ interface BackendSchemaSource extends Record { } /** * BackendSchema automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a schema to describe a JSON payload */ interface BackendSchema { id?: number; status?: number; name?: string; source?: BackendSchemaSource; metadata?: CommonMetadata; } /** * BackendOperationSchema automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendOperationSchema { description?: string; type?: string; format?: string; enum?: string; } /** * BackendOperationParameters automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendOperationParameters extends Record { } /** * BackendOperationThrows automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendOperationThrows extends Record { } /** * BackendOperation automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an operation, an operation invokes an action in case a specific HTTP method and path was requested. It defines also schema information about the request and response payload */ interface BackendOperation { id?: number; status?: number; active?: boolean; public?: boolean; stability?: number; description?: string; httpMethod?: string; httpPath?: string; httpCode?: number; name?: string; parameters?: BackendOperationParameters; incoming?: string; outgoing?: string; throws?: BackendOperationThrows; action?: string; costs?: number; scopes?: Array; metadata?: CommonMetadata; } /** * BackendGeneratorProviderChangelog automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendGeneratorProviderChangelog { schemas?: Array; actions?: Array; operations?: Array; } /** * BackendGeneratorTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendGeneratorTag extends TagAbstract { /** * Executes a generator with the provided config * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ executeProvider(provider: string, payload: BackendGeneratorProvider): Promise; /** * Generates a changelog of all potential changes if you execute this generator with the provided config * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getChangelog(provider: string, payload: BackendGeneratorProviderConfig): Promise; /** * Returns all available generator classes * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getClasses(): Promise; /** * Returns the generator config form * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getForm(provider: string): Promise; } /** * BackendIdentityConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendIdentityConfig extends Record { } /** * BackendIdentity automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an identity which allows to authenticate with a remote identity provider */ interface BackendIdentity { id?: number; appId?: number; roleId?: number; name?: string; icon?: string; class?: string; config?: BackendIdentityConfig; allowCreate?: boolean; } /** * BackendIdentityCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of identity objects */ interface BackendIdentityCollection extends CommonCollection { } /** * BackendIdentityCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendIdentityCreate extends BackendIdentity { } /** * BackendIdentityIndexEntry automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a concrete identity class */ interface BackendIdentityIndexEntry { name?: string; class?: string; } /** * BackendIdentityIndex automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Contains all possible classes which can be used at an identity as class */ interface BackendIdentityIndex { providers?: Array; } /** * BackendIdentityUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendIdentityUpdate extends BackendIdentity { } /** * BackendIdentityTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendIdentityTag extends TagAbstract { /** * Creates a new identity * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendIdentityCreate): Promise; /** * Deletes an existing identity * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(identityId: string): Promise; /** * Returns a specific identity * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(identityId: string): Promise; /** * Returns a paginated list of identities * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Returns all available identity classes * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getClasses(): Promise; /** * Returns the identity config form * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getForm(_class?: string): Promise; /** * Updates an existing identity * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(identityId: string, payload: BackendIdentityUpdate): Promise; } /** * BackendLogError automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendLogError { id?: number; logId?: number; message?: string; trace?: string; file?: string; line?: number; insertDate?: string; } /** * BackendLog automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a log entry. Every HTTP requests to the system generates such a log entry. */ interface BackendLog { id?: number; ip?: string; userAgent?: string; method?: string; path?: string; header?: string; body?: string; date?: string; errors?: Array; } /** * BackendLogCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of log objects */ interface BackendLogCollection extends CommonCollection { } /** * BackendLogErrorCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of log error objects */ interface BackendLogErrorCollection extends CommonCollection { } /** * BackendLogTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendLogTag extends TagAbstract { /** * Returns a specific log * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(logId: string): Promise; /** * Returns a paginated list of logs * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a paginated list of log errors * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAllErrors(startIndex?: number, count?: number, search?: string): Promise; /** * Returns a specific error * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getError(errorId: string): Promise; } /** * MarketplaceUser automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceUser { id?: number; name?: string; verified?: boolean; } /** * MarketplaceObject automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Base class of all objects on the marketplace */ interface MarketplaceObject { id?: number; name?: string; author?: MarketplaceUser; version?: string; icon?: string; summary?: string; description?: string; cost?: number; updateDate?: string; insertDate?: string; } /** * MarketplaceActionConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceActionConfig extends Record { } /** * MarketplaceAction automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceAction extends MarketplaceObject { class?: string; config?: MarketplaceActionConfig; } /** * MarketplaceCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceCollection { totalResults?: number; startIndex?: number; itemsPerPage?: number; entry?: Array; } /** * MarketplaceActionCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceActionCollection extends MarketplaceCollection { } /** * MarketplaceInstall automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Installs an object from the marketplace */ interface MarketplaceInstall { name?: string; } /** * MarketplaceMessage automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceMessage { success?: boolean; message?: string; id?: string; } /** * BackendMarketplaceActionTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendMarketplaceActionTag extends TagAbstract { /** * Returns a specific marketplace action * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(user: string, name: string): Promise; /** * Returns a paginated list of marketplace actions * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, query?: string): Promise; /** * Installs an action from the marketplace * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ install(payload: MarketplaceInstall): Promise; /** * Upgrades an action from the marketplace * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ upgrade(user: string, name: string): Promise; } /** * MarketplaceApp automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceApp extends MarketplaceObject { scopes?: Array; downloadUrl?: string; hash?: string; } /** * MarketplaceAppCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceAppCollection extends MarketplaceCollection { } /** * BackendMarketplaceAppTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendMarketplaceAppTag extends TagAbstract { /** * Returns a specific marketplace app * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(user: string, name: string): Promise; /** * Returns a paginated list of marketplace apps * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, query?: string): Promise; /** * Installs an app from the marketplace * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ install(payload: MarketplaceInstall): Promise; /** * Upgrades an app from the marketplace * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ upgrade(user: string, name: string): Promise; } /** * MarketplaceBundleActionConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundleActionConfig extends Record { } /** * MarketplaceBundleAction automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundleAction { name?: string; class?: string; config?: MarketplaceBundleActionConfig; } /** * MarketplaceBundleSchemaSource automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundleSchemaSource extends Record { } /** * MarketplaceBundleSchema automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundleSchema { name?: string; source?: MarketplaceBundleSchemaSource; } /** * MarketplaceBundleEvent automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundleEvent { name?: string; description?: string; schema?: string; } /** * MarketplaceBundleCronjob automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundleCronjob { name?: string; cron?: string; action?: string; } /** * MarketplaceBundleTrigger automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundleTrigger { name?: string; event?: string; action?: string; } /** * MarketplaceBundleConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundleConfig { actions?: Array; schemas?: Array; events?: Array; cronjobs?: Array; triggers?: Array; } /** * MarketplaceBundle automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundle extends MarketplaceObject { config?: MarketplaceBundleConfig; } /** * MarketplaceBundleCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface MarketplaceBundleCollection extends MarketplaceCollection { } /** * BackendMarketplaceBundleTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendMarketplaceBundleTag extends TagAbstract { /** * Returns a specific marketplace bundle * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(user: string, name: string): Promise; /** * Returns a paginated list of marketplace bundles * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, query?: string): Promise; /** * Installs an bundle from the marketplace * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ install(payload: MarketplaceInstall): Promise; /** * Upgrades an bundle from the marketplace * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ upgrade(user: string, name: string): Promise; } /** * BackendMarketplaceTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendMarketplaceTag extends TagAbstract { action(): BackendMarketplaceActionTag; app(): BackendMarketplaceAppTag; bundle(): BackendMarketplaceBundleTag; } /** * BackendOperationCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of operation objects */ interface BackendOperationCollection extends CommonCollection { } /** * BackendOperationCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendOperationCreate extends BackendOperation { } /** * BackendOperationUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendOperationUpdate extends BackendOperation { } /** * BackendOperationTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendOperationTag extends TagAbstract { /** * Creates a new operation * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendOperationCreate): Promise; /** * Deletes an existing operation * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(operationId: string): Promise; /** * Returns a specific operation * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(operationId: string): Promise; /** * Returns a paginated list of operations * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, taxonomy?: number): Promise; /** * Updates an existing operation * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(operationId: string, payload: BackendOperationUpdate): Promise; } /** * BackendPage automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a page at the developer portal */ interface BackendPage { id?: number; status?: number; title?: string; slug?: string; content?: string; metadata?: CommonMetadata; } /** * BackendPageCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of page objects */ interface BackendPageCollection extends CommonCollection { } /** * BackendPageCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendPageCreate extends BackendPage { } /** * BackendPageUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendPageUpdate extends BackendPage { } /** * BackendPageTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendPageTag extends TagAbstract { /** * Creates a new page * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendPageCreate): Promise; /** * Deletes an existing page * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(pageId: string): Promise; /** * Returns a specific page * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(pageId: string): Promise; /** * Returns a paginated list of pages * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing page * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(pageId: string, payload: BackendPageUpdate): Promise; } /** * BackendPlan automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a plan, a plan allows users to obtain points or in general subscribe to your app */ interface BackendPlan { id?: number; name?: string; description?: string; price?: number; points?: number; period?: number; externalId?: string; scopes?: Array; metadata?: CommonMetadata; } /** * BackendPlanCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of plan objects */ interface BackendPlanCollection extends CommonCollection { } /** * BackendPlanCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendPlanCreate extends BackendPlan { } /** * BackendPlanUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendPlanUpdate extends BackendPlan { } /** * BackendPlanTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendPlanTag extends TagAbstract { /** * Creates a new plan * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendPlanCreate): Promise; /** * Deletes an existing plan * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(planId: string): Promise; /** * Returns a specific plan * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(planId: string): Promise; /** * Returns a paginated list of plans * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing plan * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(planId: string, payload: BackendPlanUpdate): Promise; } /** * BackendRateAllocation automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a rate allocation, in case a request matches it gets assigned to the attached rate */ interface BackendRateAllocation { id?: number; operationId?: number; userId?: number; planId?: number; appId?: number; authenticated?: boolean; } /** * BackendRate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a rate limitation, which allows to limit the requests which a user can send */ interface BackendRate { id?: number; priority?: number; name?: string; rateLimit?: number; timespan?: string; allocation?: Array; metadata?: CommonMetadata; } /** * BackendRateCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of rate objects */ interface BackendRateCollection extends CommonCollection { } /** * BackendRateCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendRateCreate extends BackendRate { } /** * BackendRateUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendRateUpdate extends BackendRate { } /** * BackendRateTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendRateTag extends TagAbstract { /** * Creates a new rate limitation * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendRateCreate): Promise; /** * Deletes an existing rate * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(rateId: string): Promise; /** * Returns a specific rate * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(rateId: string): Promise; /** * Returns a paginated list of rate limitations * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing rate * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(rateId: string, payload: BackendRateUpdate): Promise; } /** * BackendRole automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a role, every user is assigned to a role and all scopes of the role are automatically attached to the user */ interface BackendRole { id?: number; categoryId?: number; name?: string; scopes?: Array; } /** * BackendRoleCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of role objects */ interface BackendRoleCollection extends CommonCollection { } /** * BackendRoleCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendRoleCreate extends BackendRole { } /** * BackendRoleUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendRoleUpdate extends BackendRole { } /** * BackendRoleTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendRoleTag extends TagAbstract { /** * Creates a new role * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendRoleCreate): Promise; /** * Deletes an existing role * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(roleId: string): Promise; /** * Returns a specific role * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(roleId: string): Promise; /** * Returns a paginated list of roles * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing role * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(roleId: string, payload: BackendRoleUpdate): Promise; } /** * BackendSchemaCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of schema objects */ interface BackendSchemaCollection extends CommonCollection { } /** * BackendSchemaCommit automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A schema commit which represents a change in the schema source */ interface BackendSchemaCommit { id?: number; user?: BackendUser; commitHash?: string; schema?: BackendSchemaSource; insertDate?: string; } /** * BackendSchemaCommitCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of schema commit objects */ interface BackendSchemaCommitCollection extends CommonCollection { } /** * BackendSchemaCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendSchemaCreate extends BackendSchema { } /** * BackendSchemaPreviewResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendSchemaPreviewResponse { preview?: string; } /** * BackendSchemaUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendSchemaUpdate extends BackendSchema { } /** * BackendSchemaTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendSchemaTag extends TagAbstract { /** * Creates a new schema * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendSchemaCreate): Promise; /** * Deletes an existing schema * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(schemaId: string): Promise; /** * Returns a specific schema * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(schemaId: string): Promise; /** * Returns a paginated list of schemas * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, taxonomy?: number): Promise; /** * Returns a paginated list of schema commits * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getCommits(schemaId: string, startIndex?: number, count?: number, search?: string): Promise; /** * Returns a HTML preview of the provided schema * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getPreview(schemaId: string): Promise; /** * Updates an existing schema * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(schemaId: string, payload: BackendSchemaUpdate): Promise; } /** * BackendScopeOperation automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendScopeOperation { operationId?: number; allow?: boolean; } /** * BackendScope automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a scope. A scope is assigned to a user and is required to access operations */ interface BackendScope { id?: number; name?: string; description?: string; operations?: Array; metadata?: CommonMetadata; } /** * BackendScopeCategoryScope automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendScopeCategoryScope { id?: number; name?: string; description?: string; } /** * BackendScopeCategory automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendScopeCategory { id?: number; name?: string; scopes?: Array; } /** * BackendScopeCategories automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendScopeCategories { categories?: Array; } /** * BackendScopeCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of scope objects */ interface BackendScopeCollection extends CommonCollection { } /** * BackendScopeCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendScopeCreate extends BackendScope { } /** * BackendScopeUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendScopeUpdate extends BackendScope { } /** * BackendScopeTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendScopeTag extends TagAbstract { /** * Creates a new scope * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendScopeCreate): Promise; /** * Deletes an existing scope * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(scopeId: string): Promise; /** * Returns a specific scope * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(scopeId: string): Promise; /** * Returns a paginated list of scopes * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Returns all available scopes grouped by category * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getCategories(): Promise; /** * Updates an existing scope * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(scopeId: string, payload: BackendScopeUpdate): Promise; } /** * BackendSdkGenerate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendSdkGenerate { format?: string; config?: string; } /** * BackendSdkMessage automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendSdkMessage { success?: boolean; message?: string; link?: string; } /** * BackendSdkTypes automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents available SDK type which can be generated */ interface BackendSdkTypes extends Record { } /** * BackendSdkResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendSdkResponse { types?: BackendSdkTypes; } /** * BackendSdkTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendSdkTag extends TagAbstract { /** * Generates a specific SDK * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ generate(payload: BackendSdkGenerate): Promise; /** * Returns a paginated list of SDKs * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(): Promise; } /** * BackendSpecificationChangelog automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendSpecificationChangelog { master?: any; tag?: any; version?: string; changelog?: Array; } /** * BackendSpecificationGet automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendSpecificationGet { spec?: any; } /** * BackendSpecificationPublish automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendSpecificationPublish { name?: string; filterName?: string; standalone?: boolean; } /** * BackendSpecificationTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendSpecificationTag extends TagAbstract { /** * Returns the TypeHub specification * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(): Promise; /** * Returns the changelog between your current specification and the last tag * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getChangelog(): Promise; /** * Publish the specification * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ publish(payload: BackendSpecificationPublish): Promise; /** * Creates a new tag of your specification * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ tag(payload: Passthru): Promise; } /** * BackendStatisticCount automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendStatisticCount { count?: number; from?: string; to?: string; } /** * BackendStatisticTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendStatisticTag extends TagAbstract { /** * Returns a statistic containing the activities per user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getActivitiesPerUser(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the request count * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getCountRequests(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the errors per operation * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getErrorsPerOperation(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the incoming requests * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getIncomingRequests(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the incoming transactions * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getIncomingTransactions(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the issues tokens * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getIssuedTokens(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the most used activities * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getMostUsedActivities(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the most used apps * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getMostUsedApps(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the most used operations * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getMostUsedOperations(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the requests per ip * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getRequestsPerIP(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the requests per operation * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getRequestsPerOperation(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the requests per user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getRequestsPerUser(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the test coverage * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getTestCoverage(): Promise; /** * Returns a statistic containing the time average * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getTimeAverage(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the time per operation * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getTimePerOperation(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the used points * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getUsedPoints(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; /** * Returns a statistic containing the user registrations * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getUserRegistrations(startIndex?: number, count?: number, search?: string, from?: string, to?: string, operationId?: number, appId?: number, userId?: number, ip?: string, userAgent?: string, method?: string, path?: string, header?: string, body?: string): Promise; } /** * BackendTaxonomy automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a taxonomy. A taxonomy helps to internally organize operations, actions and other entities */ interface BackendTaxonomy { id?: number; parentId?: number; name?: string; } /** * BackendTaxonomyCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of taxonomy objects */ interface BackendTaxonomyCollection extends CommonCollection { } /** * BackendTaxonomyCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendTaxonomyCreate extends BackendTaxonomy { } /** * BackendTaxonomyMove automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Moves the provided objects to a taxonomy */ interface BackendTaxonomyMove { operations?: Array; actions?: Array; schemas?: Array; events?: Array; cronjobs?: Array; triggers?: Array; } /** * BackendTaxonomyUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendTaxonomyUpdate extends BackendTaxonomy { } /** * BackendTaxonomyTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendTaxonomyTag extends TagAbstract { /** * Creates a new taxonomy * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendTaxonomyCreate): Promise; /** * Deletes an existing taxonomy * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(taxonomyId: string): Promise; /** * Returns a specific taxonomy * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(taxonomyId: string): Promise; /** * Returns a paginated list of taxonomies * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Moves the provided ids to the taxonomy * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ move(taxonomyId: string, payload: BackendTaxonomyMove): Promise; /** * Updates an existing taxonomy * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(taxonomyId: string, payload: BackendTaxonomyUpdate): Promise; } /** * BackendTenantTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendTenantTag extends TagAbstract { /** * Removes an existing tenant * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ remove(tenantId: string): Promise; /** * Setup a new tenant * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ setup(tenantId: string): Promise; } /** * BackendTestConfig automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendTestConfig extends BackendActionExecuteRequest { } /** * BackendTest automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a test. A test helps to verify that all operations work as expected */ interface BackendTest { id?: number; status?: number; operationName?: string; message?: string; response?: string; config?: BackendTestConfig; } /** * BackendTestCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of test objects */ interface BackendTestCollection extends CommonCollection { } /** * BackendTestTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendTestTag extends TagAbstract { /** * Returns a specific test * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(testId: string): Promise; /** * Returns a paginated list of tests * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Refresh all tests * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ refresh(): Promise; /** * Run all tests * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ run(): Promise; /** * Updates an existing test * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(testId: string, payload: BackendTest): Promise; } /** * BackendTokenCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of token objects */ interface BackendTokenCollection extends CommonCollection { } /** * BackendTokenTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendTokenTag extends TagAbstract { /** * Returns a specific token * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(tokenId: string): Promise; /** * Returns a paginated list of tokens * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, from?: string, to?: string, appId?: number, userId?: number, status?: number, scope?: string, ip?: string): Promise; } /** * BackendTransaction automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a transaction. The system generates a transaction in case a payment was successfully executed */ interface BackendTransaction { id?: number; userId?: number; planId?: number; transactionId?: string; amount?: number; points?: number; periodStart?: string; periodEnd?: string; insertDate?: string; } /** * BackendTransactionCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of transaction objects */ interface BackendTransactionCollection extends CommonCollection { } /** * BackendTransactionTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendTransactionTag extends TagAbstract { /** * Returns a specific transaction * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(transactionId: string): Promise; /** * Returns a paginated list of transactions * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, from?: string, to?: string, planId?: number, userId?: number, appId?: number, status?: string, provider?: string, taxonomy?: number): Promise; } /** * BackendTrashData automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendTrashData { id?: number; status?: number; name?: string; } /** * BackendTrashDataCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of deleted objects */ interface BackendTrashDataCollection extends CommonCollection { } /** * BackendTrashRestore automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendTrashRestore { id?: number; } /** * BackendTrashTypes automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendTrashTypes { types?: Array; } /** * BackendTrashTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendTrashTag extends TagAbstract { /** * Returns all deleted records by trash type * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAllByType(type: string, startIndex?: number, count?: number, search?: string): Promise; /** * Returns all trash types * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getTypes(): Promise; /** * Restores a previously deleted record * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ restore(type: string, payload: BackendTrashRestore): Promise; } /** * BackendTrigger automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a trigger which can invoke an action on a custom event */ interface BackendTrigger { id?: number; name?: string; event?: string; action?: string; metadata?: CommonMetadata; } /** * BackendTriggerCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of trigger objects */ interface BackendTriggerCollection extends CommonCollection { } /** * BackendTriggerCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendTriggerCreate extends BackendTrigger { } /** * BackendTriggerUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendTriggerUpdate extends BackendTrigger { } /** * BackendTriggerTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendTriggerTag extends TagAbstract { /** * Creates a new trigger * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendTriggerCreate): Promise; /** * Deletes an existing trigger * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(triggerId: string): Promise; /** * Returns a specific trigger * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(triggerId: string): Promise; /** * Returns a paginated list of triggers * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string, taxonomy?: number): Promise; /** * Updates an existing trigger * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(triggerId: string, payload: BackendTriggerUpdate): Promise; } /** * BackendUserCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of user objects */ interface BackendUserCollection extends CommonCollection { } /** * BackendUserCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendUserCreate extends BackendUser { password?: string; } /** * BackendUserTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendUserTag extends TagAbstract { /** * Creates a new user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendUserCreate): Promise; /** * Deletes an existing user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(userId: string): Promise; /** * Returns a specific user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(userId: string): Promise; /** * Returns a paginated list of users * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Resend the activation mail to the provided user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ resend(userId: string, payload: Passthru): Promise; /** * Updates an existing user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(userId: string, payload: BackendUserUpdate): Promise; } /** * BackendWebhookResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendWebhookResponse { id?: number; status?: number; code?: number; attempts?: number; error?: string; executeDate?: string; } /** * BackendWebhook automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents a webhook, a webhook is called in case a specific event was triggered */ interface BackendWebhook { id?: number; eventId?: number; userId?: number; name?: string; endpoint?: string; responses?: Array; } /** * BackendWebhookCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * A paginated collection of webhook objects */ interface BackendWebhookCollection extends CommonCollection { } /** * BackendWebhookCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendWebhookCreate extends BackendWebhook { } /** * BackendWebhookUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface BackendWebhookUpdate extends BackendWebhook { } /** * BackendWebhookTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendWebhookTag extends TagAbstract { /** * Creates a new webhook * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: BackendWebhookCreate): Promise; /** * Deletes an existing webhook * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(webhookId: string): Promise; /** * Returns a specific webhook * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(webhookId: string): Promise; /** * Returns a paginated list of webhooks * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing webhook * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(webhookId: string, payload: BackendWebhookUpdate): Promise; } /** * BackendTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class BackendTag extends TagAbstract { account(): BackendAccountTag; action(): BackendActionTag; agent(): BackendAgentTag; app(): BackendAppTag; audit(): BackendAuditTag; backup(): BackendBackupTag; bundle(): BackendBundleTag; category(): BackendCategoryTag; config(): BackendConfigTag; connection(): BackendConnectionTag; cronjob(): BackendCronjobTag; dashboard(): BackendDashboardTag; event(): BackendEventTag; firewall(): BackendFirewallTag; form(): BackendFormTag; generator(): BackendGeneratorTag; identity(): BackendIdentityTag; log(): BackendLogTag; marketplace(): BackendMarketplaceTag; operation(): BackendOperationTag; page(): BackendPageTag; plan(): BackendPlanTag; rate(): BackendRateTag; role(): BackendRoleTag; schema(): BackendSchemaTag; scope(): BackendScopeTag; sdk(): BackendSdkTag; specification(): BackendSpecificationTag; statistic(): BackendStatisticTag; taxonomy(): BackendTaxonomyTag; tenant(): BackendTenantTag; test(): BackendTestTag; token(): BackendTokenTag; transaction(): BackendTransactionTag; trash(): BackendTrashTag; trigger(): BackendTriggerTag; user(): BackendUserTag; webhook(): BackendWebhookTag; } /** * ConsumerScope automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerScope { id?: number; name?: string; description?: string; metadata?: CommonMetadata; } /** * ConsumerAuthorizeMeta automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerAuthorizeMeta { name?: string; url?: string; scopes?: Array; } /** * ConsumerAuthorizeRequest automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerAuthorizeRequest { responseType?: string; clientId?: string; redirectUri?: string; scope?: string; state?: string; allow?: boolean; } /** * ConsumerAuthorizeResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerAuthorizeResponse { type?: string; code?: string; error?: string; state?: string; redirectUri?: string; } /** * ConsumerUserPlan automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerUserPlan { id?: number; name?: string; price?: number; points?: number; period?: number; } /** * ConsumerUserAccount automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerUserAccount { id?: number; planId?: number; status?: number; name?: string; email?: string; points?: number; scopes?: Array; plans?: Array; metadata?: CommonMetadata; date?: string; } /** * ConsumerUserActivate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerUserActivate { token?: string; } /** * ConsumerUserEmail automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerUserEmail { email?: string; captcha?: string; } /** * ConsumerUserJWT automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerUserJWT { token?: string; expires_in?: number; refresh_token?: string; scope?: string; } /** * ConsumerUserLogin automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerUserLogin { username?: string; password?: string; scopes?: Array; } /** * ConsumerUserPasswordReset automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerUserPasswordReset { token?: string; newPassword?: string; } /** * ConsumerUserRefresh automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerUserRefresh { refresh_token?: string; } /** * ConsumerUserRegister automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerUserRegister { name?: string; email?: string; password?: string; captcha?: string; } /** * ConsumerAccountTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerAccountTag extends TagAbstract { /** * Activates an previously registered account through a token which was provided to the user via email * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ activate(payload: ConsumerUserActivate): Promise; /** * Authorizes the access of a specific app for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ authorize(payload: ConsumerAuthorizeRequest): Promise; /** * Change the password for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ changePassword(payload: BackendAccountChangePassword): Promise; /** * Change the password after the password reset flow was started * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ executePasswordReset(payload: ConsumerUserPasswordReset): Promise; /** * Returns a user data for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(): Promise; /** * Returns information about a specific app to start the OAuth2 authorization code flow * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getApp(clientId?: string, scope?: string): Promise; /** * User login by providing a username and password * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ login(payload: ConsumerUserLogin): Promise; /** * Refresh a previously obtained access token * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ refresh(payload: ConsumerUserRefresh): Promise; /** * Register a new user account * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ register(payload: ConsumerUserRegister): Promise; /** * Start the password reset flow * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ requestPasswordReset(payload: ConsumerUserEmail): Promise; /** * Updates user data for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(payload: ConsumerUserAccount): Promise; } /** * ConsumerAgent automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an agent */ interface ConsumerAgent { id?: number; name?: string; description?: string; } /** * ConsumerAgentCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a collection of agent messages */ interface ConsumerAgentCollection extends CommonCollection { } /** * ConsumerAgentMessage automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * This object represents an agent message */ interface ConsumerAgentMessage { id?: number; chatId?: string; role?: string; item?: AgentItemBinary | AgentItemChoice | AgentItemObject | AgentItemText | AgentItemToolCall; insertDate?: string; } /** * ConsumerAgentMessageCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ /** * Represents a collection of agent messages */ interface ConsumerAgentMessageCollection extends CommonCollection { } /** * ConsumerAgentMessageTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerAgentMessageTag extends TagAbstract { /** * Returns a paginated list of agent messages * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(agentId: string, chatId?: string): Promise; /** * Submits a new agent message * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ submit(agentId: string, payload: AgentInput): Promise; } /** * ConsumerAgentTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerAgentTag extends TagAbstract { message(): ConsumerAgentMessageTag; /** * Returns a specific agent * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(agentId: string): Promise; /** * Returns a paginated list of agents * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; } /** * ConsumerApp automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerApp { id?: number; userId?: number; status?: number; name?: string; url?: string; appKey?: string; appSecret?: string; date?: string; scopes?: Array; metadata?: CommonMetadata; } /** * ConsumerAppCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerAppCollection extends CommonCollection { } /** * ConsumerAppCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerAppCreate { name?: string; url?: string; scopes?: Array; } /** * ConsumerAppUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerAppUpdate { name?: string; url?: string; scopes?: Array; } /** * ConsumerAppTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerAppTag extends TagAbstract { /** * Creates a new app for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: ConsumerAppCreate): Promise; /** * Deletes an existing app for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(appId: string): Promise; /** * Returns a specific app for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(appId: string): Promise; /** * Returns a paginated list of apps which are assigned to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing app for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(appId: string, payload: ConsumerAppUpdate): Promise; } /** * ConsumerEvent automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerEvent { id?: number; name?: string; description?: string; metadata?: CommonMetadata; } /** * ConsumerEventCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerEventCollection extends CommonCollection { } /** * ConsumerEventTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerEventTag extends TagAbstract { /** * Returns a specific event for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(eventId: string): Promise; /** * Returns a paginated list of apps which are assigned to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; } /** * ConsumerForm automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerForm { id?: number; name?: string; action?: string; method?: string; jsonSchema?: any; uiSchema?: any; metadata?: CommonMetadata; } /** * ConsumerFormCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerFormCollection extends CommonCollection { } /** * ConsumerFormTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerFormTag extends TagAbstract { /** * Returns a specific form for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(formId: string): Promise; /** * Returns a paginated list of forms which are relevant to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; } /** * ConsumerGrant automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerGrant { id?: number; app?: ConsumerApp; createDate?: string; } /** * ConsumerGrantCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerGrantCollection extends CommonCollection { } /** * ConsumerGrantTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerGrantTag extends TagAbstract { /** * Deletes an existing grant for an app which was created by the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(grantId: string): Promise; /** * Returns a paginated list of grants which are assigned to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; } /** * ConsumerIdentity automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerIdentity { id?: number; name?: string; icon?: string; redirect?: string; } /** * ConsumerIdentityCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerIdentityCollection extends CommonCollection { } /** * ConsumerIdentityTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerIdentityTag extends TagAbstract { /** * Identity callback endpoint to exchange an access token * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ exchange(identity: string): Promise; /** * Returns a paginated list of identities which are relevant to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(appId?: number, appKey?: string): Promise; /** * Redirect the user to the configured identity provider * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ redirect(identity: string): Promise; } /** * ConsumerLog automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerLog { id?: number; appId?: number; ip?: string; userAgent?: string; method?: string; path?: string; header?: string; body?: string; date?: string; } /** * ConsumerLogCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerLogCollection extends CommonCollection { } /** * ConsumerLogTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerLogTag extends TagAbstract { /** * Returns a specific log for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(logId: string): Promise; /** * Returns a paginated list of logs which are assigned to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; } /** * ConsumerPage automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerPage { id?: number; title?: string; slug?: string; content?: string; metadata?: CommonMetadata; } /** * ConsumerPageCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerPageCollection extends CommonCollection { } /** * ConsumerPageTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerPageTag extends TagAbstract { /** * Returns a specific page for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(pageId: string): Promise; /** * Returns a paginated list of pages which are relevant to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; } /** * ConsumerPaymentCheckoutRequest automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerPaymentCheckoutRequest { planId?: number; returnUrl?: string; } /** * ConsumerPaymentCheckoutResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerPaymentCheckoutResponse { approvalUrl?: string; } /** * ConsumerPaymentPortalRequest automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerPaymentPortalRequest { returnUrl?: string; } /** * ConsumerPaymentPortalResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerPaymentPortalResponse { redirectUrl?: string; } /** * ConsumerPaymentTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerPaymentTag extends TagAbstract { /** * Start the checkout process for a specific plan * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ checkout(provider: string, payload: ConsumerPaymentCheckoutRequest): Promise; /** * Generates a payment portal link for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ portal(provider: string, payload: ConsumerPaymentPortalRequest): Promise; } /** * ConsumerPlan automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerPlan { id?: number; name?: string; description?: string; price?: number; points?: number; period?: number; metadata?: CommonMetadata; } /** * ConsumerPlanCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerPlanCollection extends CommonCollection { } /** * ConsumerPlanTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerPlanTag extends TagAbstract { /** * Returns a specific plan for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(planId: string): Promise; /** * Returns a paginated list of plans which are relevant to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; } /** * ConsumerScopeCategoryScope automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerScopeCategoryScope { id?: number; name?: string; description?: string; } /** * ConsumerScopeCategory automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerScopeCategory { id?: number; name?: string; scopes?: Array; } /** * ConsumerScopeCategories automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerScopeCategories { categories?: Array; } /** * ConsumerScopeCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerScopeCollection extends CommonCollection { } /** * ConsumerScopeTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerScopeTag extends TagAbstract { /** * Returns a paginated list of scopes which are assigned to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Returns all scopes by category * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getCategories(): Promise; } /** * ConsumerToken automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerToken { id?: number; status?: number; name?: string; scopes?: Array; ip?: string; expire?: string; date?: string; } /** * ConsumerTokenAccessToken automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerTokenAccessToken { access_token?: string; token_type?: string; expires_in?: number; refresh_token?: string; scope?: string; } /** * ConsumerTokenCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerTokenCollection extends CommonCollection { } /** * ConsumerTokenCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerTokenCreate { name?: string; scopes?: Array; expire?: string; } /** * ConsumerTokenUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerTokenUpdate { name?: string; expire?: string; } /** * ConsumerTokenTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerTokenTag extends TagAbstract { /** * Creates a new token for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: ConsumerTokenCreate): Promise; /** * Deletes an existing token for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(tokenId: string): Promise; /** * Returns a specific token for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(tokenId: string): Promise; /** * Returns a paginated list of tokens which are assigned to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing token for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(tokenId: string, payload: ConsumerTokenUpdate): Promise; } /** * ConsumerTransaction automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerTransaction { id?: number; userId?: number; planId?: number; plan?: ConsumerPlan; transactionId?: string; amount?: number; points?: number; periodStart?: string; periodEnd?: string; insertDate?: string; } /** * ConsumerTransactionCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerTransactionCollection extends CommonCollection { } /** * ConsumerTransactionTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerTransactionTag extends TagAbstract { /** * Returns a specific transaction for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(transactionId: string): Promise; /** * Returns a paginated list of transactions which are assigned to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; } /** * ConsumerWebhookResponse automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerWebhookResponse { status?: number; code?: number; attempts?: string; executeDate?: string; } /** * ConsumerWebhook automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerWebhook { id?: number; status?: number; event?: string; name?: string; endpoint?: string; responses?: Array; } /** * ConsumerWebhookCollection automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerWebhookCollection extends CommonCollection { } /** * ConsumerWebhookCreate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerWebhookCreate { event?: string; name?: string; endpoint?: string; } /** * ConsumerWebhookUpdate automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface ConsumerWebhookUpdate { event?: string; name?: string; endpoint?: string; } /** * ConsumerWebhookTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerWebhookTag extends TagAbstract { /** * Creates a new webhook for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ create(payload: ConsumerWebhookCreate): Promise; /** * Deletes an existing webhook for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ delete(webhookId: string): Promise; /** * Returns a specific webhook for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ get(webhookId: string): Promise; /** * Returns a paginated list of webhooks which are assigned to the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAll(startIndex?: number, count?: number, search?: string): Promise; /** * Updates an existing webhook for the authenticated user * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ update(webhookId: string, payload: ConsumerWebhookUpdate): Promise; } /** * ConsumerTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class ConsumerTag extends TagAbstract { account(): ConsumerAccountTag; agent(): ConsumerAgentTag; app(): ConsumerAppTag; event(): ConsumerEventTag; form(): ConsumerFormTag; grant(): ConsumerGrantTag; identity(): ConsumerIdentityTag; log(): ConsumerLogTag; page(): ConsumerPageTag; payment(): ConsumerPaymentTag; plan(): ConsumerPlanTag; scope(): ConsumerScopeTag; token(): ConsumerTokenTag; transaction(): ConsumerTransactionTag; webhook(): ConsumerWebhookTag; } /** * SystemConnectionTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class SystemConnectionTag extends TagAbstract { /** * Connection OAuth2 callback to authorize a connection * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ callback(name: string): Promise; } /** * SystemAboutApps automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemAboutApps extends Record { } /** * SystemAboutLink automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemAboutLink { rel?: string; href?: string; } /** * SystemAbout automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemAbout { apiVersion?: string; title?: string; description?: string; termsOfService?: string; contactName?: string; contactUrl?: string; contactEmail?: string; licenseName?: string; licenseUrl?: string; paymentCurrency?: string; categories?: Array; scopes?: Array; apps?: SystemAboutApps; links?: Array; } /** * SystemHealthCheck automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemHealthCheck { healthy?: boolean; error?: string; } /** * SystemRouteMethod automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemRouteMethod extends Record { } /** * SystemRoutePath automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemRoutePath extends Record { } /** * SystemRoute automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemRoute { routes?: SystemRoutePath; } /** * SystemSchemaTypeSchema automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemSchemaTypeSchema extends Record { } /** * SystemSchemaForm automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemSchemaForm extends Record { } /** * SystemSchema automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ interface SystemSchema { schema?: SystemSchemaTypeSchema; form?: SystemSchemaForm; } /** * SystemMetaTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class SystemMetaTag extends TagAbstract { /** * Returns meta information and links about the current installed Fusio version * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getAbout(): Promise; /** * Debug endpoint which returns the provided data * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getDebug(payload: Passthru): Promise; /** * Health check endpoint which returns information about the health status of the system * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getHealth(): Promise; /** * Returns all available routes * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getRoutes(): Promise; /** * Returns details of a specific schema * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ getSchema(name: string): Promise; } /** * SystemPaymentTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class SystemPaymentTag extends TagAbstract { /** * Payment webhook endpoint after successful purchase of a plan * * @returns {Promise} * @throws {CommonMessageException} * @throws {ClientException} */ webhook(provider: string): Promise; } /** * SystemTag automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class SystemTag extends TagAbstract { connection(): SystemConnectionTag; meta(): SystemMetaTag; payment(): SystemPaymentTag; } /** * Client automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class Client extends ClientAbstract { authorization(): AuthorizationTag; backend(): BackendTag; consumer(): ConsumerTag; system(): SystemTag; static buildAnonymous(baseUrl: string): Client; } /** * CommonMessageException automatically generated by SDKgen please do not edit this file manually * {@link https://sdkgen.app} */ declare class CommonMessageException extends KnownStatusCodeException { private payload; constructor(payload: CommonMessage); getPayload(): CommonMessage; } export { type AgentInput, type AgentItem, type AgentItemBinary, type AgentItemChoice, type AgentItemObject, type AgentItemText, type AgentItemToolCall, type AgentItemToolCallFunction, type AgentOutput, AuthorizationTag, type BackendAccountChangePassword, BackendAccountTag, type BackendAction, type BackendActionCollection, type BackendActionCommit, type BackendActionCommitCollection, type BackendActionConfig, type BackendActionCreate, type BackendActionExecuteRequest, type BackendActionExecuteRequestBody, type BackendActionExecuteResponse, type BackendActionExecuteResponseBody, type BackendActionExecuteResponseHeaders, type BackendActionIndex, type BackendActionIndexEntry, BackendActionTag, type BackendActionUpdate, type BackendAgent, type BackendAgentCollection, type BackendAgentCreate, type BackendAgentMessage, type BackendAgentMessageCollection, BackendAgentMessageTag, BackendAgentTag, type BackendAgentTool, type BackendAgentTools, type BackendAgentUpdate, type BackendApp, type BackendAppCollection, type BackendAppCreate, BackendAppTag, type BackendAppUpdate, type BackendAudit, type BackendAuditCollection, type BackendAuditObject, BackendAuditTag, type BackendBackupExport, type BackendBackupImport, type BackendBackupImportResult, BackendBackupTag, type BackendBundle, type BackendBundleCollection, type BackendBundleConfig, type BackendBundleCreate, BackendBundleTag, type BackendBundleUpdate, type BackendCategory, type BackendCategoryCollection, type BackendCategoryCreate, BackendCategoryTag, type BackendCategoryUpdate, type BackendConfig, type BackendConfigCollection, BackendConfigTag, type BackendConfigUpdate, type BackendConnection, BackendConnectionAgentTag, type BackendConnectionCollection, type BackendConnectionConfig, type BackendConnectionCreate, BackendConnectionDatabaseTag, BackendConnectionFilesystemTag, BackendConnectionHttpTag, type BackendConnectionIndex, type BackendConnectionIndexEntry, type BackendConnectionRedirectResponse, BackendConnectionSdkTag, BackendConnectionTag, type BackendConnectionUpdate, type BackendCronjob, type BackendCronjobCollection, type BackendCronjobCreate, type BackendCronjobError, BackendCronjobTag, type BackendCronjobUpdate, type BackendDashboard, BackendDashboardTag, type BackendDatabaseRow, type BackendDatabaseRowCollection, type BackendDatabaseTable, type BackendDatabaseTableCollection, type BackendDatabaseTableColumn, type BackendDatabaseTableForeignKeyConstraint, type BackendDatabaseTableIndex, type BackendEvent, type BackendEventCollection, type BackendEventCreate, BackendEventTag, type BackendEventUpdate, type BackendFile, type BackendFileCollection, type BackendFirewall, type BackendFirewallCollection, type BackendFirewallCreate, BackendFirewallTag, type BackendFirewallUpdate, type BackendForm, type BackendFormCollection, type BackendFormCreate, BackendFormTag, type BackendFormUpdate, type BackendGeneratorIndexProvider, type BackendGeneratorIndexProviders, type BackendGeneratorProvider, type BackendGeneratorProviderChangelog, type BackendGeneratorProviderConfig, BackendGeneratorTag, type BackendHttpRequest, type BackendHttpResponse, type BackendIdentity, type BackendIdentityCollection, type BackendIdentityConfig, type BackendIdentityCreate, type BackendIdentityIndex, type BackendIdentityIndexEntry, BackendIdentityTag, type BackendIdentityUpdate, type BackendLog, type BackendLogCollection, type BackendLogError, type BackendLogErrorCollection, BackendLogTag, BackendMarketplaceActionTag, BackendMarketplaceAppTag, BackendMarketplaceBundleTag, BackendMarketplaceTag, type BackendOperation, type BackendOperationCollection, type BackendOperationCreate, type BackendOperationParameters, type BackendOperationSchema, BackendOperationTag, type BackendOperationThrows, type BackendOperationUpdate, type BackendPage, type BackendPageCollection, type BackendPageCreate, BackendPageTag, type BackendPageUpdate, type BackendPlan, type BackendPlanCollection, type BackendPlanCreate, BackendPlanTag, type BackendPlanUpdate, type BackendRate, type BackendRateAllocation, type BackendRateCollection, type BackendRateCreate, BackendRateTag, type BackendRateUpdate, type BackendRole, type BackendRoleCollection, type BackendRoleCreate, BackendRoleTag, type BackendRoleUpdate, type BackendSchema, type BackendSchemaCollection, type BackendSchemaCommit, type BackendSchemaCommitCollection, type BackendSchemaCreate, type BackendSchemaPreviewResponse, type BackendSchemaSource, BackendSchemaTag, type BackendSchemaUpdate, type BackendScope, type BackendScopeCategories, type BackendScopeCategory, type BackendScopeCategoryScope, type BackendScopeCollection, type BackendScopeCreate, type BackendScopeOperation, BackendScopeTag, type BackendScopeUpdate, type BackendSdkGenerate, type BackendSdkMessage, type BackendSdkResponse, BackendSdkTag, type BackendSdkTypes, type BackendSpecificationChangelog, type BackendSpecificationGet, type BackendSpecificationPublish, BackendSpecificationTag, type BackendStatisticChart, type BackendStatisticChartSeries, type BackendStatisticCount, BackendStatisticTag, BackendTag, type BackendTaxonomy, type BackendTaxonomyCollection, type BackendTaxonomyCreate, type BackendTaxonomyMove, BackendTaxonomyTag, type BackendTaxonomyUpdate, BackendTenantTag, type BackendTest, type BackendTestCollection, type BackendTestConfig, BackendTestTag, type BackendToken, type BackendTokenCollection, BackendTokenTag, type BackendTransaction, type BackendTransactionCollection, BackendTransactionTag, type BackendTrashData, type BackendTrashDataCollection, type BackendTrashRestore, BackendTrashTag, type BackendTrashTypes, type BackendTrigger, type BackendTriggerCollection, type BackendTriggerCreate, BackendTriggerTag, type BackendTriggerUpdate, type BackendUser, type BackendUserCollection, type BackendUserCreate, BackendUserTag, type BackendUserUpdate, type BackendWebhook, type BackendWebhookCollection, type BackendWebhookCreate, type BackendWebhookResponse, BackendWebhookTag, type BackendWebhookUpdate, Client, type CommonCollection, type CommonFormContainer, type CommonFormElement, type CommonFormElementCheckbox, type CommonFormElementCollection, type CommonFormElementInput, type CommonFormElementMap, type CommonFormElementSelect, type CommonFormElementSelectOption, type CommonFormElementTextArea, type CommonFormElementTypeAPI, type CommonFormElementTypeSchema, type CommonMessage, CommonMessageException, type CommonMetadata, ConsumerAccountTag, type ConsumerAgent, type ConsumerAgentCollection, type ConsumerAgentMessage, type ConsumerAgentMessageCollection, ConsumerAgentMessageTag, ConsumerAgentTag, type ConsumerApp, type ConsumerAppCollection, type ConsumerAppCreate, ConsumerAppTag, type ConsumerAppUpdate, type ConsumerAuthorizeMeta, type ConsumerAuthorizeRequest, type ConsumerAuthorizeResponse, type ConsumerEvent, type ConsumerEventCollection, ConsumerEventTag, type ConsumerForm, type ConsumerFormCollection, ConsumerFormTag, type ConsumerGrant, type ConsumerGrantCollection, ConsumerGrantTag, type ConsumerIdentity, type ConsumerIdentityCollection, ConsumerIdentityTag, type ConsumerLog, type ConsumerLogCollection, ConsumerLogTag, type ConsumerPage, type ConsumerPageCollection, ConsumerPageTag, type ConsumerPaymentCheckoutRequest, type ConsumerPaymentCheckoutResponse, type ConsumerPaymentPortalRequest, type ConsumerPaymentPortalResponse, ConsumerPaymentTag, type ConsumerPlan, type ConsumerPlanCollection, ConsumerPlanTag, type ConsumerScope, type ConsumerScopeCategories, type ConsumerScopeCategory, type ConsumerScopeCategoryScope, type ConsumerScopeCollection, ConsumerScopeTag, ConsumerTag, type ConsumerToken, type ConsumerTokenAccessToken, type ConsumerTokenCollection, type ConsumerTokenCreate, ConsumerTokenTag, type ConsumerTokenUpdate, type ConsumerTransaction, type ConsumerTransactionCollection, ConsumerTransactionTag, type ConsumerUserAccount, type ConsumerUserActivate, type ConsumerUserEmail, type ConsumerUserJWT, type ConsumerUserLogin, type ConsumerUserPasswordReset, type ConsumerUserPlan, type ConsumerUserRefresh, type ConsumerUserRegister, type ConsumerWebhook, type ConsumerWebhookCollection, type ConsumerWebhookCreate, type ConsumerWebhookResponse, ConsumerWebhookTag, type ConsumerWebhookUpdate, type MarketplaceAction, type MarketplaceActionCollection, type MarketplaceActionConfig, type MarketplaceApp, type MarketplaceAppCollection, type MarketplaceBundle, type MarketplaceBundleAction, type MarketplaceBundleActionConfig, type MarketplaceBundleCollection, type MarketplaceBundleConfig, type MarketplaceBundleCronjob, type MarketplaceBundleEvent, type MarketplaceBundleSchema, type MarketplaceBundleSchemaSource, type MarketplaceBundleTrigger, type MarketplaceCollection, type MarketplaceInstall, type MarketplaceMessage, type MarketplaceObject, type MarketplaceUser, type Passthru, type SystemAbout, type SystemAboutApps, type SystemAboutLink, SystemConnectionTag, type SystemHealthCheck, SystemMetaTag, SystemPaymentTag, type SystemRoute, type SystemRouteMethod, type SystemRoutePath, type SystemSchema, type SystemSchemaForm, type SystemSchemaTypeSchema, SystemTag };