import type { AxiosPromise, AxiosInstance } from 'axios'; import { ApsServiceRequestConfig, IApsConfiguration, SdkManager, ApiResponse } from "@aps_sdk/autodesk-sdkmanager"; import { RequestArgs, BaseApi } from '../base'; import { CreatedDownload } from '../model'; import { Download } from '../model'; import { DownloadPayload } from '../model'; import { Hub } from '../model'; import { Job } from '../model'; import { Project } from '../model'; import { Projects } from '../model'; import { Storage } from '../model'; import { StoragePayload } from '../model'; import { TopFolders } from '../model'; /** * ProjectsApi - axios parameter creator * @export */ export declare const ProjectsApiAxiosParamCreator: (apsConfiguration?: IApsConfiguration) => { /** * Kicks off a job to generate the specified download format of the version. Once the job completes, the specified format becomes available for download. * @summary Create Download * @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 {DownloadPayload} [downloadPayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDownload: (accessToken: string, projectId: string, xUserId?: string, downloadPayload?: DownloadPayload, options?: ApsServiceRequestConfig) => Promise; /** * Creates a placeholder for an item or a version of an item in the OSS. Later, you can upload the binary content for the item or version to this storage location. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Create a Storage Location in OSS * @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 {StoragePayload} [storagePayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ createStorage: (accessToken: string, projectId: string, xUserId?: string, storagePayload?: StoragePayload, options?: ApsServiceRequestConfig) => Promise; /** * Returns the details of a downloadable format of a version of an item. * @summary Get Download Details * @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} downloadId The Job ID of the job used to generate the download. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDownload: (accessToken: string, projectId: string, downloadId: string, xUserId?: string, options?: ApsServiceRequestConfig) => Promise; /** * Checks the status of a job that generates a downloadable format of a version of an item. **Note**: If the job has finished, this operation returns a HTTP status 303, with the ``location`` return header set to the URI that returns the details of the download. * @summary Check Download Creation Progress * @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} jobId The unique identifier of a job. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDownloadJob: (accessToken: string, projectId: string, jobId: string, xUserId?: string, options?: ApsServiceRequestConfig) => Promise; /** * Returns a collection of active projects within the specified hub. The returned projects can be Autodesk Construction Cloud (ACC), BIM 360, BIM 360 Team, Fusion Team, and A360 Personal projects. For BIM 360 and ACC projects a hub ID corresponds to an Account ID. To convert an Account ID to a hub ID, prefix the account ID with ``b.``. For example, a BIM 360 account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``. Similarly, to convert a BIM 360 and ACC project IDs to Data Management project IDs prefix the BIM 360 or ACC Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get Projects * @param {string} hubId The unique identifier of a hub. * @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 {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {number} [pageNumber] Specifies what page to return. Page numbers are 0-based (the first page is page 0). * @param {number} [pageLimit] Specifies the maximum number of elements to return in the page. The default value is 200. The min value is 1. The max value is 200. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHubProjects: (accessToken: string, hubId: string, xUserId?: string, filterId?: Array, filterExtensionType?: Array, pageNumber?: number, pageLimit?: number, options?: ApsServiceRequestConfig) => Promise; /** * Returns the specified project from within the specified hub. For BIM 360 Docs, a hub ID corresponds to a BIM 360 account ID. To convert a BIM 360 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 a BIM 360 project ID to a Data Management project ID prefix the BIM 360 Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get a Project * @param {string} hubId The unique identifier of a hub. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject: (accessToken: string, hubId: string, projectId: string, xUserId?: string, options?: ApsServiceRequestConfig) => Promise; /** * Returns the hub that contains the project specified by the ``project_id`` parameter. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get Hub for Project * @param {string} hubId The unique identifier of a hub. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectHub: (accessToken: string, hubId: string, projectId: string, xUserId?: string, options?: ApsServiceRequestConfig) => Promise; /** * Returns the details of the highest level folders within a project that the user calling this operation has access to. The user must have at least read access to the folders. If the user is a Project Admin, it returns all top-level folders in the project. Otherwise, it returns all the highest level folders in the folder hierarchy the user has access to. Users with access permission to a folder has access permission to all its subfolders. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary List Top-level Project Folders * @param {string} hubId The unique identifier of a hub. * @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 {boolean} [excludeDeleted] Specifies whether deleted folders are excluded from the response for BIM 360 Docs projects, when user context is provided. - ``true``: Response excludes deleted folders for BIM 360 Docs projects. - ``false``: (Default) Response will not exclude deleted folders for BIM 360 Docs projects. * @param {boolean} [projectFilesOnly] Specifies what folders and subfolders to return for BIM 360 Docs projects, when user context is provided. - ``true``: Response will be restricted to folder and subfolders containing project files for BIM 360 Docs projects. - ``false``: (Default) Response will include all available folders. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectTopFolders: (accessToken: string, hubId: string, projectId: string, xUserId?: string, excludeDeleted?: boolean, projectFilesOnly?: boolean, options?: ApsServiceRequestConfig) => Promise; }; /** * ProjectsApi - functional programming interface * @export */ export declare const ProjectsApiFp: (sdkManager?: SdkManager) => { /** * Kicks off a job to generate the specified download format of the version. Once the job completes, the specified format becomes available for download. * @summary Create Download * @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 {DownloadPayload} [downloadPayload] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDownload(accessToken: string, projectId: string, xUserId?: string, downloadPayload?: DownloadPayload, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a placeholder for an item or a version of an item in the OSS. Later, you can upload the binary content for the item or version to this storage location. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Create a Storage Location in OSS * @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 {StoragePayload} [storagePayload] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createStorage(accessToken: string, projectId: string, xUserId?: string, storagePayload?: StoragePayload, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the details of a downloadable format of a version of an item. * @summary Get Download Details * @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} downloadId The Job ID of the job used to generate the download. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getDownload(accessToken: string, projectId: string, downloadId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Checks the status of a job that generates a downloadable format of a version of an item. **Note**: If the job has finished, this operation returns a HTTP status 303, with the ``location`` return header set to the URI that returns the details of the download. * @summary Check Download Creation Progress * @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} jobId The unique identifier of a job. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getDownloadJob(accessToken: string, projectId: string, jobId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a collection of active projects within the specified hub. The returned projects can be Autodesk Construction Cloud (ACC), BIM 360, BIM 360 Team, Fusion Team, and A360 Personal projects. For BIM 360 and ACC projects a hub ID corresponds to an Account ID. To convert an Account ID to a hub ID, prefix the account ID with ``b.``. For example, a BIM 360 account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``. Similarly, to convert a BIM 360 and ACC project IDs to Data Management project IDs prefix the BIM 360 or ACC Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get Projects * @param {string} hubId The unique identifier of a hub. * @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 {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {number} [pageNumber] Specifies what page to return. Page numbers are 0-based (the first page is page 0). * @param {number} [pageLimit] Specifies the maximum number of elements to return in the page. The default value is 200. The min value is 1. The max value is 200. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHubProjects(accessToken: string, hubId: string, xUserId?: string, filterId?: Array, filterExtensionType?: Array, pageNumber?: number, pageLimit?: number, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the specified project from within the specified hub. For BIM 360 Docs, a hub ID corresponds to a BIM 360 account ID. To convert a BIM 360 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 a BIM 360 project ID to a Data Management project ID prefix the BIM 360 Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get a Project * @param {string} hubId The unique identifier of a hub. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getProject(accessToken: string, hubId: string, projectId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the hub that contains the project specified by the ``project_id`` parameter. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get Hub for Project * @param {string} hubId The unique identifier of a hub. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getProjectHub(accessToken: string, hubId: string, projectId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the details of the highest level folders within a project that the user calling this operation has access to. The user must have at least read access to the folders. If the user is a Project Admin, it returns all top-level folders in the project. Otherwise, it returns all the highest level folders in the folder hierarchy the user has access to. Users with access permission to a folder has access permission to all its subfolders. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary List Top-level Project Folders * @param {string} hubId The unique identifier of a hub. * @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 {boolean} [excludeDeleted] Specifies whether deleted folders are excluded from the response for BIM 360 Docs projects, when user context is provided. - ``true``: Response excludes deleted folders for BIM 360 Docs projects. - ``false``: (Default) Response will not exclude deleted folders for BIM 360 Docs projects. * @param {boolean} [projectFilesOnly] Specifies what folders and subfolders to return for BIM 360 Docs projects, when user context is provided. - ``true``: Response will be restricted to folder and subfolders containing project files for BIM 360 Docs projects. - ``false``: (Default) Response will include all available folders. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjectTopFolders(accessToken: string, hubId: string, projectId: string, xUserId?: string, excludeDeleted?: boolean, projectFilesOnly?: boolean, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProjectsApi - interface * @export * @interface ProjectsApi */ export interface ProjectsApiInterface { /** * Kicks off a job to generate the specified download format of the version. Once the job completes, the specified format becomes available for download. * @summary Create Download * @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 {DownloadPayload} [downloadPayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApiInterface */ createDownload(accessToken: string, projectId: string, xUserId?: string, downloadPayload?: DownloadPayload, options?: ApsServiceRequestConfig): Promise; /** * Creates a placeholder for an item or a version of an item in the OSS. Later, you can upload the binary content for the item or version to this storage location. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Create a Storage Location in OSS * @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 {StoragePayload} [storagePayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApiInterface */ createStorage(accessToken: string, projectId: string, xUserId?: string, storagePayload?: StoragePayload, options?: ApsServiceRequestConfig): Promise; /** * Returns the details of a downloadable format of a version of an item. * @summary Get Download Details * @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} downloadId The Job ID of the job used to generate the download. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApiInterface */ getDownload(accessToken: string, projectId: string, downloadId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Checks the status of a job that generates a downloadable format of a version of an item. **Note**: If the job has finished, this operation returns a HTTP status 303, with the ``location`` return header set to the URI that returns the details of the download. * @summary Check Download Creation Progress * @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} jobId The unique identifier of a job. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApiInterface */ getDownloadJob(accessToken: string, projectId: string, jobId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns a collection of active projects within the specified hub. The returned projects can be Autodesk Construction Cloud (ACC), BIM 360, BIM 360 Team, Fusion Team, and A360 Personal projects. For BIM 360 and ACC projects a hub ID corresponds to an Account ID. To convert an Account ID to a hub ID, prefix the account ID with ``b.``. For example, a BIM 360 account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``. Similarly, to convert a BIM 360 and ACC project IDs to Data Management project IDs prefix the BIM 360 or ACC Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get Projects * @param {string} hubId The unique identifier of a hub. * @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 {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {number} [pageNumber] Specifies what page to return. Page numbers are 0-based (the first page is page 0). * @param {number} [pageLimit] Specifies the maximum number of elements to return in the page. The default value is 200. The min value is 1. The max value is 200. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApiInterface */ getHubProjects(accessToken: string, hubId: string, xUserId?: string, filterId?: Array, filterExtensionType?: Array, pageNumber?: number, pageLimit?: number, options?: ApsServiceRequestConfig): Promise; /** * Returns the specified project from within the specified hub. For BIM 360 Docs, a hub ID corresponds to a BIM 360 account ID. To convert a BIM 360 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 a BIM 360 project ID to a Data Management project ID prefix the BIM 360 Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get a Project * @param {string} hubId The unique identifier of a hub. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApiInterface */ getProject(accessToken: string, hubId: string, projectId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns the hub that contains the project specified by the ``project_id`` parameter. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get Hub for Project * @param {string} hubId The unique identifier of a hub. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApiInterface */ getProjectHub(accessToken: string, hubId: string, projectId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns the details of the highest level folders within a project that the user calling this operation has access to. The user must have at least read access to the folders. If the user is a Project Admin, it returns all top-level folders in the project. Otherwise, it returns all the highest level folders in the folder hierarchy the user has access to. Users with access permission to a folder has access permission to all its subfolders. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary List Top-level Project Folders * @param {string} hubId The unique identifier of a hub. * @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 {boolean} [excludeDeleted] Specifies whether deleted folders are excluded from the response for BIM 360 Docs projects, when user context is provided. - ``true``: Response excludes deleted folders for BIM 360 Docs projects. - ``false``: (Default) Response will not exclude deleted folders for BIM 360 Docs projects. * @param {boolean} [projectFilesOnly] Specifies what folders and subfolders to return for BIM 360 Docs projects, when user context is provided. - ``true``: Response will be restricted to folder and subfolders containing project files for BIM 360 Docs projects. - ``false``: (Default) Response will include all available folders. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApiInterface */ getProjectTopFolders(accessToken: string, hubId: string, projectId: string, xUserId?: string, excludeDeleted?: boolean, projectFilesOnly?: boolean, options?: ApsServiceRequestConfig): Promise; } /** * ProjectsApi - object-oriented interface * @export * @class ProjectsApi * @extends {BaseApi} */ export declare class ProjectsApi extends BaseApi implements ProjectsApiInterface { private logger; /** * Kicks off a job to generate the specified download format of the version. Once the job completes, the specified format becomes available for download. * @summary Create Download * @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 {DownloadPayload} [downloadPayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ createDownload(accessToken: string, projectId: string, xUserId?: string, downloadPayload?: DownloadPayload, options?: ApsServiceRequestConfig): Promise; /** * Creates a placeholder for an item or a version of an item in the OSS. Later, you can upload the binary content for the item or version to this storage location. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Create a Storage Location in OSS * @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 {StoragePayload} [storagePayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ createStorage(accessToken: string, projectId: string, xUserId?: string, storagePayload?: StoragePayload, options?: ApsServiceRequestConfig): Promise; /** * Returns the details of a downloadable format of a version of an item. * @summary Get Download Details * @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} downloadId The Job ID of the job used to generate the download. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getDownload(accessToken: string, projectId: string, downloadId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Checks the status of a job that generates a downloadable format of a version of an item. **Note**: If the job has finished, this operation returns a HTTP status 303, with the ``location`` return header set to the URI that returns the details of the download. * @summary Check Download Creation Progress * @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} jobId The unique identifier of a job. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getDownloadJob(accessToken: string, projectId: string, jobId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns a collection of active projects within the specified hub. The returned projects can be Autodesk Construction Cloud (ACC), BIM 360, BIM 360 Team, Fusion Team, and A360 Personal projects. For BIM 360 and ACC projects a hub ID corresponds to an Account ID. To convert an Account ID to a hub ID, prefix the account ID with ``b.``. For example, a BIM 360 account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``. Similarly, to convert a BIM 360 and ACC project IDs to Data Management project IDs prefix the BIM 360 or ACC Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get Projects * @param {string} hubId The unique identifier of a hub. * @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 {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {number} [pageNumber] Specifies what page to return. Page numbers are 0-based (the first page is page 0). * @param {number} [pageLimit] Specifies the maximum number of elements to return in the page. The default value is 200. The min value is 1. The max value is 200. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getHubProjects(accessToken: string, hubId: string, xUserId?: string, filterId?: Array, filterExtensionType?: Array, pageNumber?: number, pageLimit?: number, options?: ApsServiceRequestConfig): Promise; /** * Returns the specified project from within the specified hub. For BIM 360 Docs, a hub ID corresponds to a BIM 360 account ID. To convert a BIM 360 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 a BIM 360 project ID to a Data Management project ID prefix the BIM 360 Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get a Project * @param {string} hubId The unique identifier of a hub. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProject(accessToken: string, hubId: string, projectId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns the hub that contains the project specified by the ``project_id`` parameter. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary Get Hub for Project * @param {string} hubId The unique identifier of a hub. * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProjectHub(accessToken: string, hubId: string, projectId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns the details of the highest level folders within a project that the user calling this operation has access to. The user must have at least read access to the folders. If the user is a Project Admin, it returns all top-level folders in the project. Otherwise, it returns all the highest level folders in the folder hierarchy the user has access to. Users with access permission to a folder has access permission to all its subfolders. **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). * @summary List Top-level Project Folders * @param {string} hubId The unique identifier of a hub. * @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 {boolean} [excludeDeleted] Specifies whether deleted folders are excluded from the response for BIM 360 Docs projects, when user context is provided. - ``true``: Response excludes deleted folders for BIM 360 Docs projects. - ``false``: (Default) Response will not exclude deleted folders for BIM 360 Docs projects. * @param {boolean} [projectFilesOnly] Specifies what folders and subfolders to return for BIM 360 Docs projects, when user context is provided. - ``true``: Response will be restricted to folder and subfolders containing project files for BIM 360 Docs projects. - ``false``: (Default) Response will include all available folders. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProjectTopFolders(accessToken: string, hubId: string, projectId: string, xUserId?: string, excludeDeleted?: boolean, projectFilesOnly?: boolean, options?: ApsServiceRequestConfig): Promise; }