import type { AxiosPromise, AxiosInstance } from 'axios'; import { ApsServiceRequestConfig, IApsConfiguration, SdkManager, ApiResponse } from "@aps_sdk/autodesk-sdkmanager"; import { RequestArgs, BaseApi } from '../base'; import { Command } from '../model'; import { CommandPayload } from '../model'; /** * CommandsApi - axios parameter creator * @export */ export declare const CommandsApiAxiosParamCreator: (apsConfiguration?: IApsConfiguration) => { /** * Executes the command that you specify in the request body. Commands enable you to perform general operations on multiple resources. For example, you can check whether a user has permission to delete a collection of versions, items, and folders. The command as well as the input data for the command are specified using the ``data`` object of the request body. For more information about commands see the [Commands](/en/docs/data/v2/overview/commands/) section in the Developer\'s Guide. * @summary Execute a Command * @param {string} projectId The unique identifier of a project. For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``. Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. * @param {string} [xUserId] In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act only on behalf of the specified user. * @param {CommandPayload} [commandPayload] The request body\'s ``data`` object defines the command to execute and contains any required input data. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ executeCommand: (accessToken: string, projectId: string, xUserId?: string, commandPayload?: CommandPayload, options?: ApsServiceRequestConfig) => Promise; }; /** * CommandsApi - functional programming interface * @export */ export declare const CommandsApiFp: (sdkManager?: SdkManager) => { /** * Executes the command that you specify in the request body. Commands enable you to perform general operations on multiple resources. For example, you can check whether a user has permission to delete a collection of versions, items, and folders. The command as well as the input data for the command are specified using the ``data`` object of the request body. For more information about commands see the [Commands](/en/docs/data/v2/overview/commands/) section in the Developer\'s Guide. * @summary Execute a Command * @param {string} projectId The unique identifier of a project. For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``. Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. * @param {string} [xUserId] In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act only on behalf of the specified user. * @param {CommandPayload} [commandPayload] The request body\'s ``data`` object defines the command to execute and contains any required input data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ executeCommand(accessToken: string, projectId: string, xUserId?: string, commandPayload?: CommandPayload, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CommandsApi - interface * @export * @interface CommandsApi */ export interface CommandsApiInterface { /** * Executes the command that you specify in the request body. Commands enable you to perform general operations on multiple resources. For example, you can check whether a user has permission to delete a collection of versions, items, and folders. The command as well as the input data for the command are specified using the ``data`` object of the request body. For more information about commands see the [Commands](/en/docs/data/v2/overview/commands/) section in the Developer\'s Guide. * @summary Execute a Command * @param {string} projectId The unique identifier of a project. For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``. Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. * @param {string} [xUserId] In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act only on behalf of the specified user. * @param {CommandPayload} [commandPayload] The request body\'s ``data`` object defines the command to execute and contains any required input data. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommandsApiInterface */ executeCommand(accessToken: string, projectId: string, xUserId?: string, commandPayload?: CommandPayload, options?: ApsServiceRequestConfig): Promise; } /** * CommandsApi - object-oriented interface * @export * @class CommandsApi * @extends {BaseApi} */ export declare class CommandsApi extends BaseApi implements CommandsApiInterface { private logger; /** * Executes the command that you specify in the request body. Commands enable you to perform general operations on multiple resources. For example, you can check whether a user has permission to delete a collection of versions, items, and folders. The command as well as the input data for the command are specified using the ``data`` object of the request body. For more information about commands see the [Commands](/en/docs/data/v2/overview/commands/) section in the Developer\'s Guide. * @summary Execute a Command * @param {string} projectId The unique identifier of a project. For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``. Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. * @param {string} [xUserId] In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act only on behalf of the specified user. * @param {CommandPayload} [commandPayload] The request body\'s ``data`` object defines the command to execute and contains any required input data. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommandsApi */ executeCommand(accessToken: string, projectId: string, xUserId?: string, commandPayload?: CommandPayload, options?: ApsServiceRequestConfig): Promise; }