PATCH: restore viewpoint patch (#706)

* restore viewpoint patch

* use ModelViewSet

Author: Bimdata-io

.openapi-generator/FILES

@@ -126,6 +126,7 @@ docs/PatchedTopicTypeRequest.md
 docs/PatchedUnitRequest.md
 docs/PatchedUserCloudUpdateRequest.md
 docs/PatchedUserProjectUpdateRequest.md
+docs/PatchedViewpointRequest.md
 docs/PatchedVisaCommentRequest.md
 docs/PatchedVisaRequest.md
 docs/PatchedVisaValidationRequest.md
@@ -374,6 +375,7 @@ src/model/PatchedTopicTypeRequest.js
 src/model/PatchedUnitRequest.js
 src/model/PatchedUserCloudUpdateRequest.js
 src/model/PatchedUserProjectUpdateRequest.js
+src/model/PatchedViewpointRequest.js
 src/model/PatchedVisaCommentRequest.js
 src/model/PatchedVisaRequest.js
 src/model/PatchedVisaValidationRequest.js
@@ -616,6 +618,7 @@ test/model/PatchedTopicTypeRequest.spec.js
 test/model/PatchedUnitRequest.spec.js
 test/model/PatchedUserCloudUpdateRequest.spec.js
 test/model/PatchedUserProjectUpdateRequest.spec.js
+test/model/PatchedViewpointRequest.spec.js
 test/model/PatchedVisaCommentRequest.spec.js
 test/model/PatchedVisaRequest.spec.js
 test/model/PatchedVisaValidationRequest.spec.js

README.md

@@ -202,6 +202,7 @@ Class | Method | HTTP request | Description
 *bimdata.BcfApi* | [**updateFullTopic**](docs/BcfApi.md#updateFullTopic) | **PATCH** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update some fields of a topic
 *bimdata.BcfApi* | [**updatePin**](docs/BcfApi.md#updatePin) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Update some fields of a Pin
 *bimdata.BcfApi* | [**updateTopic**](docs/BcfApi.md#updateTopic) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update some fields of a topic
+*bimdata.BcfApi* | [**updateViewpoint**](docs/BcfApi.md#updateViewpoint) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Update some fields of a Viewpoint
 *bimdata.CollaborationApi* | [**acceptUserInvitation**](docs/CollaborationApi.md#acceptUserInvitation) | **POST** /user/invitations/{id}/accept | Accept an invitation
 *bimdata.CollaborationApi* | [**acceptValidation**](docs/CollaborationApi.md#acceptValidation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/accept | Accept a validation
 *bimdata.CollaborationApi* | [**addDocumentTag**](docs/CollaborationApi.md#addDocumentTag) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/tag | Add a tag to a document
@@ -741,6 +742,7 @@ Class | Method | HTTP request | Description
  - [bimdata.PatchedUnitRequest](docs/PatchedUnitRequest.md)
  - [bimdata.PatchedUserCloudUpdateRequest](docs/PatchedUserCloudUpdateRequest.md)
  - [bimdata.PatchedUserProjectUpdateRequest](docs/PatchedUserProjectUpdateRequest.md)
+ - [bimdata.PatchedViewpointRequest](docs/PatchedViewpointRequest.md)
  - [bimdata.PatchedVisaCommentRequest](docs/PatchedVisaCommentRequest.md)
  - [bimdata.PatchedVisaRequest](docs/PatchedVisaRequest.md)
  - [bimdata.PatchedVisaValidationRequest](docs/PatchedVisaValidationRequest.md)

docs/BcfApi.md

@@ -65,6 +65,7 @@ Method | HTTP request | Description
 [**updateFullTopic**](BcfApi.md#updateFullTopic) | **PATCH** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update some fields of a topic
 [**updatePin**](BcfApi.md#updatePin) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Update some fields of a Pin
 [**updateTopic**](BcfApi.md#updateTopic) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update some fields of a topic
+[**updateViewpoint**](BcfApi.md#updateViewpoint) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Update some fields of a Viewpoint
 
 
 
@@ -4050,3 +4051,74 @@ Name | Type | Description  | Notes
 - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
+
+## updateViewpoint
+
+> Viewpoint updateViewpoint(guid, projectsPk, topicsGuid, opts)
+
+Update some fields of a Viewpoint
+
+This is not a standard route. Update some fields of a Viewpoint  Required scopes: bcf:write
+
+### Example
+
+```javascript
+import bimdata from '@bimdata/bimdata-api-client';
+let defaultClient = bimdata.ApiClient.instance;
+// Configure API key authorization: ApiKey
+let ApiKey = defaultClient.authentications['ApiKey'];
+ApiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//ApiKey.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: BIMData_Connect
+let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
+BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
+// Configure OAuth2 access token for authorization: BIMData_Connect
+let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
+BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
+// Configure API key authorization: Bearer
+let Bearer = defaultClient.authentications['Bearer'];
+Bearer.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//Bearer.apiKeyPrefix = 'Token';
+
+let apiInstance = new bimdata.BcfApi();
+let guid = "guid_example"; // String | 
+let projectsPk = 56; // Number | 
+let topicsGuid = "topicsGuid_example"; // String | 
+let opts = {
+  'imgFormat': "imgFormat_example", // String | All snapshot_data will be returned as url instead of base64
+  'patchedViewpointRequest': new bimdata.PatchedViewpointRequest() // PatchedViewpointRequest | 
+};
+apiInstance.updateViewpoint(guid, projectsPk, topicsGuid, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **guid** | **String**|  | 
+ **projectsPk** | **Number**|  | 
+ **topicsGuid** | **String**|  | 
+ **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] 
+ **patchedViewpointRequest** | [**PatchedViewpointRequest**](PatchedViewpointRequest.md)|  | [optional] 
+
+### Return type
+
+[**Viewpoint**](Viewpoint.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

docs/CollaborationApi.md

@@ -955,7 +955,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'DWG', 'DXF', 'OBJ', 'IFC', 'POINT_CLOUD', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'GLTF', 'DWG', 'DXF', 'POINT_CLOUD', 'IFC', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 

docs/PatchedViewpointRequest.md

@@ -0,0 +1,21 @@
+# bimdata.PatchedViewpointRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Number** |  | [optional] 
+**guid** | **String** |  | [optional] 
+**originatingSystem** | **String** | Name of the system in which the viewpoint is originated | [optional] 
+**authoringToolId** | **String** | System specific identifier of the viewpoint in the originating BIM tool | [optional] 
+**orthogonalCamera** | [**OrthogonalCameraRequest**](OrthogonalCameraRequest.md) |  | [optional] 
+**perspectiveCamera** | [**PerspectiveCameraRequest**](PerspectiveCameraRequest.md) |  | [optional] 
+**lines** | [**[LineRequest]**](LineRequest.md) |  | [optional] 
+**clippingPlanes** | [**[ClippingPlaneRequest]**](ClippingPlaneRequest.md) |  | [optional] 
+**snapshot** | [**SnapshotRequest**](SnapshotRequest.md) |  | [optional] 
+**components** | [**ComponentsParentRequest**](ComponentsParentRequest.md) |  | [optional] 
+**pins** | [**[PinRequest]**](PinRequest.md) | Non standard field. Pins (or markers/annotations) are points of interest. When creating a Viewpoint you can create pins with the fields `pins`, but you can't edit pins through here. You must use dedicated pin routes. | [optional] 
+**tempId** | **Number** | Only used when using POST on the full-topic route to bind viewpoint with comment | [optional] 
+**models** | **[Number]** |  | [optional] 
+
+

src/api/BcfApi.js

@@ -36,6 +36,7 @@ import PatchedStageRequest from '../model/PatchedStageRequest';
 import PatchedTopicRequest from '../model/PatchedTopicRequest';
 import PatchedTopicStatusRequest from '../model/PatchedTopicStatusRequest';
 import PatchedTopicTypeRequest from '../model/PatchedTopicTypeRequest';
+import PatchedViewpointRequest from '../model/PatchedViewpointRequest';
 import Pin from '../model/Pin';
 import PinRequest from '../model/PinRequest';
 import Priority from '../model/Priority';
@@ -3658,4 +3659,74 @@ export default class BcfApi {
     }
 
 
+    /**
+     * Update some fields of a Viewpoint
+     * This is not a standard route. Update some fields of a Viewpoint  Required scopes: bcf:write
+     * @param {String} guid 
+     * @param {Number} projectsPk 
+     * @param {String} topicsGuid 
+     * @param {Object} opts Optional parameters
+     * @param {module:model/String} opts.imgFormat All snapshot_data will be returned as url instead of base64
+     * @param {module:model/PatchedViewpointRequest} opts.patchedViewpointRequest 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Viewpoint} and HTTP response
+     */
+    updateViewpointWithHttpInfo(guid, projectsPk, topicsGuid, opts) {
+      opts = opts || {};
+      let postBody = opts['patchedViewpointRequest'];
+      // verify the required parameter 'guid' is set
+      if (guid === undefined || guid === null) {
+        throw new Error("Missing the required parameter 'guid' when calling updateViewpoint");
+      }
+      // verify the required parameter 'projectsPk' is set
+      if (projectsPk === undefined || projectsPk === null) {
+        throw new Error("Missing the required parameter 'projectsPk' when calling updateViewpoint");
+      }
+      // verify the required parameter 'topicsGuid' is set
+      if (topicsGuid === undefined || topicsGuid === null) {
+        throw new Error("Missing the required parameter 'topicsGuid' when calling updateViewpoint");
+      }
+
+      let pathParams = {
+        'guid': guid,
+        'projects_pk': projectsPk,
+        'topics_guid': topicsGuid
+      };
+      let queryParams = {
+        'img_format': opts['imgFormat']
+      };
+      let headerParams = {
+      };
+      let formParams = {
+      };
+
+      let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
+      let contentTypes = ['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'];
+      let accepts = ['application/json'];
+      let returnType = Viewpoint;
+      return this.apiClient.callApi(
+        '/bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}', 'PATCH',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Update some fields of a Viewpoint
+     * This is not a standard route. Update some fields of a Viewpoint  Required scopes: bcf:write
+     * @param {String} guid 
+     * @param {Number} projectsPk 
+     * @param {String} topicsGuid 
+     * @param {Object} opts Optional parameters
+     * @param {module:model/String} opts.imgFormat All snapshot_data will be returned as url instead of base64
+     * @param {module:model/PatchedViewpointRequest} opts.patchedViewpointRequest 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Viewpoint}
+     */
+    updateViewpoint(guid, projectsPk, topicsGuid, opts) {
+      return this.updateViewpointWithHttpInfo(guid, projectsPk, topicsGuid, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
 }

src/api/CollaborationApi.js

@@ -858,7 +858,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'DWG', 'DXF', 'OBJ', 'IFC', 'POINT_CLOUD', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'GLTF', 'DWG', 'DXF', 'POINT_CLOUD', 'IFC', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {String} name Shown name of the file
@@ -924,7 +924,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'DWG', 'DXF', 'OBJ', 'IFC', 'POINT_CLOUD', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'GLTF', 'DWG', 'DXF', 'POINT_CLOUD', 'IFC', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {String} name Shown name of the file

src/index.js

@@ -133,6 +133,7 @@ import PatchedTopicTypeRequest from './model/PatchedTopicTypeRequest';
 import PatchedUnitRequest from './model/PatchedUnitRequest';
 import PatchedUserCloudUpdateRequest from './model/PatchedUserCloudUpdateRequest';
 import PatchedUserProjectUpdateRequest from './model/PatchedUserProjectUpdateRequest';
+import PatchedViewpointRequest from './model/PatchedViewpointRequest';
 import PatchedVisaCommentRequest from './model/PatchedVisaCommentRequest';
 import PatchedVisaRequest from './model/PatchedVisaRequest';
 import PatchedVisaValidationRequest from './model/PatchedVisaValidationRequest';
@@ -1015,6 +1016,12 @@ export {
      */
     PatchedUserProjectUpdateRequest,
 
+    /**
+     * The PatchedViewpointRequest model constructor.
+     * @property {module:model/PatchedViewpointRequest}
+     */
+    PatchedViewpointRequest,
+
     /**
      * The PatchedVisaCommentRequest model constructor.
      * @property {module:model/PatchedVisaCommentRequest}

test/api/BcfApi.spec.js

@@ -658,6 +658,16 @@
         done();
       });
     });
+    describe('updateViewpoint', function() {
+      it('should call updateViewpoint successfully', function(done) {
+        //uncomment below and update the code to test updateViewpoint
+        //instance.updateViewpoint(function(error) {
+        //  if (error) throw error;
+        //expect().to.be();
+        //});
+        done();
+      });
+    });
   });
 
 }));