import type { AxiosPromise, AxiosInstance } from 'axios'; import { ApsServiceRequestConfig, IApsConfiguration, SdkManager, ApiResponse } from "@aps_sdk/autodesk-sdkmanager"; import { RequestArgs, BaseApi } from '../base'; import { Hub } from '../model'; import { Hubs } from '../model'; /** * HubsApi - axios parameter creator * @export */ export declare const HubsApiAxiosParamCreator: (apsConfiguration?: IApsConfiguration) => { /** * Returns the hub specified by the ``hub_id`` parameter. 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``. **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 Hub * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHub: (accessToken: string, hubId: string, xUserId?: string, options?: ApsServiceRequestConfig) => Promise; /** * Returns a collection of hubs that the user of your app can access. The returned hubs can be BIM 360 Team hubs, Fusion Team hubs (formerly known as A360 Team hubs), A360 Personal hubs, ACC Docs (Autodesk Docs) accounts, or BIM 360 Docs accounts. Only active hubs are returned. 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``. **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 Hubs * @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} [filterName] Filter by the ``name`` 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} */ getHubs: (accessToken: string, xUserId?: string, filterId?: Array, filterName?: Array, filterExtensionType?: Array, options?: ApsServiceRequestConfig) => Promise; }; /** * HubsApi - functional programming interface * @export */ export declare const HubsApiFp: (sdkManager?: SdkManager) => { /** * Returns the hub specified by the ``hub_id`` parameter. 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``. **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 Hub * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getHub(accessToken: string, hubId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a collection of hubs that the user of your app can access. The returned hubs can be BIM 360 Team hubs, Fusion Team hubs (formerly known as A360 Team hubs), A360 Personal hubs, ACC Docs (Autodesk Docs) accounts, or BIM 360 Docs accounts. Only active hubs are returned. 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``. **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 Hubs * @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} [filterName] Filter by the ``name`` of the ``ref`` target. * @param {Array} [filterExtensionType] Filter by the extension type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHubs(accessToken: string, xUserId?: string, filterId?: Array, filterName?: Array, filterExtensionType?: Array, options?: ApsServiceRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * HubsApi - interface * @export * @interface HubsApi */ export interface HubsApiInterface { /** * Returns the hub specified by the ``hub_id`` parameter. 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``. **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 Hub * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HubsApiInterface */ getHub(accessToken: string, hubId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns a collection of hubs that the user of your app can access. The returned hubs can be BIM 360 Team hubs, Fusion Team hubs (formerly known as A360 Team hubs), A360 Personal hubs, ACC Docs (Autodesk Docs) accounts, or BIM 360 Docs accounts. Only active hubs are returned. 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``. **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 Hubs * @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} [filterName] Filter by the ``name`` 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 HubsApiInterface */ getHubs(accessToken: string, xUserId?: string, filterId?: Array, filterName?: Array, filterExtensionType?: Array, options?: ApsServiceRequestConfig): Promise; } /** * HubsApi - object-oriented interface * @export * @class HubsApi * @extends {BaseApi} */ export declare class HubsApi extends BaseApi implements HubsApiInterface { private logger; /** * Returns the hub specified by the ``hub_id`` parameter. 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``. **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 Hub * @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 accessToken bearer access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HubsApi */ getHub(accessToken: string, hubId: string, xUserId?: string, options?: ApsServiceRequestConfig): Promise; /** * Returns a collection of hubs that the user of your app can access. The returned hubs can be BIM 360 Team hubs, Fusion Team hubs (formerly known as A360 Team hubs), A360 Personal hubs, ACC Docs (Autodesk Docs) accounts, or BIM 360 Docs accounts. Only active hubs are returned. 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``. **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 Hubs * @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} [filterName] Filter by the ``name`` 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 HubsApi */ getHubs(accessToken: string, xUserId?: string, filterId?: Array, filterName?: Array, filterExtensionType?: Array, options?: ApsServiceRequestConfig): Promise; }