From e6cb0f2eeef5d11228615d6bea9c8df0c5b0a5d3 Mon Sep 17 00:00:00 2001 From: Github Actions Date: Mon, 16 Sep 2024 13:13:55 +0000 Subject: [PATCH] MINOR: Bcf odata (#772) * implement odata filters * add orderby * factorize * replace test domains with bimdata.test --- package/src/apis/BcfApi.ts | 42 ++++++++++++++++++++---- package/src/apis/CollaborationApi.ts | 4 +-- package/src/models/WriteFolderRequest.ts | 24 +++++++------- 3 files changed, 50 insertions(+), 20 deletions(-) diff --git a/package/src/apis/BcfApi.ts b/package/src/apis/BcfApi.ts index 5c49d25..1c2fd53 100644 --- a/package/src/apis/BcfApi.ts +++ b/package/src/apis/BcfApi.ts @@ -311,6 +311,8 @@ export interface GetCommentRequest { export interface GetCommentsRequest { projects_pk: number; topics_guid: string; + $filter?: string; + $orderby?: string; } export interface GetDetailedExtensionsRequest { @@ -329,6 +331,8 @@ export interface GetFullTopicRequest { export interface GetFullTopicsRequest { projects_pk: number; + $filter?: string; + $orderby?: string; format?: string; ifcs?: Array; img_format?: GetFullTopicsImgFormatEnum; @@ -382,6 +386,8 @@ export interface GetTopicViewpointsRequest { export interface GetTopicsRequest { projects_pk: number; + $filter?: string; + $orderby?: string; format?: string; ifcs?: Array; models?: Array; @@ -2283,6 +2289,14 @@ export class BcfApi extends runtime.BaseAPI { const queryParameters: any = {}; + if (requestParameters.$filter !== undefined) { + queryParameters['$filter'] = requestParameters.$filter; + } + + if (requestParameters.$orderby !== undefined) { + queryParameters['$orderby'] = requestParameters.$orderby; + } + const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.apiKey) { @@ -2317,8 +2331,8 @@ export class BcfApi extends runtime.BaseAPI { * Retrieve all comments Required scopes: bcf:read * Retrieve all comments */ - async getComments(projects_pk: number, topics_guid: string, initOverrides?: RequestInit): Promise> { - const response = await this.getCommentsRaw({ projects_pk: projects_pk, topics_guid: topics_guid }, initOverrides); + async getComments(projects_pk: number, topics_guid: string, $filter?: string, $orderby?: string, initOverrides?: RequestInit): Promise> { + const response = await this.getCommentsRaw({ projects_pk: projects_pk, topics_guid: topics_guid, $filter: $filter, $orderby: $orderby }, initOverrides); return await response.value(); } @@ -2491,6 +2505,14 @@ export class BcfApi extends runtime.BaseAPI { const queryParameters: any = {}; + if (requestParameters.$filter !== undefined) { + queryParameters['$filter'] = requestParameters.$filter; + } + + if (requestParameters.$orderby !== undefined) { + queryParameters['$orderby'] = requestParameters.$orderby; + } + if (requestParameters.format !== undefined) { queryParameters['format'] = requestParameters.format; } @@ -2541,8 +2563,8 @@ export class BcfApi extends runtime.BaseAPI { * This is not a standard route. It responds with all topics, their viewpoints and their comments Required scopes: bcf:read * Retrieve all full topics */ - async getFullTopics(projects_pk: number, format?: string, ifcs?: Array, img_format?: GetFullTopicsImgFormatEnum, models?: Array, initOverrides?: RequestInit): Promise> { - const response = await this.getFullTopicsRaw({ projects_pk: projects_pk, format: format, ifcs: ifcs, img_format: img_format, models: models }, initOverrides); + async getFullTopics(projects_pk: number, $filter?: string, $orderby?: string, format?: string, ifcs?: Array, img_format?: GetFullTopicsImgFormatEnum, models?: Array, initOverrides?: RequestInit): Promise> { + const response = await this.getFullTopicsRaw({ projects_pk: projects_pk, $filter: $filter, $orderby: $orderby, format: format, ifcs: ifcs, img_format: img_format, models: models }, initOverrides); return await response.value(); } @@ -2975,6 +2997,14 @@ export class BcfApi extends runtime.BaseAPI { const queryParameters: any = {}; + if (requestParameters.$filter !== undefined) { + queryParameters['$filter'] = requestParameters.$filter; + } + + if (requestParameters.$orderby !== undefined) { + queryParameters['$orderby'] = requestParameters.$orderby; + } + if (requestParameters.format !== undefined) { queryParameters['format'] = requestParameters.format; } @@ -3021,8 +3051,8 @@ export class BcfApi extends runtime.BaseAPI { * Retrieve all topics Required scopes: bcf:read * Retrieve all topics */ - async getTopics(projects_pk: number, format?: string, ifcs?: Array, models?: Array, initOverrides?: RequestInit): Promise> { - const response = await this.getTopicsRaw({ projects_pk: projects_pk, format: format, ifcs: ifcs, models: models }, initOverrides); + async getTopics(projects_pk: number, $filter?: string, $orderby?: string, format?: string, ifcs?: Array, models?: Array, initOverrides?: RequestInit): Promise> { + const response = await this.getTopicsRaw({ projects_pk: projects_pk, $filter: $filter, $orderby: $orderby, format: format, ifcs: ifcs, models: models }, initOverrides); return await response.value(); } diff --git a/package/src/apis/CollaborationApi.ts b/package/src/apis/CollaborationApi.ts index e1783d8..ae0329d 100644 --- a/package/src/apis/CollaborationApi.ts +++ b/package/src/apis/CollaborationApi.ts @@ -1677,7 +1677,7 @@ export class CollaborationApi extends runtime.BaseAPI { } /** - * Create a document. If the document is one of {\'OBJ\', \'IFC\', \'POINT_CLOUD\', \'GLTF\', \'DXF\', \'DWG\'}, a model will be created and attached to this document Required scopes: document:write + * Create a document. If the document is one of {\'OBJ\', \'GLTF\', \'IFC\', \'DWG\', \'POINT_CLOUD\', \'DXF\'}, a model will be created and attached to this document Required scopes: document:write * Create a document */ async createDocumentRaw(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit): Promise> { @@ -1780,7 +1780,7 @@ export class CollaborationApi extends runtime.BaseAPI { } /** - * Create a document. If the document is one of {\'OBJ\', \'IFC\', \'POINT_CLOUD\', \'GLTF\', \'DXF\', \'DWG\'}, a model will be created and attached to this document Required scopes: document:write + * Create a document. If the document is one of {\'OBJ\', \'GLTF\', \'IFC\', \'DWG\', \'POINT_CLOUD\', \'DXF\'}, a model will be created and attached to this document Required scopes: document:write * Create a document */ async createDocument(cloud_pk: number, project_pk: number, name: string, file: Blob, parent_id?: number | null, file_name?: string, description?: string | null, model_source?: CreateDocumentModelSourceEnum, ifc_source?: CreateDocumentIfcSourceEnum, successor_of?: number, initOverrides?: RequestInit): Promise { diff --git a/package/src/models/WriteFolderRequest.ts b/package/src/models/WriteFolderRequest.ts index d095de4..67c289c 100644 --- a/package/src/models/WriteFolderRequest.ts +++ b/package/src/models/WriteFolderRequest.ts @@ -19,6 +19,16 @@ import { exists, mapValues } from '../runtime'; * @interface WriteFolderRequest */ export interface WriteFolderRequest { + /** + * Permission for a Folder + * + * * `1` - denied + * * `50` - read_only + * * `100` - read_write + * @type {number} + * @memberof WriteFolderRequest + */ + default_permission?: WriteFolderRequestDefaultPermissionEnum; /** * * @type {number} @@ -31,16 +41,6 @@ export interface WriteFolderRequest { * @memberof WriteFolderRequest */ name: string; - /** - * Permission for a Folder - * - * * `1` - denied - * * `50` - read_only - * * `100` - read_write - * @type {number} - * @memberof WriteFolderRequest - */ - default_permission?: WriteFolderRequestDefaultPermissionEnum; /** * * @type {Array} @@ -69,9 +69,9 @@ export function WriteFolderRequestFromJSONTyped(json: any, ignoreDiscriminator: } return { + 'default_permission': !exists(json, 'default_permission') ? undefined : json['default_permission'], 'parent_id': !exists(json, 'parent_id') ? undefined : json['parent_id'], 'name': json['name'], - 'default_permission': !exists(json, 'default_permission') ? undefined : json['default_permission'], 'children': !exists(json, 'children') ? undefined : (json['children'] === null ? null : (json['children'] as Array).map(WriteFolderRequestFromJSON)), }; } @@ -85,9 +85,9 @@ export function WriteFolderRequestToJSON(value?: WriteFolderRequest | null): any } return { + 'default_permission': value.default_permission, 'parent_id': value.parent_id, 'name': value.name, - 'default_permission': value.default_permission, 'children': value.children === undefined ? undefined : (value.children === null ? null : (value.children as Array).map(WriteFolderRequestToJSON)), }; }