You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 18, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+47-15Lines changed: 47 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,19 +14,23 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
14
14
15
15
#### npm
16
16
17
-
To publish the library as a [npm](https://www.npmjs.com/),
18
-
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
17
+
To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
19
18
20
19
Then install it via:
21
20
22
21
```shell
23
22
npm install @bimdata/bimdata-api-client --save
24
23
```
25
24
25
+
Finaly, you need to build the module:
26
+
27
+
```shell
28
+
npm run build
29
+
```
30
+
26
31
##### Local development
27
32
28
-
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
29
-
into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
33
+
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
30
34
31
35
```shell
32
36
npm install
@@ -38,19 +42,21 @@ Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the follow
38
42
npm link
39
43
```
40
44
41
-
Finally, switch to the directory you want to use your @bimdata/bimdata-api-client from, and run:
45
+
To use the link you just defined in your project, switch to the directory you want to use your @bimdata/bimdata-api-client from, and run:
42
46
43
47
```shell
44
48
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
45
49
```
46
50
47
-
You should now be able to `require('@bimdata/bimdata-api-client')` in javascript files from the directory you ran the last
48
-
command above from.
51
+
Finaly, you need to build the module:
52
+
53
+
```shell
54
+
npm run build
55
+
```
49
56
50
57
#### git
51
-
#
52
-
If the library is hosted at a git repository, e.g.
53
-
https://github.com/GIT_USER_ID/GIT_REPO_ID
58
+
59
+
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
54
60
then install it via:
55
61
56
62
```shell
@@ -61,8 +67,7 @@ then install it via:
61
67
62
68
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
63
69
the above steps with Node.js and installing browserify with `npm install -g browserify`,
64
-
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually
65
-
use this library):
70
+
perform the following (assuming *main.js* is your entry file):
66
71
67
72
```shell
68
73
browserify main.js > bundle.js
@@ -96,17 +101,22 @@ Please follow the [installation](#installation) instruction and execute the foll
96
101
var bimdata =require('@bimdata/bimdata-api-client');
97
102
98
103
var defaultClient =bimdata.ApiClient.instance;
99
-
104
+
// Configure OAuth2 access token for authorization: BIMDataConnect
105
+
var BIMDataConnect =defaultClient.authentications['BIMDataConnect'];
106
+
BIMDataConnect.accessToken="YOUR ACCESS TOKEN"
100
107
// Configure API key authorization: Bearer
101
108
var Bearer =defaultClient.authentications['Bearer'];
102
109
Bearer.apiKey="YOUR API KEY"
103
110
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
104
111
//Bearer.apiKeyPrefix['Authorization'] = "Token"
112
+
// Configure OAuth2 access token for authorization: client_credentials
113
+
var client_credentials =defaultClient.authentications['client_credentials'];
0 commit comments