@manycore/bldg-rest-client

@manycore/bldg-rest-client@0.0.1

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @manycore/bldg-rest-client@0.0.1 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.manycoreapis.com

Class	Method	HTTP request	Description
BLDGApi	batchUpdate	POST /bldg/openapi/v1/designs/{obsDesignId}/levels/{levelId}:batchupdate	批量更新建筑户型数据
BLDGApi	buildGeometry	POST /bldg/openapi/v1/designs/{obsDesignId}/levels/{levelId}:buildgeometry	基于视图级别获取建筑户型建模结果
BLDGApi	getFloorplanDocument	GET /bldg/openapi/v1/designs/{obsDesignId}/levels/{levelId}	根据楼层ID获取建筑户型数据

Documentation For Models

• ArbitraryClosedProfile
• Beam
• BeamCreateRequest
• BeamUpdateRequest
• BoundedAxis
• Chimney
• ChimneyCreateRequest
• ChimneyUpdateRequest
• CircleProfile
• Compass
• ElementFace
• ElementJoint
• ExtrudedAreaSolid
• FaceDescription
• FaceElementType
• FaceGeometryType
• FaceLocationType
• FloorOpening
• FloorOpeningCreateRequest
• FloorOpeningUpdateRequest
• FloorplanBuildGeometryRequest
• FloorplanConfig
• FloorplanConfigUpdateRequest
• FloorplanDocument
• FloorplanDocumentBatchUpdateRequest
• FloorplanDocumentBatchUpdateResponse
• FloorplanDocumentOperateRequest
• FloorplanDocumentView
• FloorplanElement
• FloorplanElementDeleteRequest
• FloorplanElementGeometry
• FloorplanElementUpdateResponse
• FloorplanGeometryResponse
• GeometricRepresentationItem
• OffGroundType
• Opening
• OpeningCreateRequest
• OpeningSourceType
• OpeningType
• OpeningUpdateRequest
• Pillar
• PillarCreateRequest
• PillarUpdateRequest
• Profile
• RectangleProfile
• Room
• RoomSeparator
• RoomSeparatorCreateRequest
• RoomSeparatorUpdateRequest
• RoomType
• RoomUpdateRequest
• Wall
• WallCreateRequest
• WallType
• WallUpdateRequest

Documentation For Authorization

Endpoints do not require authorization.