@@ -4,30 +4,30 @@ 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 |
7+ [ ** cancelCloudUserInvitation ** ] ( CloudApi.md#cancelCloudUserInvitation ) | ** DELETE ** /cloud/{cloud_pk}/invitation/{id} |
88[ ** createCloud** ] ( CloudApi.md#createCloud ) | ** POST** /cloud |
99[ ** createDemo** ] ( CloudApi.md#createDemo ) | ** POST** /cloud/{id}/create-demo |
1010[ ** deleteCloud** ] ( CloudApi.md#deleteCloud ) | ** DELETE** /cloud/{id} |
1111[ ** deleteCloudUser** ] ( CloudApi.md#deleteCloudUser ) | ** DELETE** /cloud/{cloud_pk}/user/{id} |
1212[ ** fullUpdateCloud** ] ( CloudApi.md#fullUpdateCloud ) | ** PUT** /cloud/{id} |
1313[ ** fullUpdateCloudUser** ] ( CloudApi.md#fullUpdateCloudUser ) | ** PUT** /cloud/{cloud_pk}/user/{id} |
1414[ ** getCloud** ] ( CloudApi.md#getCloud ) | ** GET** /cloud/{id} |
15+ [ ** getCloudInvitations** ] ( CloudApi.md#getCloudInvitations ) | ** GET** /cloud/{cloud_pk}/invitation |
1516[ ** getCloudSize** ] ( CloudApi.md#getCloudSize ) | ** GET** /cloud/{id}/size |
1617[ ** getCloudUser** ] ( CloudApi.md#getCloudUser ) | ** GET** /cloud/{cloud_pk}/user/{id} |
1718[ ** getCloudUsers** ] ( CloudApi.md#getCloudUsers ) | ** GET** /cloud/{cloud_pk}/user |
1819[ ** getClouds** ] ( CloudApi.md#getClouds ) | ** GET** /cloud |
20+ [ ** inviteCloudUser** ] ( CloudApi.md#inviteCloudUser ) | ** POST** /cloud/{cloud_pk}/invitation |
1921[ ** updateCloud** ] ( CloudApi.md#updateCloud ) | ** PATCH** /cloud/{id} |
2022[ ** updateCloudUser** ] ( CloudApi.md#updateCloudUser ) | ** PATCH** /cloud/{cloud_pk}/user/{id} |
2123
2224
23- <a name =" cloudInvite " ></a >
24- # ** cloudInvite **
25- > cloudInvite(id, cloudInvitation )
25+ <a name =" cancelCloudUserInvitation " ></a >
26+ # ** cancelCloudUserInvitation **
27+ > cancelCloudUserInvitation(cloudPk, id )
2628
2729
2830
29- Invite a cloud administrator. They will have the ADMIN role on the cloud and on each project of the cloud
30-
3131### Example
3232``` javascript
3333var bimdata = require (' @bimdata/bimdata-api-client'
@@ -39,9 +39,9 @@ Bearer.apiKey = 'YOUR API KEY';
3939// Bearer.apiKeyPrefix = 'Token';
4040
4141var apiInstance = new bimdata.CloudApi ();
42- var id = 56 ; // Number | A unique integer value identifying this cloud.
43- var cloudInvitation = new bimdata.CloudInvitation () ; // CloudInvitation |
44- apiInstance .cloudInvite (id, cloudInvitation ).then (function () {
42+ var cloudPk = " cloudPk_example " // String |
43+ var id = 56 ; // Number | A unique integer value identifying this invitation.
44+ apiInstance .cancelCloudUserInvitation (cloudPk, id ).then (function () {
4545 console .log (' API called successfully.'
4646}, function (error ) {
4747 console .error (error);
@@ -53,8 +53,8 @@ apiInstance.cloudInvite(id, cloudInvitation).then(function() {
5353
5454Name | Type | Description | Notes
5555------------- | ------------- | ------------- | -------------
56- ** id ** | ** Number ** | A unique integer value identifying this cloud. |
57- ** cloudInvitation ** | [ ** CloudInvitation ** ] ( CloudInvitation.md ) | |
56+ ** cloudPk ** | ** String ** | |
57+ ** id ** | ** Number ** | A unique integer value identifying this invitation. |
5858
5959### Return type
6060
@@ -66,7 +66,7 @@ null (empty response body)
6666
6767### HTTP request headers
6868
69- - ** Content-Type** : application/json
69+ - ** Content-Type** : Not defined
7070 - ** Accept** : Not defined
7171
7272<a name =" createCloud " ></a >
@@ -391,6 +391,51 @@ Name | Type | Description | Notes
391391
392392[ Bearer] ( ../README.md#Bearer )
393393
394+ ### HTTP request headers
395+
396+ - ** Content-Type** : Not defined
397+ - ** Accept** : application/json
398+
399+ <a name =" getCloudInvitations " ></a >
400+ # ** getCloudInvitations**
401+ > [ CloudInvitation] getCloudInvitations(cloudPk)
402+
403+
404+
405+ ### Example
406+ ``` javascript
407+ var bimdata = require (' @bimdata/bimdata-api-client'
408+ var defaultClient = bimdata .ApiClient .instance ;
409+ // Configure API key authorization: Bearer
410+ var Bearer = defaultClient .authentications [' Bearer'
411+ Bearer .apiKey = ' YOUR API KEY'
412+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
413+ // Bearer.apiKeyPrefix = 'Token';
414+
415+ var apiInstance = new bimdata.CloudApi ();
416+ var cloudPk = " cloudPk_example" // String |
417+ apiInstance .getCloudInvitations (cloudPk).then (function (data ) {
418+ console .log (' API called successfully. Returned data: ' + data);
419+ }, function (error ) {
420+ console .error (error);
421+ });
422+
423+ ```
424+
425+ ### Parameters
426+
427+ Name | Type | Description | Notes
428+ ------------- | ------------- | ------------- | -------------
429+ ** cloudPk** | ** String** | |
430+
431+ ### Return type
432+
433+ [ ** [ CloudInvitation] ** ] ( CloudInvitation.md )
434+
435+ ### Authorization
436+
437+ [ Bearer] ( ../README.md#Bearer )
438+
394439### HTTP request headers
395440
396441 - ** Content-Type** : Not defined
@@ -578,6 +623,55 @@ This endpoint does not need any parameter.
578623 - ** Content-Type** : Not defined
579624 - ** Accept** : application/json
580625
626+ <a name =" inviteCloudUser " ></a >
627+ # ** inviteCloudUser**
628+ > CloudInvitation inviteCloudUser(cloudPk, cloudInvitation)
629+
630+
631+
632+ When inviting someone already having a pending invitation, it will not update the invitation but simply send the user a new invitation mail
633+
634+ ### Example
635+ ``` javascript
636+ var bimdata = require (' @bimdata/bimdata-api-client'
637+ var defaultClient = bimdata .ApiClient .instance ;
638+ // Configure API key authorization: Bearer
639+ var Bearer = defaultClient .authentications [' Bearer'
640+ Bearer .apiKey = ' YOUR API KEY'
641+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
642+ // Bearer.apiKeyPrefix = 'Token';
643+
644+ var apiInstance = new bimdata.CloudApi ();
645+ var cloudPk = " cloudPk_example" // String |
646+ var cloudInvitation = new bimdata.CloudInvitation (); // CloudInvitation |
647+ apiInstance .inviteCloudUser (cloudPk, cloudInvitation).then (function (data ) {
648+ console .log (' API called successfully. Returned data: ' + data);
649+ }, function (error ) {
650+ console .error (error);
651+ });
652+
653+ ```
654+
655+ ### Parameters
656+
657+ Name | Type | Description | Notes
658+ ------------- | ------------- | ------------- | -------------
659+ ** cloudPk** | ** String** | |
660+ ** cloudInvitation** | [ ** CloudInvitation** ] ( CloudInvitation.md ) | |
661+
662+ ### Return type
663+
664+ [ ** CloudInvitation** ] ( CloudInvitation.md )
665+
666+ ### Authorization
667+
668+ [ Bearer] ( ../README.md#Bearer )
669+
670+ ### HTTP request headers
671+
672+ - ** Content-Type** : application/json
673+ - ** Accept** : application/json
674+
581675<a name =" updateCloud " ></a >
582676# ** updateCloud**
583677> Cloud updateCloud(id, cloud)
0 commit comments