@@ -4,26 +4,26 @@ All URIs are relative to *https://api-beta.bimdata.io*
44
55Method | HTTP request | Description
66------------- | ------------- | -------------
7+ [ ** cloudInvite** ] ( CloudApi.md#cloudInvite ) | ** POST** /cloud/{id}/invite |
78[ ** createCloud** ] ( CloudApi.md#createCloud ) | ** POST** /cloud |
8- [ ** createCloudUser** ] ( CloudApi.md#createCloudUser ) | ** POST** /cloud/{cloud_pk}/user |
99[ ** createDemo** ] ( CloudApi.md#createDemo ) | ** POST** /cloud/{id}/create-demo |
1010[ ** deleteCloudUser** ] ( CloudApi.md#deleteCloudUser ) | ** DELETE** /cloud/{cloud_pk}/user/{id} |
1111[ ** fullUpdateCloud** ] ( CloudApi.md#fullUpdateCloud ) | ** PUT** /cloud/{id} |
12- [ ** fullUpdateCloudUser** ] ( CloudApi.md#fullUpdateCloudUser ) | ** PUT** /cloud/{cloud_pk}/user/{id} |
1312[ ** getCloud** ] ( CloudApi.md#getCloud ) | ** GET** /cloud/{id} |
1413[ ** getCloudSize** ] ( CloudApi.md#getCloudSize ) | ** GET** /cloud/{id}/size |
1514[ ** getCloudUser** ] ( CloudApi.md#getCloudUser ) | ** GET** /cloud/{cloud_pk}/user/{id} |
1615[ ** getCloudUsers** ] ( CloudApi.md#getCloudUsers ) | ** GET** /cloud/{cloud_pk}/user |
1716[ ** getClouds** ] ( CloudApi.md#getClouds ) | ** GET** /cloud |
1817[ ** updateCloud** ] ( CloudApi.md#updateCloud ) | ** PATCH** /cloud/{id} |
19- [ ** updateCloudUser** ] ( CloudApi.md#updateCloudUser ) | ** PATCH** /cloud/{cloud_pk}/user/{id} |
2018
2119
22- <a name =" createCloud " ></a >
23- # ** createCloud**
24- > Cloud createCloud(cloud)
20+ <a name =" cloudInvite " ></a >
21+ # ** cloudInvite**
22+ > cloudInvite(id, cloudInvitation)
23+
2524
2625
26+ Invite a cloud administrator. They will have the ADMIN role on the cloud and on each project of the cloud
2727
2828### Example
2929``` javascript
@@ -36,9 +36,10 @@ Bearer.apiKey = 'YOUR API KEY';
3636// Bearer.apiKeyPrefix = 'Token';
3737
3838var apiInstance = new bimdata.CloudApi ();
39- var cloud = new bimdata.Cloud (); // Cloud |
40- apiInstance .createCloud (cloud).then (function (data ) {
41- console .log (' API called successfully. Returned data: ' + data);
39+ var id = 56 ; // Number | A unique integer value identifying this cloud.
40+ var cloudInvitation = new bimdata.CloudInvitation (); // CloudInvitation |
41+ apiInstance .cloudInvite (id, cloudInvitation).then (function () {
42+ console .log (' API called successfully.'
4243}, function (error ) {
4344 console .error (error);
4445});
@@ -49,11 +50,12 @@ apiInstance.createCloud(cloud).then(function(data) {
4950
5051Name | Type | Description | Notes
5152------------- | ------------- | ------------- | -------------
52- ** cloud** | [ ** Cloud** ] ( Cloud.md ) | |
53+ ** id** | ** Number** | A unique integer value identifying this cloud. |
54+ ** cloudInvitation** | [ ** CloudInvitation** ] ( CloudInvitation.md ) | |
5355
5456### Return type
5557
56- [ ** Cloud ** ] ( Cloud.md )
58+ null (empty response body )
5759
5860### Authorization
5961
@@ -62,11 +64,11 @@ Name | Type | Description | Notes
6264### HTTP request headers
6365
6466 - ** Content-Type** : application/json
65- - ** Accept** : application/json
67+ - ** Accept** : Not defined
6668
67- <a name =" createCloudUser " ></a >
68- # ** createCloudUser **
69- > InviteUser createCloudUser(cloudPk, inviteUser )
69+ <a name =" createCloud " ></a >
70+ # ** createCloud **
71+ > Cloud createCloud(cloud )
7072
7173
7274
@@ -81,9 +83,8 @@ Bearer.apiKey = 'YOUR API KEY';
8183// Bearer.apiKeyPrefix = 'Token';
8284
8385var apiInstance = new bimdata.CloudApi ();
84- var cloudPk = " cloudPk_example" // String |
85- var inviteUser = new bimdata.InviteUser (); // InviteUser |
86- apiInstance .createCloudUser (cloudPk, inviteUser).then (function (data ) {
86+ var cloud = new bimdata.Cloud (); // Cloud |
87+ apiInstance .createCloud (cloud).then (function (data ) {
8788 console .log (' API called successfully. Returned data: ' + data);
8889}, function (error ) {
8990 console .error (error);
@@ -95,12 +96,11 @@ apiInstance.createCloudUser(cloudPk, inviteUser).then(function(data) {
9596
9697Name | Type | Description | Notes
9798------------- | ------------- | ------------- | -------------
98- ** cloudPk** | ** String** | |
99- ** inviteUser** | [ ** InviteUser** ] ( InviteUser.md ) | |
99+ ** cloud** | [ ** Cloud** ] ( Cloud.md ) | |
100100
101101### Return type
102102
103- [ ** InviteUser ** ] ( InviteUser .md)
103+ [ ** Cloud ** ] ( Cloud .md)
104104
105105### Authorization
106106
@@ -247,55 +247,6 @@ Name | Type | Description | Notes
247247
248248[ Bearer] ( ../README.md#Bearer )
249249
250- ### HTTP request headers
251-
252- - ** Content-Type** : application/json
253- - ** Accept** : application/json
254-
255- <a name =" fullUpdateCloudUser " ></a >
256- # ** fullUpdateCloudUser**
257- > InviteUser fullUpdateCloudUser(cloudPk, id, inviteUser)
258-
259-
260-
261- ### Example
262- ``` javascript
263- var bimdata = require (' @bimdata/bimdata-api-client'
264- var defaultClient = bimdata .ApiClient .instance ;
265- // Configure API key authorization: Bearer
266- var Bearer = defaultClient .authentications [' Bearer'
267- Bearer .apiKey = ' YOUR API KEY'
268- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
269- // Bearer.apiKeyPrefix = 'Token';
270-
271- var apiInstance = new bimdata.CloudApi ();
272- var cloudPk = " cloudPk_example" // String |
273- var id = " id_example" // String |
274- var inviteUser = new bimdata.InviteUser (); // InviteUser |
275- apiInstance .fullUpdateCloudUser (cloudPk, id, inviteUser).then (function (data ) {
276- console .log (' API called successfully. Returned data: ' + data);
277- }, function (error ) {
278- console .error (error);
279- });
280-
281- ```
282-
283- ### Parameters
284-
285- Name | Type | Description | Notes
286- ------------- | ------------- | ------------- | -------------
287- ** cloudPk** | ** String** | |
288- ** id** | ** String** | |
289- ** inviteUser** | [ ** InviteUser** ] ( InviteUser.md ) | |
290-
291- ### Return type
292-
293- [ ** InviteUser** ] ( InviteUser.md )
294-
295- ### Authorization
296-
297- [ Bearer] ( ../README.md#Bearer )
298-
299250### HTTP request headers
300251
301252 - ** Content-Type** : application/json
@@ -575,52 +526,3 @@ Name | Type | Description | Notes
575526 - ** Content-Type** : application/json
576527 - ** Accept** : application/json
577528
578- <a name =" updateCloudUser " ></a >
579- # ** updateCloudUser**
580- > InviteUser updateCloudUser(cloudPk, id, inviteUser)
581-
582-
583-
584- ### Example
585- ``` javascript
586- var bimdata = require (' @bimdata/bimdata-api-client'
587- var defaultClient = bimdata .ApiClient .instance ;
588- // Configure API key authorization: Bearer
589- var Bearer = defaultClient .authentications [' Bearer'
590- Bearer .apiKey = ' YOUR API KEY'
591- // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
592- // Bearer.apiKeyPrefix = 'Token';
593-
594- var apiInstance = new bimdata.CloudApi ();
595- var cloudPk = " cloudPk_example" // String |
596- var id = " id_example" // String |
597- var inviteUser = new bimdata.InviteUser (); // InviteUser |
598- apiInstance .updateCloudUser (cloudPk, id, inviteUser).then (function (data ) {
599- console .log (' API called successfully. Returned data: ' + data);
600- }, function (error ) {
601- console .error (error);
602- });
603-
604- ```
605-
606- ### Parameters
607-
608- Name | Type | Description | Notes
609- ------------- | ------------- | ------------- | -------------
610- ** cloudPk** | ** String** | |
611- ** id** | ** String** | |
612- ** inviteUser** | [ ** InviteUser** ] ( InviteUser.md ) | |
613-
614- ### Return type
615-
616- [ ** InviteUser** ] ( InviteUser.md )
617-
618- ### Authorization
619-
620- [ Bearer] ( ../README.md#Bearer )
621-
622- ### HTTP request headers
623-
624- - ** Content-Type** : application/json
625- - ** Accept** : application/json
626-
0 commit comments