@shapediver/sdk.platform-api-sdk-v1 2.9.2 → 2.9.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -10,10 +10,10 @@
10
10
  # ShapeDiver Platform SDK
11
11
  [ShapeDiver](https://www.shapediver.com/) is a cloud platform that provides the right tools and scalable infrastructure to help you transform your Grasshopper files into online applications. It allows you to share the power of Grasshopper and Parametric Design with partners, clients and other key stakeholders wherever they are.
12
12
 
13
- The **ShapeDiver Platform SDK** allows to access the functionality of the [ShapeDiver Platform](https://www.shapediver.com/app/) (or white labelled instances of it) by means of the [ShapeDiver Platform API](https://app.shapediver.com/api/documentation).
13
+ The **ShapeDiver Platform SDK** allows to access the functionality of the [ShapeDiver Platform](https://www.shapediver.com/app/) (or white labelled instances of it) by means of the [ShapeDiver Platform API](https://help.shapediver.com/doc/platform-backend).
14
14
  The SDK exposes all TypeScript-types describing request and response objects.
15
15
 
16
- The authentication system is based on **JWT tokens**, which the SDK allows you to request from the **ShapeDiver Platform** using the OAuth 2.0 functionality integrated with the [ShapeDiver Platform API](https://app.shapediver.com/api/documentation).
16
+ The authentication system is based on **JWT tokens**, which the SDK allows you to request from the **ShapeDiver Platform** using the OAuth 2.0 functionality integrated with the [ShapeDiver Platform API](https://help.shapediver.com/doc/platform-backend).
17
17
 
18
18
  ## Usage
19
19
 
@@ -29,16 +29,27 @@ The authentication system is based on **JWT tokens**, which the SDK allows you t
29
29
  * Create and authorize client:
30
30
  ```javascript
31
31
  const client = create({clientId: "CLIENT_ID", baseUrl: "SHAPEDIVER_PLATFORM_API_ENDPOINT"});
32
- await client.authorization.passwordGrant("USERNAME", "PASSWORD");
32
+ await client.authorization.passwordGrant("USERNAME OR ACCESS KEY ID", "PASSWORD OR ACCESS KEY SECRET");
33
33
  ```
34
34
 
35
+ Whenever possible do not use your username and password for usage of the SDK. Instead log in to the [ShapeDiver Platform](https://www.shapediver.com/app/) and create an access key pair, consisting of an
36
+
37
+ * access key id (to be used instead of your username), and an
38
+ * access key secret (to be used instead of your password).
39
+
40
+ Using access keys allows you to keep your application secure, because access keys
41
+
42
+ * can be limited in scope (e.g. they can be limited to be read only)
43
+ * can easily be revoked at any time
44
+ * can be time limited.
45
+
35
46
  ## Versioning
36
47
  We take care to provide backwards compatibility for older versions of the SDK and the API, but might introduce breaking changes in case of major version upgrades.
37
48
  New features of the SDK might be limited to newer versions of the API. We recommend always using the newest SDK version out there.
38
49
 
39
50
  ## Support
40
51
 
41
- * [Plaform Backend documentation](https://help.shapediver.com/doc/Platform-Backend.1863876635.html)
52
+ * [Plaform Backend documentation](https://help.shapediver.com/doc/platform-backend)
42
53
  * [ShapeDiver Help Center](https://help.shapediver.com)
43
54
  * [Forum](https://forum.shapediver.com)
44
55
 
@@ -80,6 +80,7 @@ export declare enum RequestId {
80
80
  NotificationPatch = "notification_patch",
81
81
  NotificationDelete = "notification_delete",
82
82
  NotificationSummary = "notification_summary",
83
+ NotificationReadAll = "notification_read_all",
83
84
  UserModelSessionsQuery = "user_model_sessions_query",
84
85
  OrganizationModelSessionsQuery = "organization_model_sessions_query",
85
86
  ChargebeeHostedPage = "chargebee_hosted_page",
@@ -94,12 +95,14 @@ export declare enum RequestId {
94
95
  ModelSharingQueryByUser = "model_sharing_query_by_user",
95
96
  ModelSharingGetByModelAndUser = "model_sharing_get_by_model_and_user",
96
97
  ModelSharingDelete = "model_sharing_delete",
98
+ ModelSharingGroupedByuser = "model_sharing_grouped_by_user",
97
99
  SavedStateSharingCreate = "saved_state_sharing_create",
98
100
  SavedStateSharingQuery = "saved_state_sharing_query",
99
101
  SavedStateSharingQueryBySavedState = "saved_state_sharing_query_by_saved_state",
100
102
  SavedStateSharingQueryByUser = "saved_state_sharing_query_by_user",
101
103
  SavedStateSharingGetBySavedStateAndUser = "saved_state_sharing_get_by_saved_state_and_user",
102
104
  SavedStateSharingDelete = "saved_state_sharing_delete",
105
+ SavedStateSharingGroupedByuser = "saved_state_sharing_grouped_by_user",
103
106
  WebhookChargebeeEvent = "webhook_chargebee_event",
104
107
  WebhookModelMessage = "webhook_model_message",
105
108
  WebhookNotification = "webhook_notification",
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformRequestId.d.ts","sourceRoot":"","sources":["../../src/api/SdPlatformRequestId.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,SAAS;IAEjB;;OAEG;IACH,aAAa,mBAAmB;IAChC,YAAY,kBAAkB;IAC9B,iBAAiB,uBAAuB;IACxC,MAAM,WAAW;IAEjB;;OAEG;IACH,WAAW,kBAAkB;IAC7B,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IACnC,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IAEnC,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,kBAAkB,yBAAyB;IAC3C,kBAAkB,yBAAyB;IAE3C,cAAc,oBAAoB;IAClC,cAAc,oBAAoB;IAElC,QAAQ,cAAc;IACtB,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,YAAY,iBAAiB;IAE7B,SAAS,eAAe;IACxB,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAE9B,MAAM,YAAY;IAClB,QAAQ,cAAc;IAEtB,WAAW,iBAAiB;IAE5B,OAAO,aAAa;IACpB,SAAS,eAAe;IACxB,SAAS,eAAe;IACxB,UAAU,gBAAgB;IAC1B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAE5B,aAAa,mBAAmB;IAChC,oBAAoB,2BAA2B;IAE/C,QAAQ,cAAc;IACtB,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,aAAa,mBAAmB;IAEhC,aAAa,oBAAoB;IACjC,eAAe,sBAAsB;IACrC,eAAe,sBAAsB;IACrC,gBAAgB,uBAAuB;IACvC,gBAAgB,uBAAuB;IAEvC,SAAS,eAAe;IACxB,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAE9B,iBAAiB,wBAAwB;IACzC,oBAAoB,2BAA2B;IAC/C,mBAAmB,0BAA0B;IAC7C,mBAAmB,0BAA0B;IAC7C,oBAAoB,2BAA2B;IAE/C,eAAe,qBAAqB;IACpC,iBAAiB,uBAAuB;IACxC,kBAAkB,wBAAwB;IAC1C,kBAAkB,wBAAwB;IAC1C,iBAAiB,uBAAuB;IACxC,4BAA4B,mCAAmC;IAC/D,4BAA4B,mCAAmC;IAC/D,0BAA0B,gCAAgC;IAC1D,4BAA4B,mCAAmC;IAC/D,0BAA0B,iCAAiC;IAC3D,2BAA2B,mCAAmC;IAE9D,iBAAiB,uBAAuB;IACxC,kBAAkB,wBAAwB;IAC1C,iBAAiB,uBAAuB;IACxC,kBAAkB,wBAAwB;IAC1C,mBAAmB,yBAAyB;IAE5C,sBAAsB,8BAA8B;IAEpD,8BAA8B,sCAAsC;IAEpE,mBAAmB,0BAA0B;IAC7C,sCAAsC,gDAAgD;IACtF,sBAAsB,6BAA6B;IACnD,eAAe,qBAAqB;IACpC,kBAAkB,yBAAyB;IAE3C,YAAY,mBAAmB;IAE/B,kBAAkB,yBAAyB;IAC3C,iBAAiB,wBAAwB;IACzC,wBAAwB,iCAAiC;IACzD,uBAAuB,gCAAgC;IACvD,6BAA6B,wCAAwC;IACrE,kBAAkB,yBAAyB;IAE3C,uBAAuB,+BAA+B;IACtD,sBAAsB,8BAA8B;IACpD,kCAAkC,6CAA6C;IAC/E,4BAA4B,sCAAsC;IAClE,uCAAuC,oDAAoD;IAC3F,uBAAuB,+BAA+B;IAEtD,qBAAqB,4BAA4B;IACjD,mBAAmB,0BAA0B;IAC7C,mBAAmB,yBAAyB;IAE5C,0BAA0B,kCAAkC;IAC5D,0BAA0B,kCAAkC;IAC5D,wBAAwB,gCAAgC;IACxD,uBAAuB,+BAA+B;IACtD,0BAA0B,kCAAkC;IAC5D,wBAAwB,gCAAgC;IAExD,cAAc,oBAAoB;IAClC,aAAa,mBAAmB;IAChC,cAAc,oBAAoB;IAClC,YAAY,kBAAkB;IAC9B,gBAAgB,sBAAsB;IACtC,YAAY,kBAAkB;IAC9B,cAAc,oBAAoB;IAClC,uBAAuB,8BAA8B;IACrD,mBAAmB,0BAA0B;CAChD"}
1
+ {"version":3,"file":"SdPlatformRequestId.d.ts","sourceRoot":"","sources":["../../src/api/SdPlatformRequestId.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,SAAS;IAEjB;;OAEG;IACH,aAAa,mBAAmB;IAChC,YAAY,kBAAkB;IAC9B,iBAAiB,uBAAuB;IACxC,MAAM,WAAW;IAEjB;;OAEG;IACH,WAAW,kBAAkB;IAC7B,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IACnC,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IAEnC,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,kBAAkB,yBAAyB;IAC3C,kBAAkB,yBAAyB;IAE3C,cAAc,oBAAoB;IAClC,cAAc,oBAAoB;IAElC,QAAQ,cAAc;IACtB,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,YAAY,iBAAiB;IAE7B,SAAS,eAAe;IACxB,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAE9B,MAAM,YAAY;IAClB,QAAQ,cAAc;IAEtB,WAAW,iBAAiB;IAE5B,OAAO,aAAa;IACpB,SAAS,eAAe;IACxB,SAAS,eAAe;IACxB,UAAU,gBAAgB;IAC1B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAE5B,aAAa,mBAAmB;IAChC,oBAAoB,2BAA2B;IAE/C,QAAQ,cAAc;IACtB,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,aAAa,mBAAmB;IAEhC,aAAa,oBAAoB;IACjC,eAAe,sBAAsB;IACrC,eAAe,sBAAsB;IACrC,gBAAgB,uBAAuB;IACvC,gBAAgB,uBAAuB;IAEvC,SAAS,eAAe;IACxB,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAE9B,iBAAiB,wBAAwB;IACzC,oBAAoB,2BAA2B;IAC/C,mBAAmB,0BAA0B;IAC7C,mBAAmB,0BAA0B;IAC7C,oBAAoB,2BAA2B;IAE/C,eAAe,qBAAqB;IACpC,iBAAiB,uBAAuB;IACxC,kBAAkB,wBAAwB;IAC1C,kBAAkB,wBAAwB;IAC1C,iBAAiB,uBAAuB;IACxC,4BAA4B,mCAAmC;IAC/D,4BAA4B,mCAAmC;IAC/D,0BAA0B,gCAAgC;IAC1D,4BAA4B,mCAAmC;IAC/D,0BAA0B,iCAAiC;IAC3D,2BAA2B,mCAAmC;IAE9D,iBAAiB,uBAAuB;IACxC,kBAAkB,wBAAwB;IAC1C,iBAAiB,uBAAuB;IACxC,kBAAkB,wBAAwB;IAC1C,mBAAmB,yBAAyB;IAC5C,mBAAmB,0BAA0B;IAE7C,sBAAsB,8BAA8B;IAEpD,8BAA8B,sCAAsC;IAEpE,mBAAmB,0BAA0B;IAC7C,sCAAsC,gDAAgD;IACtF,sBAAsB,6BAA6B;IACnD,eAAe,qBAAqB;IACpC,kBAAkB,yBAAyB;IAE3C,YAAY,mBAAmB;IAE/B,kBAAkB,yBAAyB;IAC3C,iBAAiB,wBAAwB;IACzC,wBAAwB,iCAAiC;IACzD,uBAAuB,gCAAgC;IACvD,6BAA6B,wCAAwC;IACrE,kBAAkB,yBAAyB;IAC3C,yBAAyB,kCAAkC;IAE3D,uBAAuB,+BAA+B;IACtD,sBAAsB,8BAA8B;IACpD,kCAAkC,6CAA6C;IAC/E,4BAA4B,sCAAsC;IAClE,uCAAuC,oDAAoD;IAC3F,uBAAuB,+BAA+B;IACtD,8BAA8B,wCAAwC;IAEtE,qBAAqB,4BAA4B;IACjD,mBAAmB,0BAA0B;IAC7C,mBAAmB,yBAAyB;IAE5C,0BAA0B,kCAAkC;IAC5D,0BAA0B,kCAAkC;IAC5D,wBAAwB,gCAAgC;IACxD,uBAAuB,+BAA+B;IACtD,0BAA0B,kCAAkC;IAC5D,wBAAwB,gCAAgC;IAExD,cAAc,oBAAoB;IAClC,aAAa,mBAAmB;IAChC,cAAc,oBAAoB;IAClC,YAAY,kBAAkB;IAC9B,gBAAgB,sBAAsB;IACtC,YAAY,kBAAkB;IAC9B,cAAc,oBAAoB;IAClC,uBAAuB,8BAA8B;IACrD,mBAAmB,0BAA0B;CAChD"}
package/dist/bundle.js CHANGED
@@ -1352,6 +1352,7 @@ var RequestId;
1352
1352
  RequestId["NotificationPatch"] = "notification_patch";
1353
1353
  RequestId["NotificationDelete"] = "notification_delete";
1354
1354
  RequestId["NotificationSummary"] = "notification_summary";
1355
+ RequestId["NotificationReadAll"] = "notification_read_all";
1355
1356
  RequestId["UserModelSessionsQuery"] = "user_model_sessions_query";
1356
1357
  RequestId["OrganizationModelSessionsQuery"] = "organization_model_sessions_query";
1357
1358
  RequestId["ChargebeeHostedPage"] = "chargebee_hosted_page";
@@ -1366,12 +1367,14 @@ var RequestId;
1366
1367
  RequestId["ModelSharingQueryByUser"] = "model_sharing_query_by_user";
1367
1368
  RequestId["ModelSharingGetByModelAndUser"] = "model_sharing_get_by_model_and_user";
1368
1369
  RequestId["ModelSharingDelete"] = "model_sharing_delete";
1370
+ RequestId["ModelSharingGroupedByuser"] = "model_sharing_grouped_by_user";
1369
1371
  RequestId["SavedStateSharingCreate"] = "saved_state_sharing_create";
1370
1372
  RequestId["SavedStateSharingQuery"] = "saved_state_sharing_query";
1371
1373
  RequestId["SavedStateSharingQueryBySavedState"] = "saved_state_sharing_query_by_saved_state";
1372
1374
  RequestId["SavedStateSharingQueryByUser"] = "saved_state_sharing_query_by_user";
1373
1375
  RequestId["SavedStateSharingGetBySavedStateAndUser"] = "saved_state_sharing_get_by_saved_state_and_user";
1374
1376
  RequestId["SavedStateSharingDelete"] = "saved_state_sharing_delete";
1377
+ RequestId["SavedStateSharingGroupedByuser"] = "saved_state_sharing_grouped_by_user";
1375
1378
  RequestId["WebhookChargebeeEvent"] = "webhook_chargebee_event";
1376
1379
  RequestId["WebhookModelMessage"] = "webhook_model_message";
1377
1380
  RequestId["WebhookNotification"] = "webhook_notification";
@@ -2355,6 +2358,14 @@ class SdPlatformModelSharingApi extends ResourcesApi_1.ResourcesApi {
2355
2358
  delete(model_sharing_id) {
2356
2359
  return super.__delete(SdPlatformRequestId_1.RequestId.ModelSharingDelete, model_sharing_id);
2357
2360
  }
2361
+ /**
2362
+ * Gets the model sharings grouped by user.
2363
+ * @param model_id
2364
+ * @returns
2365
+ */
2366
+ getGroupedByUser(model_id) {
2367
+ return super.__action(SdPlatformRequestId_1.RequestId.ModelSharingGroupedByuser, ResourcesApi_1.Action.Get, `model/${model_id}/grouped_by_user`, {});
2368
+ }
2358
2369
  }
2359
2370
  exports.SdPlatformModelSharingApi = SdPlatformModelSharingApi;
2360
2371
 
@@ -2499,6 +2510,13 @@ class SdPlatformNotificationApi extends ResourcesApi_1.ResourcesApi {
2499
2510
  summary(embed) {
2500
2511
  return super.__get(SdPlatformRequestId_1.RequestId.NotificationSummary, 'summary', embed);
2501
2512
  }
2513
+ /**
2514
+ * Marks all notifications of signed in user as read.
2515
+ * @returns { Promise<SdPlatformPostResponse<void>> }
2516
+ */
2517
+ markAllAsRead() {
2518
+ return super.__action(SdPlatformRequestId_1.RequestId.NotificationReadAll, ResourcesApi_1.Action.Post, 'read_all', {});
2519
+ }
2502
2520
  }
2503
2521
  exports.SdPlatformNotificationApi = SdPlatformNotificationApi;
2504
2522
 
@@ -2808,6 +2826,14 @@ class SdPlatformSavedStateSharingApi extends ResourcesApi_1.ResourcesApi {
2808
2826
  queryByUser(user_id, query) {
2809
2827
  return super.__action(SdPlatformRequestId_1.RequestId.SavedStateSharingQueryByUser, ResourcesApi_1.Action.Post, `user/${user_id}/query`, query);
2810
2828
  }
2829
+ /**
2830
+ * Gets the model sharings grouped by user.
2831
+ * @param saved_state_id
2832
+ * @returns
2833
+ */
2834
+ getGroupedByUser(saved_state_id) {
2835
+ return super.__action(SdPlatformRequestId_1.RequestId.SavedStateSharingGroupedByuser, ResourcesApi_1.Action.Get, `saved_state/${saved_state_id}/grouped_by_user`, {});
2836
+ }
2811
2837
  }
2812
2838
  exports.SdPlatformSavedStateSharingApi = SdPlatformSavedStateSharingApi;
2813
2839
 
@@ -1352,6 +1352,7 @@ var RequestId;
1352
1352
  RequestId["NotificationPatch"] = "notification_patch";
1353
1353
  RequestId["NotificationDelete"] = "notification_delete";
1354
1354
  RequestId["NotificationSummary"] = "notification_summary";
1355
+ RequestId["NotificationReadAll"] = "notification_read_all";
1355
1356
  RequestId["UserModelSessionsQuery"] = "user_model_sessions_query";
1356
1357
  RequestId["OrganizationModelSessionsQuery"] = "organization_model_sessions_query";
1357
1358
  RequestId["ChargebeeHostedPage"] = "chargebee_hosted_page";
@@ -1366,12 +1367,14 @@ var RequestId;
1366
1367
  RequestId["ModelSharingQueryByUser"] = "model_sharing_query_by_user";
1367
1368
  RequestId["ModelSharingGetByModelAndUser"] = "model_sharing_get_by_model_and_user";
1368
1369
  RequestId["ModelSharingDelete"] = "model_sharing_delete";
1370
+ RequestId["ModelSharingGroupedByuser"] = "model_sharing_grouped_by_user";
1369
1371
  RequestId["SavedStateSharingCreate"] = "saved_state_sharing_create";
1370
1372
  RequestId["SavedStateSharingQuery"] = "saved_state_sharing_query";
1371
1373
  RequestId["SavedStateSharingQueryBySavedState"] = "saved_state_sharing_query_by_saved_state";
1372
1374
  RequestId["SavedStateSharingQueryByUser"] = "saved_state_sharing_query_by_user";
1373
1375
  RequestId["SavedStateSharingGetBySavedStateAndUser"] = "saved_state_sharing_get_by_saved_state_and_user";
1374
1376
  RequestId["SavedStateSharingDelete"] = "saved_state_sharing_delete";
1377
+ RequestId["SavedStateSharingGroupedByuser"] = "saved_state_sharing_grouped_by_user";
1375
1378
  RequestId["WebhookChargebeeEvent"] = "webhook_chargebee_event";
1376
1379
  RequestId["WebhookModelMessage"] = "webhook_model_message";
1377
1380
  RequestId["WebhookNotification"] = "webhook_notification";
@@ -2355,6 +2358,14 @@ class SdPlatformModelSharingApi extends ResourcesApi_1.ResourcesApi {
2355
2358
  delete(model_sharing_id) {
2356
2359
  return super.__delete(SdPlatformRequestId_1.RequestId.ModelSharingDelete, model_sharing_id);
2357
2360
  }
2361
+ /**
2362
+ * Gets the model sharings grouped by user.
2363
+ * @param model_id
2364
+ * @returns
2365
+ */
2366
+ getGroupedByUser(model_id) {
2367
+ return super.__action(SdPlatformRequestId_1.RequestId.ModelSharingGroupedByuser, ResourcesApi_1.Action.Get, `model/${model_id}/grouped_by_user`, {});
2368
+ }
2358
2369
  }
2359
2370
  exports.SdPlatformModelSharingApi = SdPlatformModelSharingApi;
2360
2371
 
@@ -2499,6 +2510,13 @@ class SdPlatformNotificationApi extends ResourcesApi_1.ResourcesApi {
2499
2510
  summary(embed) {
2500
2511
  return super.__get(SdPlatformRequestId_1.RequestId.NotificationSummary, 'summary', embed);
2501
2512
  }
2513
+ /**
2514
+ * Marks all notifications of signed in user as read.
2515
+ * @returns { Promise<SdPlatformPostResponse<void>> }
2516
+ */
2517
+ markAllAsRead() {
2518
+ return super.__action(SdPlatformRequestId_1.RequestId.NotificationReadAll, ResourcesApi_1.Action.Post, 'read_all', {});
2519
+ }
2502
2520
  }
2503
2521
  exports.SdPlatformNotificationApi = SdPlatformNotificationApi;
2504
2522
 
@@ -2808,6 +2826,14 @@ class SdPlatformSavedStateSharingApi extends ResourcesApi_1.ResourcesApi {
2808
2826
  queryByUser(user_id, query) {
2809
2827
  return super.__action(SdPlatformRequestId_1.RequestId.SavedStateSharingQueryByUser, ResourcesApi_1.Action.Post, `user/${user_id}/query`, query);
2810
2828
  }
2829
+ /**
2830
+ * Gets the model sharings grouped by user.
2831
+ * @param saved_state_id
2832
+ * @returns
2833
+ */
2834
+ getGroupedByUser(saved_state_id) {
2835
+ return super.__action(SdPlatformRequestId_1.RequestId.SavedStateSharingGroupedByuser, ResourcesApi_1.Action.Get, `saved_state/${saved_state_id}/grouped_by_user`, {});
2836
+ }
2811
2837
  }
2812
2838
  exports.SdPlatformSavedStateSharingApi = SdPlatformSavedStateSharingApi;
2813
2839
 
@@ -1,5 +1,5 @@
1
1
  import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformRequestModelSharingCreate, SdPlatformResponseModelSharing } from "@shapediver/api.platform-api-dto-v1";
2
+ import { SdPlatformRequestModelSharingCreate, SdPlatformResponseModelSharing, SdPlatformResponseModelSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
3
3
  import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
4
  export declare enum SdPlatformModelharingQueryEmbeddableFields {
5
5
  User = "user",
@@ -50,5 +50,11 @@ export declare class SdPlatformModelSharingApi extends ResourcesApi {
50
50
  * @returns
51
51
  */
52
52
  delete(model_sharing_id: string): Promise<SdPlatformDeleteResponse>;
53
+ /**
54
+ * Gets the model sharings grouped by user.
55
+ * @param model_id
56
+ * @returns
57
+ */
58
+ getGroupedByUser(model_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharingGroupedByUser>>>;
53
59
  }
54
60
  //# sourceMappingURL=SdPlatformModelSharingApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformModelSharingApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelSharingApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAC,mCAAmC,EAAE,8BAA8B,EAAC,MAAM,qCAAqC,CAAA;AACvH,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAGjL,oBAAY,0CAA0C;IAElD,IAAI,SAAS;IACb,KAAK,UAAU;IACf,QAAQ,aAAa;CACxB;AAED,oBAAY,qCAAqC,GAAG,yBAAyB,CAAC,0CAA0C,CAAC,CAAC;AAE1H;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IAEvD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;IAKzH;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKjI;;;;;QAKI;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAK1J;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKxJ;;;;;OAKG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAKlI;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI7E"}
1
+ {"version":3,"file":"SdPlatformModelSharingApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelSharingApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAC,mCAAmC,EAAE,8BAA8B,EAAE,2CAA2C,EAAC,MAAM,qCAAqC,CAAA;AACpK,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAGjL,oBAAY,0CAA0C;IAElD,IAAI,SAAS;IACb,KAAK,UAAU;IACf,QAAQ,aAAa;CACxB;AAED,oBAAY,qCAAqC,GAAG,yBAAyB,CAAC,0CAA0C,CAAC,CAAC;AAE1H;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IAEvD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;IAKzH;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKjI;;;;;QAKI;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAK1J;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKxJ;;;;;OAKG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAKlI;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK1E;;;;OAIG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC,CAAC;CAKjI"}
@@ -24,5 +24,10 @@ export declare class SdPlatformNotificationApi extends ResourcesApi {
24
24
  patch(id: string, body: SdPlatformRequestNotificationPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseNotification>>;
25
25
  delete(id: string): Promise<SdPlatformDeleteResponse>;
26
26
  summary(embed: Array<SdPlatformNotificationSummaryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseNotificationSummary>>;
27
+ /**
28
+ * Marks all notifications of signed in user as read.
29
+ * @returns { Promise<SdPlatformPostResponse<void>> }
30
+ */
31
+ markAllAsRead(): Promise<SdPlatformPostResponse<void>>;
27
32
  }
28
33
  //# sourceMappingURL=SdPlatformNotificationApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformNotificationApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformNotificationApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EACH,qBAAqB,EACrB,mCAAmC,EACnC,kCAAkC,EAClC,8BAA8B,EAC9B,qCAAqC,EACxC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEnL,oBAAY,sCAAsC;IAE9C,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,UAAU,gBAAgB;IAC1B,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,6CAA6C;IAErD,KAAK,UAAU;IACf,MAAM,WAAW;CACpB;AAGD,oBAAY,qCAAqC,GAAG,yBAAyB,CAAC,sCAAsC,CAAC,CAAA;AAErH;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IAEvD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,KAAK,CAAC,IAAI,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKzH,MAAM,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;IAKlH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kCAAkC,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAK7H,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAKrD,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,6CAA6C,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,qCAAqC,CAAC,CAAC;CAIrJ"}
1
+ {"version":3,"file":"SdPlatformNotificationApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformNotificationApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACH,qBAAqB,EACrB,mCAAmC,EACnC,kCAAkC,EAClC,8BAA8B,EAC9B,qCAAqC,EACxC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEnL,oBAAY,sCAAsC;IAE9C,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,UAAU,gBAAgB;IAC1B,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,6CAA6C;IAErD,KAAK,UAAU;IACf,MAAM,WAAW;CACpB;AAGD,oBAAY,qCAAqC,GAAG,yBAAyB,CAAC,sCAAsC,CAAC,CAAA;AAErH;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IAEvD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,KAAK,CAAC,IAAI,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKzH,MAAM,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;IAKlH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kCAAkC,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAK7H,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAKrD,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,6CAA6C,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,qCAAqC,CAAC,CAAC;IAKlJ;;;OAGG;IACI,aAAa,IAAI,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;CAIhE"}
@@ -1,4 +1,4 @@
1
- import { SdPlatformResponseSavedStateSharing, SdPlatformResponseSavedStateSharingCreate } from "@shapediver/api.platform-api-dto-v1";
1
+ import { SdPlatformResponseSavedStateSharing, SdPlatformResponseSavedStateSharingCreate, SdPlatformResponseSavedStateSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
2
2
  import { ResourcesApi } from "./commons/ResourcesApi";
3
3
  import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
4
  export declare enum SdPlatformSavedStateSharingQueryEmbeddableFields {
@@ -51,5 +51,11 @@ export declare class SdPlatformSavedStateSharingApi extends ResourcesApi {
51
51
  * @returns
52
52
  */
53
53
  queryByUser(user_id: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
54
+ /**
55
+ * Gets the model sharings grouped by user.
56
+ * @param saved_state_id
57
+ * @returns
58
+ */
59
+ getGroupedByUser(saved_state_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharingGroupedByUser>>>;
54
60
  }
55
61
  //# sourceMappingURL=SdPlatformSavedStateSharingApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformSavedStateSharingApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformSavedStateSharingApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mCAAmC,EAAE,yCAAyC,EAAE,MAAM,qCAAqC,CAAC;AACrI,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAGjL,oBAAY,gDAAgD;IAExD,IAAI,SAAS;IACb,UAAU,gBAAgB;IAC1B,QAAQ,aAAa;CACxB;AAED,oBAAY,0CAA0C,GAAG,yBAAyB,CAAC,gDAAgD,CAAC,CAAC;AAErI;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,YAAY;IAE5D,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;QAII;IACG,MAAM,CAAC,IAAI,EAAE,yCAAyC,GAAG,OAAO,CAAC,sBAAsB,CAAC,mCAAmC,CAAC,CAAC;IAKpI;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAKhF;;;;;QAKI;IACG,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAC;IAKlJ;;;;OAIG;IACI,KAAK,CAAC,KAAK,CAAC,EAAE,0CAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,mCAAmC,CAAC,CAAC;IAKvI;;;;;OAKG;IACI,iBAAiB,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,0CAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,mCAAmC,CAAC,CAAC;IAK3K;;;;;OAKG;IACI,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,0CAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,mCAAmC,CAAC,CAAC;CAMjK"}
1
+ {"version":3,"file":"SdPlatformSavedStateSharingApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformSavedStateSharingApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mCAAmC,EAAE,yCAAyC,EAAE,gDAAgD,EAAE,MAAM,qCAAqC,CAAC;AACvL,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAGjL,oBAAY,gDAAgD;IAExD,IAAI,SAAS;IACb,UAAU,gBAAgB;IAC1B,QAAQ,aAAa;CACxB;AAED,oBAAY,0CAA0C,GAAG,yBAAyB,CAAC,gDAAgD,CAAC,CAAC;AAErI;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,YAAY;IAE5D,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;QAII;IACG,MAAM,CAAC,IAAI,EAAE,yCAAyC,GAAG,OAAO,CAAC,sBAAsB,CAAC,mCAAmC,CAAC,CAAC;IAKpI;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAKhF;;;;;QAKI;IACG,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAC;IAKlJ;;;;OAIG;IACI,KAAK,CAAC,KAAK,CAAC,EAAE,0CAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,mCAAmC,CAAC,CAAC;IAKvI;;;;;OAKG;IACI,iBAAiB,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,0CAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,mCAAmC,CAAC,CAAC;IAK3K;;;;;OAKG;IACI,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,0CAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,mCAAmC,CAAC,CAAC;IAM9J;;;;OAIG;IACK,gBAAgB,CAAC,cAAc,EAAE,MAAM,GAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC,CAAC;CAK7I"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shapediver/sdk.platform-api-sdk-v1",
3
- "version": "2.9.2",
3
+ "version": "2.9.12",
4
4
  "description": "SDK to communicate with the Platform API version 1",
5
5
  "keywords": [
6
6
  "shapediver",
@@ -39,7 +39,7 @@
39
39
  "build-prod": "bash ../../scripts/build-prod.sh"
40
40
  },
41
41
  "dependencies": {
42
- "@shapediver/api.platform-api-dto-v1": "^2.9.2",
42
+ "@shapediver/api.platform-api-dto-v1": "^2.9.12",
43
43
  "@types/q": "^1.5.5",
44
44
  "axios": "^0.26.1",
45
45
  "dotenv": "^16.0.0",
@@ -55,5 +55,6 @@
55
55
  "webpack": "^4.46.0",
56
56
  "webpack-cli": "4.9.2",
57
57
  "webpack-dev-server": "4.8.1"
58
- }
58
+ },
59
+ "gitHead": "6f7a876b2913e0d64ad511f946418f6b94cb42cc"
59
60
  }