/** * BIMData API * BIMData API is a tool to interact with your models stored on BIMData’s servers. Through the API, you can manage your projects, the clouds, upload your IFC files and manage them through endpoints. * * The version of the OpenAPI document: v1 (v1) * Contact: support@bimdata.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { Auth, BcfLabel, BcfLabelRequest, BcfProject, BcfProjectExportRequest, BcfProjectRequest, ColoringDefinition, Comment, CommentEvent, CommentRequest, DetailedExtensions, DocumentReference, DocumentReferenceRequest, Extensions, FullTopic, FullTopicRequest, PatchedBcfLabelRequest, PatchedBcfProjectRequest, PatchedCommentRequest, PatchedFullTopicRequest, PatchedPinRequest, PatchedPriorityRequest, PatchedStageRequest, PatchedTopicRequest, PatchedTopicStatusRequest, PatchedTopicTypeRequest, PatchedViewpointRequest, Pin, PinRequest, Priority, PriorityRequest, SelectionDefinition, SelfBcfUser, Stage, StageRequest, Topic, TopicEvent, TopicPin, TopicRequest, TopicStatus, TopicStatusRequest, TopicType, TopicTypeRequest, Version, Viewpoint, ViewpointRequest, VisibilityDefinition } from '../models'; export interface CreateCommentRequest { projects_pk: number; topics_guid: string; CommentRequest?: CommentRequest; } export interface CreateDocumentReferenceRequest { guid: string; projects_pk: number; DocumentReferenceRequest: DocumentReferenceRequest; } export interface CreateExtensionLabelRequest { projects_pk: number; BcfLabelRequest: BcfLabelRequest; } export interface CreateExtensionPriorityRequest { projects_pk: number; PriorityRequest: PriorityRequest; } export interface CreateExtensionStageRequest { projects_pk: number; StageRequest: StageRequest; } export interface CreateExtensionStatusRequest { projects_pk: number; TopicStatusRequest: TopicStatusRequest; } export interface CreateExtensionTypeRequest { projects_pk: number; TopicTypeRequest: TopicTypeRequest; } export interface CreateFullTopicRequest { projects_pk: number; FullTopicRequest: FullTopicRequest; img_format?: CreateFullTopicImgFormatEnum; } export interface CreatePinRequest { projects_pk: number; topics_guid: string; viewpoints_guid: string; PinRequest: PinRequest; } export interface CreateTopicRequest { projects_pk: number; TopicRequest: TopicRequest; } export interface CreateViewpointRequest { projects_pk: number; topics_guid: string; img_format?: CreateViewpointImgFormatEnum; ViewpointRequest?: ViewpointRequest; } export interface DeleteCommentRequest { guid: string; projects_pk: number; topics_guid: string; } export interface DeleteExtensionLabelRequest { id: number; projects_pk: number; } export interface DeleteExtensionPriorityRequest { id: number; projects_pk: number; } export interface DeleteExtensionStageRequest { id: number; projects_pk: number; } export interface DeleteExtensionStatusRequest { id: number; projects_pk: number; } export interface DeleteExtensionTypeRequest { id: number; projects_pk: number; } export interface DeletePinRequest { guid: string; projects_pk: number; topics_guid: string; viewpoints_guid: string; } export interface DeleteTopicRequest { guid: string; projects_pk: number; } export interface DeleteViewpointRequest { guid: string; projects_pk: number; topics_guid: string; img_format?: DeleteViewpointImgFormatEnum; } export interface DownloadBcfExportRequest { id: number; format?: string; topics?: string; } export interface DownloadBcfExportPostRequest { id: number; BcfProjectExportRequest?: BcfProjectExportRequest; } export interface DownloadBcfExportXlsxRequest { id: number; format?: string; locale?: DownloadBcfExportXlsxLocaleEnum; topics?: string; } export interface DownloadBcfExportXlsxPostRequest { id: number; locale?: DownloadBcfExportXlsxPostLocaleEnum; BcfProjectExportRequest?: BcfProjectExportRequest; } export interface FullUpdateBcfProjectRequest { id: number; BcfProjectRequest: BcfProjectRequest; } export interface FullUpdateCommentRequest { guid: string; projects_pk: number; topics_guid: string; CommentRequest?: CommentRequest; } export interface FullUpdateDocumentReferenceRequest { guid: string; projects_pk: number; DocumentReferenceRequest: Array; format?: string; ifcs?: Array; models?: Array; } export interface FullUpdateFullTopicRequest { guid: string; projects_pk: number; FullTopicRequest: FullTopicRequest; img_format?: FullUpdateFullTopicImgFormatEnum; } export interface FullUpdatePinRequest { guid: string; projects_pk: number; topics_guid: string; viewpoints_guid: string; PinRequest: PinRequest; } export interface FullUpdateTopicRequest { guid: string; projects_pk: number; TopicRequest: TopicRequest; } export interface GetBcfProjectRequest { id: number; } export interface GetColoringsRequest { guid: string; projects_pk: number; topics_guid: string; } export interface GetCommentRequest { guid: string; projects_pk: number; topics_guid: string; } export interface GetCommentsRequest { projects_pk: number; topics_guid: string; $filter?: string; $orderby?: string; } export interface GetCommentsEventsRequest { projects_pk: number; $filter?: string; $orderby?: string; } export interface GetDetailedExtensionsRequest { id: number; } export interface GetDocumentReferencesRequest { guid: string; projects_pk: number; format?: string; ifcs?: Array; models?: Array; } export interface GetExtensionsRequest { id: number; } export interface GetFullTopicRequest { guid: string; projects_pk: number; img_format?: GetFullTopicImgFormatEnum; } export interface GetFullTopicsRequest { projects_pk: number; $filter?: string; $orderby?: string; format?: string; ifcs?: Array; img_format?: GetFullTopicsImgFormatEnum; models?: Array; } export interface GetPinsRequest { projects_pk: number; topics_guid: string; viewpoints_guid: string; } export interface GetRelatedTopicsRequest { guid: string; projects_pk: number; format?: string; ifcs?: Array; models?: Array; } export interface GetSelectionsRequest { guid: string; projects_pk: number; topics_guid: string; } export interface GetSnapshotRequest { guid: string; projects_pk: number; topics_guid: string; } export interface GetTopicRequest { guid: string; projects_pk: number; } export interface GetTopicViewpointsRequest { projects_pk: number; topics_guid: string; img_format?: GetTopicViewpointsImgFormatEnum; } export interface GetTopicsRequest { projects_pk: number; $filter?: string; $orderby?: string; format?: string; ifcs?: Array; models?: Array; } export interface GetTopicsEventsRequest { projects_pk: number; $filter?: string; $orderby?: string; } export interface GetTopicsPinsRequest { projects_pk: number; format?: string; ifcs?: Array; models?: Array; topics?: string; } export interface GetViewpoinPinRequest { guid: string; projects_pk: number; topics_guid: string; viewpoints_guid: string; } export interface GetViewpointRequest { guid: string; projects_pk: number; topics_guid: string; img_format?: GetViewpointImgFormatEnum; } export interface GetViewpointsRequest { projects_pk: number; topics_guid: string; img_format?: GetViewpointsImgFormatEnum; } export interface GetVisibilitiesRequest { guid: string; projects_pk: number; topics_guid: string; } export interface ImportBcfRequest { id: number; name: string; } export interface UpdateBcfProjectRequest { id: number; PatchedBcfProjectRequest?: PatchedBcfProjectRequest; } export interface UpdateCommentRequest { guid: string; projects_pk: number; topics_guid: string; PatchedCommentRequest?: PatchedCommentRequest; } export interface UpdateExtensionLabelRequest { id: number; projects_pk: number; PatchedBcfLabelRequest?: PatchedBcfLabelRequest; } export interface UpdateExtensionPriorityRequest { id: number; projects_pk: number; PatchedPriorityRequest?: PatchedPriorityRequest; } export interface UpdateExtensionStageRequest { id: number; projects_pk: number; PatchedStageRequest?: PatchedStageRequest; } export interface UpdateExtensionStatusRequest { id: number; projects_pk: number; PatchedTopicStatusRequest?: PatchedTopicStatusRequest; } export interface UpdateExtensionTypeRequest { id: number; projects_pk: number; PatchedTopicTypeRequest?: PatchedTopicTypeRequest; } export interface UpdateFullTopicRequest { guid: string; projects_pk: number; img_format?: UpdateFullTopicImgFormatEnum; PatchedFullTopicRequest?: PatchedFullTopicRequest; } export interface UpdatePinRequest { guid: string; projects_pk: number; topics_guid: string; viewpoints_guid: string; PatchedPinRequest?: PatchedPinRequest; } export interface UpdateTopicRequest { guid: string; projects_pk: number; PatchedTopicRequest?: PatchedTopicRequest; } export interface UpdateViewpointRequest { guid: string; projects_pk: number; topics_guid: string; img_format?: UpdateViewpointImgFormatEnum; PatchedViewpointRequest?: PatchedViewpointRequest; } /** * */ export declare class BcfApi extends runtime.BaseAPI { /** * Create a comment Required scopes: bcf:write * Create a comment */ createCommentRaw(requestParameters: CreateCommentRequest, initOverrides?: RequestInit): Promise>; /** * Create a comment Required scopes: bcf:write * Create a comment */ createComment(projects_pk: number, topics_guid: string, CommentRequest?: CommentRequest, initOverrides?: RequestInit): Promise; /** * Create a reference to a document Required scopes: bcf:write * Create a reference to a document */ createDocumentReferenceRaw(requestParameters: CreateDocumentReferenceRequest, initOverrides?: RequestInit): Promise>; /** * Create a reference to a document Required scopes: bcf:write * Create a reference to a document */ createDocumentReference(guid: string, projects_pk: number, DocumentReferenceRequest: DocumentReferenceRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Create a Label available for the project Required scopes: bcf:write * Create a Label */ createExtensionLabelRaw(requestParameters: CreateExtensionLabelRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Create a Label available for the project Required scopes: bcf:write * Create a Label */ createExtensionLabel(projects_pk: number, BcfLabelRequest: BcfLabelRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Create a Priority available for the project Required scopes: bcf:write * Create a Priority */ createExtensionPriorityRaw(requestParameters: CreateExtensionPriorityRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Create a Priority available for the project Required scopes: bcf:write * Create a Priority */ createExtensionPriority(projects_pk: number, PriorityRequest: PriorityRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Create a Stage available for the project Required scopes: bcf:write * Create a Stage */ createExtensionStageRaw(requestParameters: CreateExtensionStageRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Create a Stage available for the project Required scopes: bcf:write * Create a Stage */ createExtensionStage(projects_pk: number, StageRequest: StageRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Create a TopicStatus available for the project Required scopes: bcf:write * Create a TopicStatus */ createExtensionStatusRaw(requestParameters: CreateExtensionStatusRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Create a TopicStatus available for the project Required scopes: bcf:write * Create a TopicStatus */ createExtensionStatus(projects_pk: number, TopicStatusRequest: TopicStatusRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Create a TopicType available for the project Required scopes: bcf:write * Create a TopicType */ createExtensionTypeRaw(requestParameters: CreateExtensionTypeRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Create a TopicType available for the project Required scopes: bcf:write * Create a TopicType */ createExtensionType(projects_pk: number, TopicTypeRequest: TopicTypeRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. You can send a topic, viewpoints and comments in a single call Required scopes: bcf:write * Create a Topic with viewpoints and comments */ createFullTopicRaw(requestParameters: CreateFullTopicRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. You can send a topic, viewpoints and comments in a single call Required scopes: bcf:write * Create a Topic with viewpoints and comments */ createFullTopic(projects_pk: number, FullTopicRequest: FullTopicRequest, img_format?: CreateFullTopicImgFormatEnum, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Create a Pin Required scopes: bcf:write * Create a Pin */ createPinRaw(requestParameters: CreatePinRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Create a Pin Required scopes: bcf:write * Create a Pin */ createPin(projects_pk: number, topics_guid: string, viewpoints_guid: string, PinRequest: PinRequest, initOverrides?: RequestInit): Promise; /** * Create a topic Required scopes: bcf:write * Create a topic */ createTopicRaw(requestParameters: CreateTopicRequest, initOverrides?: RequestInit): Promise>; /** * Create a topic Required scopes: bcf:write * Create a topic */ createTopic(projects_pk: number, TopicRequest: TopicRequest, initOverrides?: RequestInit): Promise; /** * Create a Viewpoint Required scopes: bcf:write * Create a Viewpoint */ createViewpointRaw(requestParameters: CreateViewpointRequest, initOverrides?: RequestInit): Promise>; /** * Create a Viewpoint Required scopes: bcf:write * Create a Viewpoint */ createViewpoint(projects_pk: number, topics_guid: string, img_format?: CreateViewpointImgFormatEnum, ViewpointRequest?: ViewpointRequest, initOverrides?: RequestInit): Promise; /** * Delete a comment Required scopes: bcf:write * Delete a comment */ deleteCommentRaw(requestParameters: DeleteCommentRequest, initOverrides?: RequestInit): Promise>; /** * Delete a comment Required scopes: bcf:write * Delete a comment */ deleteComment(guid: string, projects_pk: number, topics_guid: string, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Delete a Label. Topics using this label won\'t be deleted Required scopes: bcf:write * Delete a Label */ deleteExtensionLabelRaw(requestParameters: DeleteExtensionLabelRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Delete a Label. Topics using this label won\'t be deleted Required scopes: bcf:write * Delete a Label */ deleteExtensionLabel(id: number, projects_pk: number, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Delete a Priority. Topics using this priority won\'t be deleted Required scopes: bcf:write * Delete a Priority */ deleteExtensionPriorityRaw(requestParameters: DeleteExtensionPriorityRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Delete a Priority. Topics using this priority won\'t be deleted Required scopes: bcf:write * Delete a Priority */ deleteExtensionPriority(id: number, projects_pk: number, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Delete a Stage. Topics using this stage won\'t be deleted Required scopes: bcf:write * Delete a Stage */ deleteExtensionStageRaw(requestParameters: DeleteExtensionStageRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Delete a Stage. Topics using this stage won\'t be deleted Required scopes: bcf:write * Delete a Stage */ deleteExtensionStage(id: number, projects_pk: number, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Delete a TopicStatus. Topics using this status won\'t be deleted Required scopes: bcf:write * Delete a TopicStatus */ deleteExtensionStatusRaw(requestParameters: DeleteExtensionStatusRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Delete a TopicStatus. Topics using this status won\'t be deleted Required scopes: bcf:write * Delete a TopicStatus */ deleteExtensionStatus(id: number, projects_pk: number, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Delete a TopicType. Topics using this type won\'t be deleted Required scopes: bcf:write * Delete a TopicType */ deleteExtensionTypeRaw(requestParameters: DeleteExtensionTypeRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Delete a TopicType. Topics using this type won\'t be deleted Required scopes: bcf:write * Delete a TopicType */ deleteExtensionType(id: number, projects_pk: number, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Delete a Pin Required scopes: bcf:write * Delete a Pin */ deletePinRaw(requestParameters: DeletePinRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Delete a Pin Required scopes: bcf:write * Delete a Pin */ deletePin(guid: string, projects_pk: number, topics_guid: string, viewpoints_guid: string, initOverrides?: RequestInit): Promise; /** * Delete a topic Required scopes: bcf:write * Delete a topic */ deleteTopicRaw(requestParameters: DeleteTopicRequest, initOverrides?: RequestInit): Promise>; /** * Delete a topic Required scopes: bcf:write * Delete a topic */ deleteTopic(guid: string, projects_pk: number, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Delete a Viewpoint Required scopes: bcf:write * Delete a Viewpoint */ deleteViewpointRaw(requestParameters: DeleteViewpointRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Delete a Viewpoint Required scopes: bcf:write * Delete a Viewpoint */ deleteViewpoint(guid: string, projects_pk: number, topics_guid: string, img_format?: DeleteViewpointImgFormatEnum, initOverrides?: RequestInit): Promise; /** * Required scopes: bcf:read */ downloadBcfExportRaw(requestParameters: DownloadBcfExportRequest, initOverrides?: RequestInit): Promise>; /** * Required scopes: bcf:read */ downloadBcfExport(id: number, format?: string, topics?: string, initOverrides?: RequestInit): Promise; /** * Required scopes: bcf:write */ downloadBcfExportPostRaw(requestParameters: DownloadBcfExportPostRequest, initOverrides?: RequestInit): Promise>; /** * Required scopes: bcf:write */ downloadBcfExportPost(id: number, BcfProjectExportRequest?: BcfProjectExportRequest, initOverrides?: RequestInit): Promise; /** * Required scopes: bcf:read */ downloadBcfExportXlsxRaw(requestParameters: DownloadBcfExportXlsxRequest, initOverrides?: RequestInit): Promise>; /** * Required scopes: bcf:read */ downloadBcfExportXlsx(id: number, format?: string, locale?: DownloadBcfExportXlsxLocaleEnum, topics?: string, initOverrides?: RequestInit): Promise; /** * Required scopes: bcf:write */ downloadBcfExportXlsxPostRaw(requestParameters: DownloadBcfExportXlsxPostRequest, initOverrides?: RequestInit): Promise>; /** * Required scopes: bcf:write */ downloadBcfExportXlsxPost(id: number, locale?: DownloadBcfExportXlsxPostLocaleEnum, BcfProjectExportRequest?: BcfProjectExportRequest, initOverrides?: RequestInit): Promise; /** * Update all fields of a BCF project Required scopes: bcf:write * Update all fields of a BCF project */ fullUpdateBcfProjectRaw(requestParameters: FullUpdateBcfProjectRequest, initOverrides?: RequestInit): Promise>; /** * Update all fields of a BCF project Required scopes: bcf:write * Update all fields of a BCF project */ fullUpdateBcfProject(id: number, BcfProjectRequest: BcfProjectRequest, initOverrides?: RequestInit): Promise; /** * Update all fields of a comment Required scopes: bcf:write * Update all fields of a comment */ fullUpdateCommentRaw(requestParameters: FullUpdateCommentRequest, initOverrides?: RequestInit): Promise>; /** * Update all fields of a comment Required scopes: bcf:write * Update all fields of a comment */ fullUpdateComment(guid: string, projects_pk: number, topics_guid: string, CommentRequest?: CommentRequest, initOverrides?: RequestInit): Promise; /** * This will replace every references by references passed in the body Required scopes: bcf:write * Add or update document references to a topic */ fullUpdateDocumentReferenceRaw(requestParameters: FullUpdateDocumentReferenceRequest, initOverrides?: RequestInit): Promise>>; /** * This will replace every references by references passed in the body Required scopes: bcf:write * Add or update document references to a topic */ fullUpdateDocumentReference(guid: string, projects_pk: number, DocumentReferenceRequest: Array, format?: string, ifcs?: Array, models?: Array, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. You can update topic, viewpoints and comment is a signle call Required scopes: bcf:write * Update all fields of a topic */ fullUpdateFullTopicRaw(requestParameters: FullUpdateFullTopicRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. You can update topic, viewpoints and comment is a signle call Required scopes: bcf:write * Update all fields of a topic */ fullUpdateFullTopic(guid: string, projects_pk: number, FullTopicRequest: FullTopicRequest, img_format?: FullUpdateFullTopicImgFormatEnum, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Update all fields of a Pin Required scopes: bcf:write * Update all fields of a Pin */ fullUpdatePinRaw(requestParameters: FullUpdatePinRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Update all fields of a Pin Required scopes: bcf:write * Update all fields of a Pin */ fullUpdatePin(guid: string, projects_pk: number, topics_guid: string, viewpoints_guid: string, PinRequest: PinRequest, initOverrides?: RequestInit): Promise; /** * Update all fields of a topic Required scopes: bcf:write * Update all fields of a topic */ fullUpdateTopicRaw(requestParameters: FullUpdateTopicRequest, initOverrides?: RequestInit): Promise>; /** * Update all fields of a topic Required scopes: bcf:write * Update all fields of a topic */ fullUpdateTopic(guid: string, projects_pk: number, TopicRequest: TopicRequest, initOverrides?: RequestInit): Promise; /** * oauth2_dynamic_client_reg_url is not supported, http_basic_supported is always set to false, * Retrieve Authentication Information */ getAuthRaw(initOverrides?: RequestInit): Promise>>; /** * oauth2_dynamic_client_reg_url is not supported, http_basic_supported is always set to false, * Retrieve Authentication Information */ getAuth(initOverrides?: RequestInit): Promise>; /** * Retrieve a BCF project Required scopes: bcf:read * Retrieve a BCF project */ getBcfProjectRaw(requestParameters: GetBcfProjectRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve a BCF project Required scopes: bcf:read * Retrieve a BCF project */ getBcfProject(id: number, initOverrides?: RequestInit): Promise; /** * Retrieve all BCF projects Required scopes: bcf:read * Retrieve all BCF projects */ getBcfProjectsRaw(initOverrides?: RequestInit): Promise>>; /** * Retrieve all BCF projects Required scopes: bcf:read * Retrieve all BCF projects */ getBcfProjects(initOverrides?: RequestInit): Promise>; /** * Retrieve all colorings of a viewpoint Required scopes: bcf:read * Retrieve all colorings of a viewpoint */ getColoringsRaw(requestParameters: GetColoringsRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve all colorings of a viewpoint Required scopes: bcf:read * Retrieve all colorings of a viewpoint */ getColorings(guid: string, projects_pk: number, topics_guid: string, initOverrides?: RequestInit): Promise; /** * Retrieve a comment Required scopes: bcf:read * Retrieve a comment */ getCommentRaw(requestParameters: GetCommentRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve a comment Required scopes: bcf:read * Retrieve a comment */ getComment(guid: string, projects_pk: number, topics_guid: string, initOverrides?: RequestInit): Promise; /** * Retrieve all comments Required scopes: bcf:read * Retrieve all comments */ getCommentsRaw(requestParameters: GetCommentsRequest, initOverrides?: RequestInit): Promise>>; /** * Retrieve all comments Required scopes: bcf:read * Retrieve all comments */ getComments(projects_pk: number, topics_guid: string, $filter?: string, $orderby?: string, initOverrides?: RequestInit): Promise>; /** * Get comments events Required scopes: bcf:read * Get comments events */ getCommentsEventsRaw(requestParameters: GetCommentsEventsRequest, initOverrides?: RequestInit): Promise>>; /** * Get comments events Required scopes: bcf:read * Get comments events */ getCommentsEvents(projects_pk: number, $filter?: string, $orderby?: string, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Retrieve project detailed extensions Required scopes: bcf:read * Retrieve project detailed extensions */ getDetailedExtensionsRaw(requestParameters: GetDetailedExtensionsRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Retrieve project detailed extensions Required scopes: bcf:read * Retrieve project detailed extensions */ getDetailedExtensions(id: number, initOverrides?: RequestInit): Promise; /** * Retrieve all documents referenced by the topic Required scopes: bcf:read * Retrieve all documents referenced by the topic */ getDocumentReferencesRaw(requestParameters: GetDocumentReferencesRequest, initOverrides?: RequestInit): Promise>>; /** * Retrieve all documents referenced by the topic Required scopes: bcf:read * Retrieve all documents referenced by the topic */ getDocumentReferences(guid: string, projects_pk: number, format?: string, ifcs?: Array, models?: Array, initOverrides?: RequestInit): Promise>; /** * Retrieve project extensions Required scopes: bcf:read * Retrieve project extensions */ getExtensionsRaw(requestParameters: GetExtensionsRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve project extensions Required scopes: bcf:read * Retrieve project extensions */ getExtensions(id: number, initOverrides?: RequestInit): Promise; /** * This is not a standard route. It responds with a topic, its viewpoints and its comments Required scopes: bcf:read * Retrieve a full topic */ getFullTopicRaw(requestParameters: GetFullTopicRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. It responds with a topic, its viewpoints and its comments Required scopes: bcf:read * Retrieve a full topic */ getFullTopic(guid: string, projects_pk: number, img_format?: GetFullTopicImgFormatEnum, initOverrides?: RequestInit): Promise; /** * This is not a standard route. It responds with all topics, their viewpoints and their comments Required scopes: bcf:read * Retrieve all full topics */ getFullTopicsRaw(requestParameters: GetFullTopicsRequest, initOverrides?: RequestInit): Promise>>; /** * This is not a standard route. It responds with all topics, their viewpoints and their comments Required scopes: bcf:read * Retrieve all full topics */ getFullTopics(projects_pk: number, $filter?: string, $orderby?: string, format?: string, ifcs?: Array, img_format?: GetFullTopicsImgFormatEnum, models?: Array, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Retrieve all Pins of a viewpoint Required scopes: bcf:read * Retrieve all Pins of a viewpoint */ getPinsRaw(requestParameters: GetPinsRequest, initOverrides?: RequestInit): Promise>>; /** * This is not a standard route. Retrieve all Pins of a viewpoint Required scopes: bcf:read * Retrieve all Pins of a viewpoint */ getPins(projects_pk: number, topics_guid: string, viewpoints_guid: string, initOverrides?: RequestInit): Promise>; /** * This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read * Get all related topics */ getRelatedTopicsRaw(requestParameters: GetRelatedTopicsRequest, initOverrides?: RequestInit): Promise>>; /** * This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read * Get all related topics */ getRelatedTopics(guid: string, projects_pk: number, format?: string, ifcs?: Array, models?: Array, initOverrides?: RequestInit): Promise>; /** * Retrieve all selections of a viewpoint Required scopes: bcf:read * Retrieve all selections of a viewpoint */ getSelectionsRaw(requestParameters: GetSelectionsRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve all selections of a viewpoint Required scopes: bcf:read * Retrieve all selections of a viewpoint */ getSelections(guid: string, projects_pk: number, topics_guid: string, initOverrides?: RequestInit): Promise; /** * Retrieve the viewpoint\' snapshot Required scopes: bcf:read * Retrieve the viewpoint\' snapshot */ getSnapshotRaw(requestParameters: GetSnapshotRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve the viewpoint\' snapshot Required scopes: bcf:read * Retrieve the viewpoint\' snapshot */ getSnapshot(guid: string, projects_pk: number, topics_guid: string, initOverrides?: RequestInit): Promise; /** * Retrieve a topic Required scopes: bcf:read * Retrieve a topic */ getTopicRaw(requestParameters: GetTopicRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve a topic Required scopes: bcf:read * Retrieve a topic */ getTopic(guid: string, projects_pk: number, initOverrides?: RequestInit): Promise; /** * This is not a standard route. It returns all viewpoints of the topic that are not attached to a comment. Required scopes: bcf:read * Retrieve all viewpoints attached to the topic */ getTopicViewpointsRaw(requestParameters: GetTopicViewpointsRequest, initOverrides?: RequestInit): Promise>>; /** * This is not a standard route. It returns all viewpoints of the topic that are not attached to a comment. Required scopes: bcf:read * Retrieve all viewpoints attached to the topic */ getTopicViewpoints(projects_pk: number, topics_guid: string, img_format?: GetTopicViewpointsImgFormatEnum, initOverrides?: RequestInit): Promise>; /** * Retrieve all topics Required scopes: bcf:read * Retrieve all topics */ getTopicsRaw(requestParameters: GetTopicsRequest, initOverrides?: RequestInit): Promise>>; /** * Retrieve all topics Required scopes: bcf:read * Retrieve all topics */ getTopics(projects_pk: number, $filter?: string, $orderby?: string, format?: string, ifcs?: Array, models?: Array, initOverrides?: RequestInit): Promise>; /** * Get topics events Required scopes: bcf:read * Get topics events */ getTopicsEventsRaw(requestParameters: GetTopicsEventsRequest, initOverrides?: RequestInit): Promise>>; /** * Get topics events Required scopes: bcf:read * Get topics events */ getTopicsEvents(projects_pk: number, $filter?: string, $orderby?: string, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Get pins of all or many topics Required scopes: bcf:read * Get pins of all or many topics */ getTopicsPinsRaw(requestParameters: GetTopicsPinsRequest, initOverrides?: RequestInit): Promise>>; /** * This is not a standard route. Get pins of all or many topics Required scopes: bcf:read * Get pins of all or many topics */ getTopicsPins(projects_pk: number, format?: string, ifcs?: Array, models?: Array, topics?: string, initOverrides?: RequestInit): Promise>; /** * Get current user info. If request comes from an App, the response is always:{ \"id\": None, \"name\": None, \"is_client\": True,} Required scopes: bcf:read * Get current user info */ getUserRaw(initOverrides?: RequestInit): Promise>; /** * Get current user info. If request comes from an App, the response is always:{ \"id\": None, \"name\": None, \"is_client\": True,} Required scopes: bcf:read * Get current user info */ getUser(initOverrides?: RequestInit): Promise; /** * Spoiler: it\'s only v2.1 * Retrieve all supported BCF versions by this API */ getVersionsRaw(initOverrides?: RequestInit): Promise>>; /** * Spoiler: it\'s only v2.1 * Retrieve all supported BCF versions by this API */ getVersions(initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Retrieve a Pin Required scopes: bcf:read * Retrieve a Pin */ getViewpoinPinRaw(requestParameters: GetViewpoinPinRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Retrieve a Pin Required scopes: bcf:read * Retrieve a Pin */ getViewpoinPin(guid: string, projects_pk: number, topics_guid: string, viewpoints_guid: string, initOverrides?: RequestInit): Promise; /** * Retrieve a Viewpoint Required scopes: bcf:read * Retrieve a Viewpoint */ getViewpointRaw(requestParameters: GetViewpointRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve a Viewpoint Required scopes: bcf:read * Retrieve a Viewpoint */ getViewpoint(guid: string, projects_pk: number, topics_guid: string, img_format?: GetViewpointImgFormatEnum, initOverrides?: RequestInit): Promise; /** * Retrieve all Viewpoints of a topic Required scopes: bcf:read * Retrieve all Viewpoints of a topic */ getViewpointsRaw(requestParameters: GetViewpointsRequest, initOverrides?: RequestInit): Promise>>; /** * Retrieve all Viewpoints of a topic Required scopes: bcf:read * Retrieve all Viewpoints of a topic */ getViewpoints(projects_pk: number, topics_guid: string, img_format?: GetViewpointsImgFormatEnum, initOverrides?: RequestInit): Promise>; /** * Retrieve all visibilities of a viewpoint Required scopes: bcf:read * Retrieve all visibilities of a viewpoint */ getVisibilitiesRaw(requestParameters: GetVisibilitiesRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve all visibilities of a viewpoint Required scopes: bcf:read * Retrieve all visibilities of a viewpoint */ getVisibilities(guid: string, projects_pk: number, topics_guid: string, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Import bcf-xml format into this project. If there are guid conflict, an error will be raised. If there are index conflicts, indexes of the imported file will be overriden with a new index. Author and assigned_to fields will be linked to existing users in the project. If no matching user are found, fields will be emptied. Only BCF 2.1 is supported Required scopes: bcf:write * Import bcf-xml format into this project */ importBcfRaw(requestParameters: ImportBcfRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Import bcf-xml format into this project. If there are guid conflict, an error will be raised. If there are index conflicts, indexes of the imported file will be overriden with a new index. Author and assigned_to fields will be linked to existing users in the project. If no matching user are found, fields will be emptied. Only BCF 2.1 is supported Required scopes: bcf:write * Import bcf-xml format into this project */ importBcf(id: number, name: string, initOverrides?: RequestInit): Promise; /** * Update some fields of a BCF project Required scopes: bcf:write * Update some fields of a BCF project */ updateBcfProjectRaw(requestParameters: UpdateBcfProjectRequest, initOverrides?: RequestInit): Promise>; /** * Update some fields of a BCF project Required scopes: bcf:write * Update some fields of a BCF project */ updateBcfProject(id: number, PatchedBcfProjectRequest?: PatchedBcfProjectRequest, initOverrides?: RequestInit): Promise; /** * Update some fields of a comment Required scopes: bcf:write * Update some fields of a comment */ updateCommentRaw(requestParameters: UpdateCommentRequest, initOverrides?: RequestInit): Promise>; /** * Update some fields of a comment Required scopes: bcf:write * Update some fields of a comment */ updateComment(guid: string, projects_pk: number, topics_guid: string, PatchedCommentRequest?: PatchedCommentRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Update a Label. All topics using this label will be updated Required scopes: bcf:write * Update a Label */ updateExtensionLabelRaw(requestParameters: UpdateExtensionLabelRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Update a Label. All topics using this label will be updated Required scopes: bcf:write * Update a Label */ updateExtensionLabel(id: number, projects_pk: number, PatchedBcfLabelRequest?: PatchedBcfLabelRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Update a Priority. All topics using this priority will be updated Required scopes: bcf:write * Update a Priority */ updateExtensionPriorityRaw(requestParameters: UpdateExtensionPriorityRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Update a Priority. All topics using this priority will be updated Required scopes: bcf:write * Update a Priority */ updateExtensionPriority(id: number, projects_pk: number, PatchedPriorityRequest?: PatchedPriorityRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Update a Stage. All topics using this stage will be updated Required scopes: bcf:write * Update a Stage */ updateExtensionStageRaw(requestParameters: UpdateExtensionStageRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Update a Stage. All topics using this stage will be updated Required scopes: bcf:write * Update a Stage */ updateExtensionStage(id: number, projects_pk: number, PatchedStageRequest?: PatchedStageRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Update a TopicStatus. All topics using this status will be updated Required scopes: bcf:write * Update a TopicStatus */ updateExtensionStatusRaw(requestParameters: UpdateExtensionStatusRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Update a TopicStatus. All topics using this status will be updated Required scopes: bcf:write * Update a TopicStatus */ updateExtensionStatus(id: number, projects_pk: number, PatchedTopicStatusRequest?: PatchedTopicStatusRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Update a TopicType. All topics using this type will be updated Required scopes: bcf:write * Update a TopicType */ updateExtensionTypeRaw(requestParameters: UpdateExtensionTypeRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Update a TopicType. All topics using this type will be updated Required scopes: bcf:write * Update a TopicType */ updateExtensionType(id: number, projects_pk: number, PatchedTopicTypeRequest?: PatchedTopicTypeRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. You can update topic, viewpoints and comment is a signle call Required scopes: bcf:write * Update some fields of a topic */ updateFullTopicRaw(requestParameters: UpdateFullTopicRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. You can update topic, viewpoints and comment is a signle call Required scopes: bcf:write * Update some fields of a topic */ updateFullTopic(guid: string, projects_pk: number, img_format?: UpdateFullTopicImgFormatEnum, PatchedFullTopicRequest?: PatchedFullTopicRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Update some fields of a Pin Required scopes: bcf:write * Update some fields of a Pin */ updatePinRaw(requestParameters: UpdatePinRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Update some fields of a Pin Required scopes: bcf:write * Update some fields of a Pin */ updatePin(guid: string, projects_pk: number, topics_guid: string, viewpoints_guid: string, PatchedPinRequest?: PatchedPinRequest, initOverrides?: RequestInit): Promise; /** * Update some fields of a topic Required scopes: bcf:write * Update some fields of a topic */ updateTopicRaw(requestParameters: UpdateTopicRequest, initOverrides?: RequestInit): Promise>; /** * Update some fields of a topic Required scopes: bcf:write * Update some fields of a topic */ updateTopic(guid: string, projects_pk: number, PatchedTopicRequest?: PatchedTopicRequest, initOverrides?: RequestInit): Promise; /** * This is not a standard route. Update some fields of a Viewpoint Required scopes: bcf:write * Update some fields of a Viewpoint */ updateViewpointRaw(requestParameters: UpdateViewpointRequest, initOverrides?: RequestInit): Promise>; /** * This is not a standard route. Update some fields of a Viewpoint Required scopes: bcf:write * Update some fields of a Viewpoint */ updateViewpoint(guid: string, projects_pk: number, topics_guid: string, img_format?: UpdateViewpointImgFormatEnum, PatchedViewpointRequest?: PatchedViewpointRequest, initOverrides?: RequestInit): Promise; } /** * @export * @enum {string} */ export declare enum CreateFullTopicImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum CreateViewpointImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum DeleteViewpointImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum DownloadBcfExportXlsxLocaleEnum { En = "en", Fr = "fr" } /** * @export * @enum {string} */ export declare enum DownloadBcfExportXlsxPostLocaleEnum { En = "en", Fr = "fr" } /** * @export * @enum {string} */ export declare enum FullUpdateFullTopicImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum GetFullTopicImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum GetFullTopicsImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum GetTopicViewpointsImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum GetViewpointImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum GetViewpointsImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum UpdateFullTopicImgFormatEnum { Url = "url" } /** * @export * @enum {string} */ export declare enum UpdateViewpointImgFormatEnum { Url = "url" }