@shapediver/sdk.platform-api-sdk-v1 2.14.1 → 2.14.4

package/dist/resources/SdPlatformModelSharingApi.d.ts

@@ -1,66 +1,66 @@
-import { ResourcesApi } from "./commons/ResourcesApi";
-import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformPostResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestModelSharingCreate, SdPlatformRequestModelSharingCreateMultiple, SdPlatformResponseModelSharing, SdPlatformResponseModelSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
-export declare enum SdPlatformModelharingQueryEmbeddableFields {
-    User = "user",
-    Model = "model",
-    Provider = "provider"
-}
-export declare type SdPlatformModelSharingQueryParameters = SdPlatformQueryParameters<SdPlatformModelharingQueryEmbeddableFields>;
-/**
- * Operations for model sharing relationships.
- */
-export declare class SdPlatformModelSharingApi extends ResourcesApi {
-    protected get __resourcePath(): string;
-    /**
-     * Create a model sharing relationship.
-     * @param body {@link SdPlatformRequestModelSharingCreate} body of a request with parameter to create sharing.
-     * @returns the {@link SdPlatformPostResponse} response with {@link SdPlatformResponseModelSharing} as parameter.
-     */
-    create(body: SdPlatformRequestModelSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseModelSharing>>;
-    /**
-     * Create multiple sharings.
-     * @param body {@link SdPlatformRequestModelSharingCreateMultiple}
-     * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseModelSharing} as result.
-     */
-    createMultiple(body: SdPlatformRequestModelSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>>;
-    /**
-     * Query model sharing relationships.
-     * @param query {@link SdPlatformModelSharingQueryParameters}
-     * @returns the {@link SdPlatformQueryResponse} response with {@see SdPlatformResponseModelSharing} as data result.
-     */
-    query(query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
-    /**
-      * Query model sharing relationships by model id.
-      * @param model_id
-      * @param query {@link SdPlatformModelSharingQueryParameters}
-      * @returns the {@link SdPlatformQueryResponse} response with {@see SdPlatformResponseModelSharing} as data result.
-      */
-    queryByModel(model_id: string, query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
-    /**
-     * Query model sharing relationships by user id.
-     * @param user_id
-     * @param query  {@link SdPlatformModelSharingQueryParameters}
-     * @returns the {@link SdPlatformQueryResponse} response with {@see SdPlatformResponseModelSharing} as data result.
-     */
-    queryByUser(user_id: string, query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
-    /**
-     * Get model sharing relationships by model id and user id.
-     * @param model_id
-     * @param user_id
-     * @returns the {@link SdPlatformGetResponse} response with {@see SdPlatformResponseModelSharing} as data result.
-     */
-    getByModelAndUser(model_id: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharing>>>;
-    /**
-     * Delete a model sharing relationship.
-     * @param model_sharing_id Id of the model sharing relationship to delete.
-     * @returns
-     */
-    delete(model_sharing_id: string): Promise<SdPlatformDeleteResponse>;
-    /**
-     * Gets the model sharings grouped by user.
-     * @param model_id
-     * @returns
-     */
-    getGroupedByUser(model_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharingGroupedByUser>>>;
-}
+import { ResourcesApi } from "./commons/ResourcesApi";
+import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformPostResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestModelSharingCreate, SdPlatformRequestModelSharingCreateMultiple, SdPlatformResponseModelSharing, SdPlatformResponseModelSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
+export declare enum SdPlatformModelharingQueryEmbeddableFields {
+    User = "user",
+    Model = "model",
+    Provider = "provider"
+}
+export type SdPlatformModelSharingQueryParameters = SdPlatformQueryParameters<SdPlatformModelharingQueryEmbeddableFields>;
+/**
+ * Operations for model sharing relationships.
+ */
+export declare class SdPlatformModelSharingApi extends ResourcesApi {
+    protected get __resourcePath(): string;
+    /**
+     * Create a model sharing relationship.
+     * @param body {@link SdPlatformRequestModelSharingCreate} body of a request with parameter to create sharing.
+     * @returns the {@link SdPlatformPostResponse} response with {@link SdPlatformResponseModelSharing} as parameter.
+     */
+    create(body: SdPlatformRequestModelSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseModelSharing>>;
+    /**
+     * Create multiple sharings.
+     * @param body {@link SdPlatformRequestModelSharingCreateMultiple}
+     * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseModelSharing} as result.
+     */
+    createMultiple(body: SdPlatformRequestModelSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>>;
+    /**
+     * Query model sharing relationships.
+     * @param query {@link SdPlatformModelSharingQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} response with {@see SdPlatformResponseModelSharing} as data result.
+     */
+    query(query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
+    /**
+      * Query model sharing relationships by model id.
+      * @param model_id
+      * @param query {@link SdPlatformModelSharingQueryParameters}
+      * @returns the {@link SdPlatformQueryResponse} response with {@see SdPlatformResponseModelSharing} as data result.
+      */
+    queryByModel(model_id: string, query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
+    /**
+     * Query model sharing relationships by user id.
+     * @param user_id
+     * @param query  {@link SdPlatformModelSharingQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} response with {@see SdPlatformResponseModelSharing} as data result.
+     */
+    queryByUser(user_id: string, query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
+    /**
+     * Get model sharing relationships by model id and user id.
+     * @param model_id
+     * @param user_id
+     * @returns the {@link SdPlatformGetResponse} response with {@see SdPlatformResponseModelSharing} as data result.
+     */
+    getByModelAndUser(model_id: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharing>>>;
+    /**
+     * Delete a model sharing relationship.
+     * @param model_sharing_id Id of the model sharing relationship to delete.
+     * @returns
+     */
+    delete(model_sharing_id: string): Promise<SdPlatformDeleteResponse>;
+    /**
+     * Gets the model sharings grouped by user.
+     * @param model_id
+     * @returns
+     */
+    getGroupedByUser(model_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharingGroupedByUser>>>;
+}
 //# sourceMappingURL=SdPlatformModelSharingApi.d.ts.map

package/dist/resources/SdPlatformModelSharingApi.d.ts.map

@@ -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,EACH,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EACzB,uBAAuB,EACvB,mCAAmC,EACnC,2CAA2C,EAC3C,8BAA8B,EAC9B,2CAA2C,EAC9C,MAAM,qCAAqC,CAAA;AAG5C,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,cAAc,CAAC,IAAI,EAAE,2CAA2C,GAAK,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAMlJ;;;;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;;;;;OAKG;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"}
+{"version":3,"file":"SdPlatformModelSharingApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelSharingApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EACH,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EACzB,uBAAuB,EACvB,mCAAmC,EACnC,2CAA2C,EAC3C,8BAA8B,EAC9B,2CAA2C,EAC9C,MAAM,qCAAqC,CAAA;AAG5C,oBAAY,0CAA0C;IAElD,IAAI,SAAS;IACb,KAAK,UAAU;IACf,QAAQ,aAAa;CACxB;AAED,MAAM,MAAM,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,cAAc,CAAC,IAAI,EAAE,2CAA2C,GAAK,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAMlJ;;;;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;;;;;OAKG;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"}

package/dist/resources/SdPlatformModelTokenApi.d.ts

@@ -1,16 +1,16 @@
-import { ResourcesApi } from "./commons/ResourcesApi";
-import { SdPlatformResponseModelToken, SdPlatformRequestModelTokenCreate } from "@shapediver/api.platform-api-dto-v1";
-import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
-/**
- * Operations for creating tokens for models on Geometry Backend Systems
- */
-export declare class SdPlatformModelTokenApi extends ResourcesApi {
-    protected get __resourcePath(): string;
-    /**
-     * Get a token for interacting with a model on its geometry backend system.
-     * @param body {@link SdPlatformRequestModelTokenCreate} body of a request.
-     * @returns token for accessing one or several models on a ShapeDiver Geometry Backend system
-     */
-    create(body: SdPlatformRequestModelTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseModelToken>>;
-}
+import { ResourcesApi } from "./commons/ResourcesApi";
+import { SdPlatformResponseModelToken, SdPlatformRequestModelTokenCreate } from "@shapediver/api.platform-api-dto-v1";
+import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
+/**
+ * Operations for creating tokens for models on Geometry Backend Systems
+ */
+export declare class SdPlatformModelTokenApi extends ResourcesApi {
+    protected get __resourcePath(): string;
+    /**
+     * Get a token for interacting with a model on its geometry backend system.
+     * @param body {@link SdPlatformRequestModelTokenCreate} body of a request.
+     * @returns token for accessing one or several models on a ShapeDiver Geometry Backend system
+     */
+    create(body: SdPlatformRequestModelTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseModelToken>>;
+}
 //# sourceMappingURL=SdPlatformModelTokenApi.d.ts.map

package/dist/resources/SdPlatformModelTransferApi.d.ts

@@ -1,48 +1,48 @@
-import { ResourcesApi } from "./commons/ResourcesApi";
-import { SdPlatformRequestModelTransferCreate, SdPlatformResponseNotification } from "@shapediver/api.platform-api-dto-v1";
-import { SdPlatformGetResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
-/**
- * Operations for creating, revoking, accepting, denying, model ownership transfer notifications.
- */
-export declare class SdPlatformModelTransferApi extends ResourcesApi {
-    protected get __resourcePath(): string;
-    /**
-     * Get all model transfer requests for models currently owned by the authenticated user.
-     * @returns
-     */
-    getModelTransferRequests(): Promise<SdPlatformGetResponse<Array<SdPlatformResponseNotification>>>;
-    /**
-     * Creates a model transfer request. The calling user must have permission "update_owner" for the model.
-     * In case the receiving user immediately accepts the transfer request, no notification will be returned.
-     * @param model_id
-     * @param body {@link SdPlatformRequestModelTransferCreate}
-     * @returns
-     */
-    createModelTransferRequest(model_id: string, body: SdPlatformRequestModelTransferCreate): Promise<SdPlatformPostResponse<SdPlatformResponseNotification | undefined>>;
-    /**
-     * Deletes a model transfer request by model id. The calling user must have permission "update_owner" for the model.
-     * @param model_id
-     * @returns
-     */
-    deleteModelTransferRequest(model_id: string): Promise<SdPlatformDeleteResponse>;
-    /**
-     * Get a model transfer request by model id. The calling user must have permission "update_owner" for the model.
-     * The receiving user can see the model transfer request when querying notifications in general.
-     * @param model_id
-     * @returns
-     */
-    getModelTransferRequest(model_id: string): Promise<SdPlatformGetResponse<SdPlatformResponseNotification>>;
-    /**
-     * Accept a model transfer request. This must be called by the receiving user.
-     * @param model_id
-     * @returns
-     */
-    acceptModelTransferRequest(model_id: string): Promise<SdPlatformPostResponse<void>>;
-    /**
-     * Deny the model transfer request. This must be called by the receiving user.
-     * @param model_id
-     * @returns
-     */
-    denyModelTransferRequest(model_id: string): Promise<SdPlatformPostResponse<void>>;
-}
+import { ResourcesApi } from "./commons/ResourcesApi";
+import { SdPlatformRequestModelTransferCreate, SdPlatformResponseNotification } from "@shapediver/api.platform-api-dto-v1";
+import { SdPlatformGetResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
+/**
+ * Operations for creating, revoking, accepting, denying, model ownership transfer notifications.
+ */
+export declare class SdPlatformModelTransferApi extends ResourcesApi {
+    protected get __resourcePath(): string;
+    /**
+     * Get all model transfer requests for models currently owned by the authenticated user.
+     * @returns
+     */
+    getModelTransferRequests(): Promise<SdPlatformGetResponse<Array<SdPlatformResponseNotification>>>;
+    /**
+     * Creates a model transfer request. The calling user must have permission "update_owner" for the model.
+     * In case the receiving user immediately accepts the transfer request, no notification will be returned.
+     * @param model_id
+     * @param body {@link SdPlatformRequestModelTransferCreate}
+     * @returns
+     */
+    createModelTransferRequest(model_id: string, body: SdPlatformRequestModelTransferCreate): Promise<SdPlatformPostResponse<SdPlatformResponseNotification | undefined>>;
+    /**
+     * Deletes a model transfer request by model id. The calling user must have permission "update_owner" for the model.
+     * @param model_id
+     * @returns
+     */
+    deleteModelTransferRequest(model_id: string): Promise<SdPlatformDeleteResponse>;
+    /**
+     * Get a model transfer request by model id. The calling user must have permission "update_owner" for the model.
+     * The receiving user can see the model transfer request when querying notifications in general.
+     * @param model_id
+     * @returns
+     */
+    getModelTransferRequest(model_id: string): Promise<SdPlatformGetResponse<SdPlatformResponseNotification>>;
+    /**
+     * Accept a model transfer request. This must be called by the receiving user.
+     * @param model_id
+     * @returns
+     */
+    acceptModelTransferRequest(model_id: string): Promise<SdPlatformPostResponse<void>>;
+    /**
+     * Deny the model transfer request. This must be called by the receiving user.
+     * @param model_id
+     * @returns
+     */
+    denyModelTransferRequest(model_id: string): Promise<SdPlatformPostResponse<void>>;
+}
 //# sourceMappingURL=SdPlatformModelTransferApi.d.ts.map

package/dist/resources/SdPlatformNotificationApi.d.ts

@@ -1,66 +1,66 @@
-import { ResourcesApi } from "./commons/ResourcesApi";
-import { SdPlatformGetResponse, SdPlatformRequestNotificationCreate, SdPlatformRequestNotificationPatch, SdPlatformResponseNotification, SdPlatformResponseNotificationSummary } from "@shapediver/api.platform-api-dto-v1";
-import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
-export declare enum SdPlatformNotificationEmbeddableFields {
-    Receiver = "receiver",
-    User = "user",
-    Model = "model",
-    SavedState = "saved_state",
-    Document = "document",
-    Organization = "organization"
-}
-export declare enum SdPlatformNotificationSummaryEmbeddableFields {
-    Total = "total",
-    Unread = "unread"
-}
-export declare type SdPlatformNotificationQueryParameters = SdPlatformQueryParameters<SdPlatformNotificationEmbeddableFields>;
-/**
- * Operations for querying, reading/unreading, creating notifications.
- */
-export declare class SdPlatformNotificationApi extends ResourcesApi {
-    protected get __resourcePath(): string;
-    /**
-     * Query the notifications.
-     * @param body {@link SdPlatformNotificationQueryParameters} notifications query body.
-     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseNotification} as data result.
-     */
-    query(body?: SdPlatformNotificationQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseNotification>>;
-    /**
-     * Creates the notification.
-     * @param body {@link SdPlatformRequestNotificationCreate}
-     * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseNotification} as result.
-     */
-    create(body: SdPlatformRequestNotificationCreate): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
-    /**
-     * Updates the notification-
-     * @param id - the id of a notification.
-     * @param body {@link SdPlatformRequestNotificationPatch} body of a notification.
-     * @returns the {@link SdPlatformPatchResponse} response with {@link SdPlatformResponseNotification} as result.
-     */
-    patch(id: string, body: SdPlatformRequestNotificationPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseNotification>>;
-    /**
-     * Deletes the notification.
-     * @param id - the id of a notification.
-     * @returns  the {@link SdPlatformDeleteResponse}
-     */
-    delete(id: string): Promise<SdPlatformDeleteResponse>;
-    /**
-     * Gets the summary of notifications.
-     * Gives information about total number of notifications and unread number of notifications.
-     * @param embed - array of {@link SdPlatformNotificationSummaryEmbeddableFields} embed properties.
-     * @returns the {@link SdPlatformGetResponse} response with {@link SdPlatformResponseNotificationSummary} as data.
-     */
-    summary(embed: Array<SdPlatformNotificationSummaryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseNotificationSummary>>;
-    /**
-     * Gets the notification by id.
-     * @param  id - the id of notification.
-     * @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponseNotification} as data or one of it's derived classes.
-     */
-    get<T = SdPlatformResponseNotification>(id: string): Promise<SdPlatformGetResponse<T>>;
-    /**
-     * Marks all notifications of signed in user as read.
-     * @returns the {@link SdPlatformPostResponse} response.
-     */
-    markAllAsRead(): Promise<SdPlatformPostResponse<void>>;
-}
+import { ResourcesApi } from "./commons/ResourcesApi";
+import { SdPlatformGetResponse, SdPlatformRequestNotificationCreate, SdPlatformRequestNotificationPatch, SdPlatformResponseNotification, SdPlatformResponseNotificationSummary } from "@shapediver/api.platform-api-dto-v1";
+import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
+export declare enum SdPlatformNotificationEmbeddableFields {
+    Receiver = "receiver",
+    User = "user",
+    Model = "model",
+    SavedState = "saved_state",
+    Document = "document",
+    Organization = "organization"
+}
+export declare enum SdPlatformNotificationSummaryEmbeddableFields {
+    Total = "total",
+    Unread = "unread"
+}
+export type SdPlatformNotificationQueryParameters = SdPlatformQueryParameters<SdPlatformNotificationEmbeddableFields>;
+/**
+ * Operations for querying, reading/unreading, creating notifications.
+ */
+export declare class SdPlatformNotificationApi extends ResourcesApi {
+    protected get __resourcePath(): string;
+    /**
+     * Query the notifications.
+     * @param body {@link SdPlatformNotificationQueryParameters} notifications query body.
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseNotification} as data result.
+     */
+    query(body?: SdPlatformNotificationQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseNotification>>;
+    /**
+     * Creates the notification.
+     * @param body {@link SdPlatformRequestNotificationCreate}
+     * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseNotification} as result.
+     */
+    create(body: SdPlatformRequestNotificationCreate): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
+    /**
+     * Updates the notification-
+     * @param id - the id of a notification.
+     * @param body {@link SdPlatformRequestNotificationPatch} body of a notification.
+     * @returns the {@link SdPlatformPatchResponse} response with {@link SdPlatformResponseNotification} as result.
+     */
+    patch(id: string, body: SdPlatformRequestNotificationPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseNotification>>;
+    /**
+     * Deletes the notification.
+     * @param id - the id of a notification.
+     * @returns  the {@link SdPlatformDeleteResponse}
+     */
+    delete(id: string): Promise<SdPlatformDeleteResponse>;
+    /**
+     * Gets the summary of notifications.
+     * Gives information about total number of notifications and unread number of notifications.
+     * @param embed - array of {@link SdPlatformNotificationSummaryEmbeddableFields} embed properties.
+     * @returns the {@link SdPlatformGetResponse} response with {@link SdPlatformResponseNotificationSummary} as data.
+     */
+    summary(embed: Array<SdPlatformNotificationSummaryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseNotificationSummary>>;
+    /**
+     * Gets the notification by id.
+     * @param  id - the id of notification.
+     * @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponseNotification} as data or one of it's derived classes.
+     */
+    get<T = SdPlatformResponseNotification>(id: string): Promise<SdPlatformGetResponse<T>>;
+    /**
+     * Marks all notifications of signed in user as read.
+     * @returns the {@link SdPlatformPostResponse} response.
+     */
+    markAllAsRead(): Promise<SdPlatformPostResponse<void>>;
+}
 //# sourceMappingURL=SdPlatformNotificationApi.d.ts.map

package/dist/resources/SdPlatformNotificationApi.d.ts.map

@@ -1 +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;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;IAKzH;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kCAAkC,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKpI;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;;OAKG;IACI,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,6CAA6C,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,qCAAqC,CAAC,CAAC;IAKlJ;;;;OAIG;IACI,GAAG,CAAC,CAAC,GAAG,8BAA8B,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAK7F;;;OAGG;IACI,aAAa,IAAI,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;CAIhE"}
+{"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,MAAM,MAAM,qCAAqC,GAAG,yBAAyB,CAAC,sCAAsC,CAAC,CAAA;AAErH;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IAEvD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;IAKzH;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kCAAkC,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKpI;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;;OAKG;IACI,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,6CAA6C,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,qCAAqC,CAAC,CAAC;IAKlJ;;;;OAIG;IACI,GAAG,CAAC,CAAC,GAAG,8BAA8B,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAK7F;;;OAGG;IACI,aAAa,IAAI,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;CAIhE"}

package/dist/resources/SdPlatformOpenIDProviderApi.d.ts

@@ -1,42 +1,42 @@
-import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestOpenIDProviderCreate, SdPlatformRequestOpenIDProviderPatch, SdPlatformResponseOpenIDProvider } from "@shapediver/api.platform-api-dto-v1";
-import { ResourcesApi } from "./commons/ResourcesApi";
-export declare enum SdPlatformOpenIDProviderEmbeddableFields {
-    Organization = "organization"
-}
-export declare type SdPlatformOpenIDProviderQueryParameters = SdPlatformQueryParameters<SdPlatformOpenIDProviderEmbeddableFields>;
-/**
- * Operations for OpenID providers.
- */
-export declare class SdPlatformOpenIDProviderApi extends ResourcesApi {
-    protected get __resourcePath(): string;
-    /**
-    * Get OpenID Provider by id.
-    * @param id - openid provider id.
-    * @param embed - embeddable resources.
-    */
-    get<T = SdPlatformResponseOpenIDProvider>(id: string, embed?: Array<SdPlatformOpenIDProviderEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
-    /**
-     * Query OpenID providers.
-     * @param body
-     */
-    query<T = SdPlatformResponseOpenIDProvider>(body?: SdPlatformOpenIDProviderQueryParameters): Promise<SdPlatformQueryResponse<T>>;
-    /**
-     * Create an OpenID provider.
-     * @param body
-     * @returns
-     */
-    create(body: SdPlatformRequestOpenIDProviderCreate): Promise<SdPlatformPostResponse<SdPlatformResponseOpenIDProvider>>;
-    /**
-     * Patch an OpenID provider.
-     * @param id - id of the OpenID provider
-     * @param body - properties to patch
-     */
-    patch<T = SdPlatformResponseOpenIDProvider>(id: string, body: SdPlatformRequestOpenIDProviderPatch): Promise<SdPlatformPatchResponse<T>>;
-    /**
-     * Delete an OpenID provider..
-     * @param id
-     * @returns
-     */
-    delete(id: string): Promise<SdPlatformDeleteResponse>;
-}
+import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestOpenIDProviderCreate, SdPlatformRequestOpenIDProviderPatch, SdPlatformResponseOpenIDProvider } from "@shapediver/api.platform-api-dto-v1";
+import { ResourcesApi } from "./commons/ResourcesApi";
+export declare enum SdPlatformOpenIDProviderEmbeddableFields {
+    Organization = "organization"
+}
+export type SdPlatformOpenIDProviderQueryParameters = SdPlatformQueryParameters<SdPlatformOpenIDProviderEmbeddableFields>;
+/**
+ * Operations for OpenID providers.
+ */
+export declare class SdPlatformOpenIDProviderApi extends ResourcesApi {
+    protected get __resourcePath(): string;
+    /**
+    * Get OpenID Provider by id.
+    * @param id - openid provider id.
+    * @param embed - embeddable resources.
+    */
+    get<T = SdPlatformResponseOpenIDProvider>(id: string, embed?: Array<SdPlatformOpenIDProviderEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
+    /**
+     * Query OpenID providers.
+     * @param body
+     */
+    query<T = SdPlatformResponseOpenIDProvider>(body?: SdPlatformOpenIDProviderQueryParameters): Promise<SdPlatformQueryResponse<T>>;
+    /**
+     * Create an OpenID provider.
+     * @param body
+     * @returns
+     */
+    create(body: SdPlatformRequestOpenIDProviderCreate): Promise<SdPlatformPostResponse<SdPlatformResponseOpenIDProvider>>;
+    /**
+     * Patch an OpenID provider.
+     * @param id - id of the OpenID provider
+     * @param body - properties to patch
+     */
+    patch<T = SdPlatformResponseOpenIDProvider>(id: string, body: SdPlatformRequestOpenIDProviderPatch): Promise<SdPlatformPatchResponse<T>>;
+    /**
+     * Delete an OpenID provider..
+     * @param id
+     * @returns
+     */
+    delete(id: string): Promise<SdPlatformDeleteResponse>;
+}
 //# sourceMappingURL=SdPlatformOpenIDProviderApi.d.ts.map

package/dist/resources/SdPlatformOpenIDProviderApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformOpenIDProviderApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformOpenIDProviderApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,qCAAqC,EAAE,oCAAoC,EAAE,gCAAgC,EAAE,MAAM,qCAAqC,CAAC;AAE1T,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,oBAAY,wCAAwC;IAEhD,YAAY,iBAAiB;CAChC;AAED,oBAAY,uCAAuC,GAAG,yBAAyB,CAAC,wCAAwC,CAAC,CAAA;AAGzH;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAEzD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;MAIE;IACK,GAAG,CAAC,CAAC,GAAG,gCAAgC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,wCAAwC,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAMxJ;;;OAGG;IACI,KAAK,CAAC,CAAC,GAAG,gCAAgC,EAAE,IAAI,GAAE,uCAA4C,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK3I;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,qCAAqC,GAAG,OAAO,CAAC,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;IAK7H;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,gCAAgC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oCAAoC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK/I;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAK/D"}
+{"version":3,"file":"SdPlatformOpenIDProviderApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformOpenIDProviderApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,qCAAqC,EAAE,oCAAoC,EAAE,gCAAgC,EAAE,MAAM,qCAAqC,CAAC;AAE1T,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,oBAAY,wCAAwC;IAEhD,YAAY,iBAAiB;CAChC;AAED,MAAM,MAAM,uCAAuC,GAAG,yBAAyB,CAAC,wCAAwC,CAAC,CAAA;AAGzH;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAEzD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;MAIE;IACK,GAAG,CAAC,CAAC,GAAG,gCAAgC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,wCAAwC,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAMxJ;;;OAGG;IACI,KAAK,CAAC,CAAC,GAAG,gCAAgC,EAAE,IAAI,GAAE,uCAA4C,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK3I;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,qCAAqC,GAAG,OAAO,CAAC,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;IAK7H;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,gCAAgC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oCAAoC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK/I;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAK/D"}

package/dist/resources/SdPlatformOrganizationAnalyticsApi.d.ts

@@ -1,16 +1,16 @@
-import { SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp } from "@shapediver/api.platform-api-dto-v1";
-import { ResourcesApi } from "./commons/ResourcesApi";
-import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
-/**
- * Analytics for organizations.
- */
-export declare class SdPlatformOrganizationAnalyticsApi extends ResourcesApi {
-    protected get __resourcePath(): string;
-    /**
-     * Query session analytics aggregated per user.
-     * @param body - {@link SdPlatformQueryParameters} query body.
-     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp} as query data response.
-     */
-    query(body?: SdPlatformQueryParameters<unknown>): Promise<SdPlatformQueryResponse<SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp>>;
-}
+import { SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp } from "@shapediver/api.platform-api-dto-v1";
+import { ResourcesApi } from "./commons/ResourcesApi";
+import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
+/**
+ * Analytics for organizations.
+ */
+export declare class SdPlatformOrganizationAnalyticsApi extends ResourcesApi {
+    protected get __resourcePath(): string;
+    /**
+     * Query session analytics aggregated per user.
+     * @param body - {@link SdPlatformQueryParameters} query body.
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp} as query data response.
+     */
+    query(body?: SdPlatformQueryParameters<unknown>): Promise<SdPlatformQueryResponse<SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp>>;
+}
 //# sourceMappingURL=SdPlatformOrganizationAnalyticsApi.d.ts.map