import type { AxiosPromise, AxiosInstance } from 'axios'; import { ApsServiceRequestConfig, IApsConfiguration, SdkManager, ApiResponse } from "@aps_sdk/autodesk-sdkmanager"; import { RequestArgs, BaseApi } from '../base'; import { FilterDirection } from '../model'; import { FilterRefType } from '../model'; import { FilterType } from '../model'; import { FilterTypeVersion } from '../model'; import { Folder } from '../model'; import { FolderContents } from '../model'; import { FolderPayload } from '../model'; import { FolderRefs } from '../model'; import { ModifyFolderPayload } from '../model'; import { RelationshipLinks } from '../model'; import { RelationshipRefs } from '../model'; import { RelationshipRefsPayload } from '../model'; import { Search } from '../model'; /** * FoldersApi - axios parameter creator * @export */ export declare const FoldersApiAxiosParamCreator: (apsConfiguration?: IApsConfiguration) => { /** * Creates a new folder in the specified project. Use the ``parent`` attribute in the request body to specify where in the hierarchy the new folder should be located. Folders can be nested up to 25 levels deep. Use the `Modify a Folder `_ operation to delete and restore folders. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **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 Folder * @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 {FolderPayload} [folderPayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolder: (accessToken: string, projectId: string, xUserId?: string, folderPayload?: FolderPayload, options?: ApsServiceRequestConfig) => Promise; /** * Creates a custom relationship between a folder and another resource within the data domain service (folder, item, or version). * @summary Create a Custom Relationship for a Folder * @param {string} folderId The unique identifier of a folder. * @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 {RelationshipRefsPayload} [relationshipRefsPayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolderRelationshipsRef: (accessToken: string, folderId: string, projectId: string, xUserId?: string, relationshipRefsPayload?: RelationshipRefsPayload, options?: ApsServiceRequestConfig) => Promise; /** * Returns the folder specified by the ``folder_id`` parameter from within the project identified by the ``project_id`` parameter. All folders and subfolders within a project (including the root folder) have a unique ID. **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 Folder * @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} folderId The unique identifier of a folder. * @param {string} [ifModifiedSince] Specify a date in the ``YYYY-MM-DDThh:mm:ss.sz`` format. If the resource has not been modified since the specified date/time, the response will return a HTTP status of 304 without any response body; the ``Last-Modified`` response header will contain the date of last modification. * @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} */ getFolder: (accessToken: string, projectId: string, folderId: string, ifModifiedSince?: string, xUserId?: string, options?: ApsServiceRequestConfig) => Promise; /** * Returns a list of items and folders within the specified folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc. The resources contained in the ``included`` array of the response are their tip versions. **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 Folder Contents * @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} folderId The unique identifier of a folder. * @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} [filterType] Filter by the type of the objects in the folder. Supported values are ``folders`` and ``items``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {Array} [filterLastModifiedTimeRollup] Filter by the ``lastModifiedTimeRollup`` attribute. Supported values are date-time string in the form ``YYYY-MM-DDTHH:MM:SS.000000Z`` or ``YYYY-MM-DDTHH:MM:SS`` based on RFC3339. * @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 {boolean} [includeHidden] ``true``: Response will contain items and folders that were deleted from BIM 360 Docs projects. ``false``: (Default): Response will not contain items and folders that were deleted from BIM 360 Docs projects. To return only items and folders that were deleted from BIM 360 Docs projects, see the documentation on [Filtering](/en/docs/data/v2/overview/filtering/). * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFolderContents: (accessToken: string, projectId: string, folderId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterExtensionType?: Array, filterLastModifiedTimeRollup?: Array, pageNumber?: number, pageLimit?: number, includeHidden?: boolean, options?: ApsServiceRequestConfig) => Promise; /** * Returns the parent folder of the specified folder. In a project, folders are organized in a hierarchy. Each folder except for the root folder has a parent folder. **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 Parent of a Folder * @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} folderId The unique identifier of a folder. * @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} */ getFolderParent: (accessToken: string, projectId: string, folderId: string, xUserId?: string, options?: ApsServiceRequestConfig) => Promise; /** * Returns the resources (items, folders, and versions) that have a custom relationship with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. **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 Related Resources for a Folder * @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} folderId The unique identifier of a folder. * @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} [filterType] Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFolderRefs: (accessToken: string, projectId: string, folderId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterExtensionType?: Array, options?: ApsServiceRequestConfig) => Promise; /** * Returns a list of links for the specified folder. Custom relationships can be established between a folder and other external resources residing outside the data domain service. A link’s ``href`` attribute defines the target URI to access a resource. **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 Relationship Links for a Folder * @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} folderId The unique identifier of a folder. * @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} */ getFolderRelationshipsLinks: (accessToken: string, projectId: string, folderId: string, xUserId?: string, options?: ApsServiceRequestConfig) => Promise; /** * Returns the custom relationships associated with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the ID of the object at the other end of the relationship, together with type, specific reference meta including extension data. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. The response body will have an included array that contains the resources in the relationship, which is essentially what is returned by the [List Related Resources for a Folder](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-refs-GET/) operation. **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 Custom Relationships for a Folder * @param {string} folderId The unique identifier of a folder. * @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 {Array} [filterType] Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {FilterRefType} [filterRefType] Filter by ``refType``. Possible values: ``derived``, ``dependencies``, ``auxiliary``, ``xrefs``, and ``includes``. * @param {FilterDirection} [filterDirection] Filter by the direction of the reference. Possible values: ``from`` and ``to``. * @param {Array} [filterExtensionType] Filter by the extension type. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFolderRelationshipsRefs: (accessToken: string, folderId: string, projectId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterRefType?: FilterRefType, filterDirection?: FilterDirection, filterExtensionType?: Array, options?: ApsServiceRequestConfig) => Promise; /** * Searches the specified folder and its subfolders and returns a list of the latest versions of the items you can access. Use the ``filter`` query string parameter to narrow down the list as appropriate. You can filter by the following properties of the version payload: - ``type`` property, - ``id`` property, - any of the attributes object properties. For example, you can filter by ``createTime`` and ``mimeType``. It returns tip versions (latest versions) of properties where the filter conditions are satisfied. To verify the properties of the attributes object for a specific version, use the [Get a Version](/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-GET/) operation. To list the immediate contents of the folder without parsing subfolders, use the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. **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 Folder and Subfolder Contents * @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} folderId The unique identifier of a folder. * @param {Array} [filter] Filter the data. See the [Filtering](/en/docs/data/v2/overview/filtering/) section for details. * @param {number} [pageNumber] Specifies what page to return. Page numbers are 0-based (the first page is page 0). * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFolderSearch: (accessToken: string, projectId: string, folderId: string, filterFieldName?: string, filter?: Array, pageNumber?: number, options?: ApsServiceRequestConfig) => Promise; /** * Renames, moves, hides, or unhides a folder. Marking a BIM 360 Docs folder as hidden effectively deletes it. You can restore it by changing its ``hidden`` attribute. You can also move BIM 360 Docs folders by changing their parent folder. You cannot permanently delete BIM 360 Docs folders. They are tagged as hidden folders and are removed from the BIM 360 Docs UI and from regular Data Management API responses. You can use the hidden filter (``filter[hidden]=true``) to get a list of deleted folders with the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](/en.docs.acc.v1/overview/introduction/). * @summary Modify a Folder * @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} folderId The unique identifier of a folder. * @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 {ModifyFolderPayload} [modifyFolderPayload] Describe the folder to be patched. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFolder: (accessToken: string, projectId: string, folderId: string, xUserId?: string, modifyFolderPayload?: ModifyFolderPayload, options?: ApsServiceRequestConfig) => Promise; }; /** * FoldersApi - functional programming interface * @export */ export declare const FoldersApiFp: (sdkManager?: SdkManager) => { /** * Creates a new folder in the specified project. Use the ``parent`` attribute in the request body to specify where in the hierarchy the new folder should be located. Folders can be nested up to 25 levels deep. Use the `Modify a Folder `_ operation to delete and restore folders. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **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 Folder * @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 {FolderPayload} [folderPayload] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolder(accessToken: string, projectId: string, xUserId?: string, folderPayload?: FolderPayload, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a custom relationship between a folder and another resource within the data domain service (folder, item, or version). * @summary Create a Custom Relationship for a Folder * @param {string} folderId The unique identifier of a folder. * @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 {RelationshipRefsPayload} [relationshipRefsPayload] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolderRelationshipsRef(accessToken: string, folderId: string, projectId: string, xUserId?: string, relationshipRefsPayload?: RelationshipRefsPayload, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the folder specified by the ``folder_id`` parameter from within the project identified by the ``project_id`` parameter. All folders and subfolders within a project (including the root folder) have a unique ID. **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 Folder * @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} folderId The unique identifier of a folder. * @param {string} [ifModifiedSince] Specify a date in the ``YYYY-MM-DDThh:mm:ss.sz`` format. If the resource has not been modified since the specified date/time, the response will return a HTTP status of 304 without any response body; the ``Last-Modified`` response header will contain the date of last modification. * @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} */ getFolder(accessToken: string, projectId: string, folderId: string, ifModifiedSince?: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of items and folders within the specified folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc. The resources contained in the ``included`` array of the response are their tip versions. **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 Folder Contents * @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} folderId The unique identifier of a folder. * @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} [filterType] Filter by the type of the objects in the folder. Supported values are ``folders`` and ``items``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {Array} [filterLastModifiedTimeRollup] Filter by the ``lastModifiedTimeRollup`` attribute. Supported values are date-time string in the form ``YYYY-MM-DDTHH:MM:SS.000000Z`` or ``YYYY-MM-DDTHH:MM:SS`` based on RFC3339. * @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 {boolean} [includeHidden] ``true``: Response will contain items and folders that were deleted from BIM 360 Docs projects. ``false``: (Default): Response will not contain items and folders that were deleted from BIM 360 Docs projects. To return only items and folders that were deleted from BIM 360 Docs projects, see the documentation on [Filtering](/en/docs/data/v2/overview/filtering/). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFolderContents(accessToken: string, projectId: string, folderId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterExtensionType?: Array, filterLastModifiedTimeRollup?: Array, pageNumber?: number, pageLimit?: number, includeHidden?: boolean, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the parent folder of the specified folder. In a project, folders are organized in a hierarchy. Each folder except for the root folder has a parent folder. **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 Parent of a Folder * @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} folderId The unique identifier of a folder. * @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} */ getFolderParent(accessToken: string, projectId: string, folderId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the resources (items, folders, and versions) that have a custom relationship with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. **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 Related Resources for a Folder * @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} folderId The unique identifier of a folder. * @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} [filterType] Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFolderRefs(accessToken: string, projectId: string, folderId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterExtensionType?: Array, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of links for the specified folder. Custom relationships can be established between a folder and other external resources residing outside the data domain service. A link’s ``href`` attribute defines the target URI to access a resource. **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 Relationship Links for a Folder * @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} folderId The unique identifier of a folder. * @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} */ getFolderRelationshipsLinks(accessToken: string, projectId: string, folderId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the custom relationships associated with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the ID of the object at the other end of the relationship, together with type, specific reference meta including extension data. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. The response body will have an included array that contains the resources in the relationship, which is essentially what is returned by the [List Related Resources for a Folder](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-refs-GET/) operation. **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 Custom Relationships for a Folder * @param {string} folderId The unique identifier of a folder. * @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 {Array} [filterType] Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {FilterRefType} [filterRefType] Filter by ``refType``. Possible values: ``derived``, ``dependencies``, ``auxiliary``, ``xrefs``, and ``includes``. * @param {FilterDirection} [filterDirection] Filter by the direction of the reference. Possible values: ``from`` and ``to``. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFolderRelationshipsRefs(accessToken: string, folderId: string, projectId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterRefType?: FilterRefType, filterDirection?: FilterDirection, filterExtensionType?: Array, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Searches the specified folder and its subfolders and returns a list of the latest versions of the items you can access. Use the ``filter`` query string parameter to narrow down the list as appropriate. You can filter by the following properties of the version payload: - ``type`` property, - ``id`` property, - any of the attributes object properties. For example, you can filter by ``createTime`` and ``mimeType``. It returns tip versions (latest versions) of properties where the filter conditions are satisfied. To verify the properties of the attributes object for a specific version, use the [Get a Version](/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-GET/) operation. To list the immediate contents of the folder without parsing subfolders, use the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. **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 Folder and Subfolder Contents * @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} folderId The unique identifier of a folder. * @param {Array} [filter] Filter the data. See the [Filtering](/en/docs/data/v2/overview/filtering/) section for details. * @param {number} [pageNumber] Specifies what page to return. Page numbers are 0-based (the first page is page 0). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFolderSearch(accessToken: string, projectId: string, folderId: string, filterFieldName?: string, filter?: Array, pageNumber?: number, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Renames, moves, hides, or unhides a folder. Marking a BIM 360 Docs folder as hidden effectively deletes it. You can restore it by changing its ``hidden`` attribute. You can also move BIM 360 Docs folders by changing their parent folder. You cannot permanently delete BIM 360 Docs folders. They are tagged as hidden folders and are removed from the BIM 360 Docs UI and from regular Data Management API responses. You can use the hidden filter (``filter[hidden]=true``) to get a list of deleted folders with the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](/en.docs.acc.v1/overview/introduction/). * @summary Modify a Folder * @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} folderId The unique identifier of a folder. * @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 {ModifyFolderPayload} [modifyFolderPayload] Describe the folder to be patched. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFolder(accessToken: string, projectId: string, folderId: string, xUserId?: string, modifyFolderPayload?: ModifyFolderPayload, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FoldersApi - interface * @export * @interface FoldersApi */ export interface FoldersApiInterface { /** * Creates a new folder in the specified project. Use the ``parent`` attribute in the request body to specify where in the hierarchy the new folder should be located. Folders can be nested up to 25 levels deep. Use the `Modify a Folder `_ operation to delete and restore folders. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **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 Folder * @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 {FolderPayload} [folderPayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApiInterface */ createFolder(accessToken: string, projectId: string, xUserId?: string, folderPayload?: FolderPayload, options?: ApsServiceRequestConfig): Promise; /** * Creates a custom relationship between a folder and another resource within the data domain service (folder, item, or version). * @summary Create a Custom Relationship for a Folder * @param {string} folderId The unique identifier of a folder. * @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 {RelationshipRefsPayload} [relationshipRefsPayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApiInterface */ createFolderRelationshipsRef(accessToken: string, folderId: string, projectId: string, xUserId?: string, relationshipRefsPayload?: RelationshipRefsPayload, options?: ApsServiceRequestConfig): Promise; /** * Returns the folder specified by the ``folder_id`` parameter from within the project identified by the ``project_id`` parameter. All folders and subfolders within a project (including the root folder) have a unique ID. **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 Folder * @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} folderId The unique identifier of a folder. * @param {string} [ifModifiedSince] Specify a date in the ``YYYY-MM-DDThh:mm:ss.sz`` format. If the resource has not been modified since the specified date/time, the response will return a HTTP status of 304 without any response body; the ``Last-Modified`` response header will contain the date of last modification. * @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 FoldersApiInterface */ getFolder(accessToken: string, projectId: string, folderId: string, ifModifiedSince?: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns a list of items and folders within the specified folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc. The resources contained in the ``included`` array of the response are their tip versions. **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 Folder Contents * @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} folderId The unique identifier of a folder. * @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} [filterType] Filter by the type of the objects in the folder. Supported values are ``folders`` and ``items``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {Array} [filterLastModifiedTimeRollup] Filter by the ``lastModifiedTimeRollup`` attribute. Supported values are date-time string in the form ``YYYY-MM-DDTHH:MM:SS.000000Z`` or ``YYYY-MM-DDTHH:MM:SS`` based on RFC3339. * @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 {boolean} [includeHidden] ``true``: Response will contain items and folders that were deleted from BIM 360 Docs projects. ``false``: (Default): Response will not contain items and folders that were deleted from BIM 360 Docs projects. To return only items and folders that were deleted from BIM 360 Docs projects, see the documentation on [Filtering](/en/docs/data/v2/overview/filtering/). * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApiInterface */ getFolderContents(accessToken: string, projectId: string, folderId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterExtensionType?: Array, filterLastModifiedTimeRollup?: Array, pageNumber?: number, pageLimit?: number, includeHidden?: boolean, options?: ApsServiceRequestConfig): Promise; /** * Returns the parent folder of the specified folder. In a project, folders are organized in a hierarchy. Each folder except for the root folder has a parent folder. **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 Parent of a Folder * @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} folderId The unique identifier of a folder. * @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 FoldersApiInterface */ getFolderParent(accessToken: string, projectId: string, folderId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns the resources (items, folders, and versions) that have a custom relationship with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. **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 Related Resources for a Folder * @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} folderId The unique identifier of a folder. * @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} [filterType] Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApiInterface */ getFolderRefs(accessToken: string, projectId: string, folderId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterExtensionType?: Array, options?: ApsServiceRequestConfig): Promise; /** * Returns a list of links for the specified folder. Custom relationships can be established between a folder and other external resources residing outside the data domain service. A link’s ``href`` attribute defines the target URI to access a resource. **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 Relationship Links for a Folder * @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} folderId The unique identifier of a folder. * @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 FoldersApiInterface */ getFolderRelationshipsLinks(accessToken: string, projectId: string, folderId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns the custom relationships associated with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the ID of the object at the other end of the relationship, together with type, specific reference meta including extension data. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. The response body will have an included array that contains the resources in the relationship, which is essentially what is returned by the [List Related Resources for a Folder](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-refs-GET/) operation. **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 Custom Relationships for a Folder * @param {string} folderId The unique identifier of a folder. * @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 {Array} [filterType] Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {FilterRefType} [filterRefType] Filter by ``refType``. Possible values: ``derived``, ``dependencies``, ``auxiliary``, ``xrefs``, and ``includes``. * @param {FilterDirection} [filterDirection] Filter by the direction of the reference. Possible values: ``from`` and ``to``. * @param {Array} [filterExtensionType] Filter by the extension type. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApiInterface */ getFolderRelationshipsRefs(accessToken: string, folderId: string, projectId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterRefType?: FilterRefType, filterDirection?: FilterDirection, filterExtensionType?: Array, options?: ApsServiceRequestConfig): Promise; /** * Searches the specified folder and its subfolders and returns a list of the latest versions of the items you can access. Use the ``filter`` query string parameter to narrow down the list as appropriate. You can filter by the following properties of the version payload: - ``type`` property, - ``id`` property, - any of the attributes object properties. For example, you can filter by ``createTime`` and ``mimeType``. It returns tip versions (latest versions) of properties where the filter conditions are satisfied. To verify the properties of the attributes object for a specific version, use the [Get a Version](/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-GET/) operation. To list the immediate contents of the folder without parsing subfolders, use the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. **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 Folder and Subfolder Contents * @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} folderId The unique identifier of a folder. * @param {Array} [filter] Filter the data. See the [Filtering](/en/docs/data/v2/overview/filtering/) section for details. * @param {number} [pageNumber] Specifies what page to return. Page numbers are 0-based (the first page is page 0). * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApiInterface */ getFolderSearch(accessToken: string, projectId: string, folderId: string, filterFieldName?: string, filter?: Array, pageNumber?: number, options?: ApsServiceRequestConfig): Promise; /** * Renames, moves, hides, or unhides a folder. Marking a BIM 360 Docs folder as hidden effectively deletes it. You can restore it by changing its ``hidden`` attribute. You can also move BIM 360 Docs folders by changing their parent folder. You cannot permanently delete BIM 360 Docs folders. They are tagged as hidden folders and are removed from the BIM 360 Docs UI and from regular Data Management API responses. You can use the hidden filter (``filter[hidden]=true``) to get a list of deleted folders with the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](/en.docs.acc.v1/overview/introduction/). * @summary Modify a Folder * @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} folderId The unique identifier of a folder. * @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 {ModifyFolderPayload} [modifyFolderPayload] Describe the folder to be patched. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApiInterface */ patchFolder(accessToken: string, projectId: string, folderId: string, xUserId?: string, modifyFolderPayload?: ModifyFolderPayload, options?: ApsServiceRequestConfig): Promise; } /** * FoldersApi - object-oriented interface * @export * @class FoldersApi * @extends {BaseApi} */ export declare class FoldersApi extends BaseApi implements FoldersApiInterface { private logger; /** * Creates a new folder in the specified project. Use the ``parent`` attribute in the request body to specify where in the hierarchy the new folder should be located. Folders can be nested up to 25 levels deep. Use the `Modify a Folder `_ operation to delete and restore folders. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **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 Folder * @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 {FolderPayload} [folderPayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ createFolder(accessToken: string, projectId: string, xUserId?: string, folderPayload?: FolderPayload, options?: ApsServiceRequestConfig): Promise; /** * Creates a custom relationship between a folder and another resource within the data domain service (folder, item, or version). * @summary Create a Custom Relationship for a Folder * @param {string} folderId The unique identifier of a folder. * @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 {RelationshipRefsPayload} [relationshipRefsPayload] * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ createFolderRelationshipsRef(accessToken: string, folderId: string, projectId: string, xUserId?: string, relationshipRefsPayload?: RelationshipRefsPayload, options?: ApsServiceRequestConfig): Promise; /** * Returns the folder specified by the ``folder_id`` parameter from within the project identified by the ``project_id`` parameter. All folders and subfolders within a project (including the root folder) have a unique ID. **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 Folder * @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} folderId The unique identifier of a folder. * @param {string} [ifModifiedSince] Specify a date in the ``YYYY-MM-DDThh:mm:ss.sz`` format. If the resource has not been modified since the specified date/time, the response will return a HTTP status of 304 without any response body; the ``Last-Modified`` response header will contain the date of last modification. * @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 FoldersApi */ getFolder(accessToken: string, projectId: string, folderId: string, ifModifiedSince?: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns a list of items and folders within the specified folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc. The resources contained in the ``included`` array of the response are their tip versions. **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 Folder Contents * @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} folderId The unique identifier of a folder. * @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} [filterType] Filter by the type of the objects in the folder. Supported values are ``folders`` and ``items``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {Array} [filterLastModifiedTimeRollup] Filter by the ``lastModifiedTimeRollup`` attribute. Supported values are date-time string in the form ``YYYY-MM-DDTHH:MM:SS.000000Z`` or ``YYYY-MM-DDTHH:MM:SS`` based on RFC3339. * @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 {boolean} [includeHidden] ``true``: Response will contain items and folders that were deleted from BIM 360 Docs projects. ``false``: (Default): Response will not contain items and folders that were deleted from BIM 360 Docs projects. To return only items and folders that were deleted from BIM 360 Docs projects, see the documentation on [Filtering](/en/docs/data/v2/overview/filtering/). * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ getFolderContents(accessToken: string, projectId: string, folderId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterExtensionType?: Array, filterLastModifiedTimeRollup?: Array, pageNumber?: number, pageLimit?: number, includeHidden?: boolean, options?: ApsServiceRequestConfig): Promise; /** * Returns the parent folder of the specified folder. In a project, folders are organized in a hierarchy. Each folder except for the root folder has a parent folder. **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 Parent of a Folder * @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} folderId The unique identifier of a folder. * @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 FoldersApi */ getFolderParent(accessToken: string, projectId: string, folderId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns the resources (items, folders, and versions) that have a custom relationship with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. **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 Related Resources for a Folder * @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} folderId The unique identifier of a folder. * @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} [filterType] Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ getFolderRefs(accessToken: string, projectId: string, folderId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterExtensionType?: Array, options?: ApsServiceRequestConfig): Promise; /** * Returns a list of links for the specified folder. Custom relationships can be established between a folder and other external resources residing outside the data domain service. A link’s ``href`` attribute defines the target URI to access a resource. **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 Relationship Links for a Folder * @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} folderId The unique identifier of a folder. * @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 FoldersApi */ getFolderRelationshipsLinks(accessToken: string, projectId: string, folderId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns the custom relationships associated with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the ID of the object at the other end of the relationship, together with type, specific reference meta including extension data. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. The response body will have an included array that contains the resources in the relationship, which is essentially what is returned by the [List Related Resources for a Folder](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-refs-GET/) operation. **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 Custom Relationships for a Folder * @param {string} folderId The unique identifier of a folder. * @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 {Array} [filterType] Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``. * @param {Array} [filterId] Filter by the ``id`` of the ``ref`` target. * @param {FilterRefType} [filterRefType] Filter by ``refType``. Possible values: ``derived``, ``dependencies``, ``auxiliary``, ``xrefs``, and ``includes``. * @param {FilterDirection} [filterDirection] Filter by the direction of the reference. Possible values: ``from`` and ``to``. * @param {Array} [filterExtensionType] Filter by the extension type. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ getFolderRelationshipsRefs(accessToken: string, folderId: string, projectId: string, xUserId?: string, filterType?: Array, filterId?: Array, filterRefType?: FilterRefType, filterDirection?: FilterDirection, filterExtensionType?: Array, options?: ApsServiceRequestConfig): Promise; /** * Searches the specified folder and its subfolders and returns a list of the latest versions of the items you can access. Use the ``filter`` query string parameter to narrow down the list as appropriate. You can filter by the following properties of the version payload: - ``type`` property, - ``id`` property, - any of the attributes object properties. For example, you can filter by ``createTime`` and ``mimeType``. It returns tip versions (latest versions) of properties where the filter conditions are satisfied. To verify the properties of the attributes object for a specific version, use the [Get a Version](/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-GET/) operation. To list the immediate contents of the folder without parsing subfolders, use the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. **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 Folder and Subfolder Contents * @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} folderId The unique identifier of a folder. * @param {Array} [filter] Filter the data. See the [Filtering](/en/docs/data/v2/overview/filtering/) section for details. * @param {number} [pageNumber] Specifies what page to return. Page numbers are 0-based (the first page is page 0). * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ getFolderSearch(accessToken: string, projectId: string, folderId: string, filterFieldName?: string, filter?: Array, pageNumber?: number, options?: ApsServiceRequestConfig): Promise; /** * Renames, moves, hides, or unhides a folder. Marking a BIM 360 Docs folder as hidden effectively deletes it. You can restore it by changing its ``hidden`` attribute. You can also move BIM 360 Docs folders by changing their parent folder. You cannot permanently delete BIM 360 Docs folders. They are tagged as hidden folders and are removed from the BIM 360 Docs UI and from regular Data Management API responses. You can use the hidden filter (``filter[hidden]=true``) to get a list of deleted folders with the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](/en.docs.acc.v1/overview/introduction/). * @summary Modify a Folder * @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} folderId The unique identifier of a folder. * @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 {ModifyFolderPayload} [modifyFolderPayload] Describe the folder to be patched. * @param accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ patchFolder(accessToken: string, projectId: string, folderId: string, xUserId?: string, modifyFolderPayload?: ModifyFolderPayload, options?: ApsServiceRequestConfig): Promise; }