import { BaseResourceAPI, IdEither } from '@cognite/sdk-core'; import { IgnoreUnknownIds } from '../../types'; import { CogniteFunction, ExternalCogniteFunctionItem, FunctionListScope, FunctionsActivationResponse, FunctionsLimits } from './types'; export declare class FunctionsAPI extends BaseResourceAPI { /** * @hidden */ protected getDateProps(): [string[], string[]]; /** * [Create functions](https://developer.cognite.com/api#tag/Functions/operation/postFunctions) * * ```js * const functions = await client.functions.create([{ * name: 'My awesome function', * fileId: 5467347282343 * }]); * ``` */ create: (items: ExternalCogniteFunctionItem[]) => Promise; /** * [List functions](https://developer.cognite.com/api#tag/Functions/operation/listFunctions) * * ```js * const functions = await client.functions.list(); * ``` */ list: (scope?: FunctionListScope) => Promise; /** * [Retrieve a function by its ID](https://developer.cognite.com/api#tag/Functions/operation/getFunction) * * ```js * const func = await client.functions.retrieve([{id: 123}, {externalId: 'abc'}]); * ``` */ retrieve: (ids: IdEither[], params?: IgnoreUnknownIds) => Promise; /** * [Delete functions](https://developer.cognite.com/api#tag/Functions/operation/deleteFunctions) * * ```js * await client.functions.delete([{id: 123}, {externalId: 'abc'}]); * ``` */ delete: (ids: IdEither[], params?: IgnoreUnknownIds) => Promise<{}>; /** * [Get functions limits](https://developer.cognite.com/api#tag/Functions/operation/functionsLimits) * * Returns the service limits for Cognite Functions. * * ```js * const limits = await client.functions.limits(); * ``` */ limits: () => Promise; /** * [Activate Cognite Functions](https://developer.cognite.com/api#tag/Functions/operation/postFunctionsStatus) * * Activate Cognite Functions for the project. This will create the necessary backend infrastructure. * * ```js * const status = await client.functions.activate(); * ``` */ activate: () => Promise; /** * [Get activation status](https://developer.cognite.com/api#tag/Functions/operation/getFunctionsStatus) * * Get the activation status of Cognite Functions for the project. * * ```js * const status = await client.functions.status(); * ``` */ status: () => Promise; }