@shapediver/sdk.platform-api-sdk-v1 2.12.8 → 2.12.9

package/dist/bundle.node.js

@@ -1510,6 +1510,12 @@ class SdPlatformAuthServiceApi {
         this.__api = __context.api;
         this.__config = __context.config;
     }
+    __resolveConfigAuth() {
+        return {
+            access_token: this.__context.accessTokenDetails.access_token,
+            client_id: this.__context.config.clientId
+        };
+    }
     __resolveConfig() {
         return {};
     }
@@ -1675,7 +1681,7 @@ class SdPlatformAuthServiceApi {
      * @returns
      */
     requestAuthorizationCode(params) {
-        return this.__api.get(SdPlatformRequestId_1.RequestId.RequestAuthorizationCode, "oauth/authorize", this.__resolveConfig(), params);
+        return this.__api.post(SdPlatformRequestId_1.RequestId.RequestAuthorizationCode, "oauth/authorize", params, Object.assign(Object.assign({}, this.__resolveConfig()), this.__resolveConfigAuth()));
     }
     __decodeToken(token) {
         return (0, jwt_decode_1.default)(token);
@@ -1873,41 +1879,40 @@ class SdPlatformApiTokenApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Get the token.
-     * @param { string } key_id
-     * @returns { Promise<SdPlatformGetResponse<SdPlatformResponseApiToken>> }
+     * @param key_id
+     * @returns api token response.
      */
     get(key_id) {
         return super.__get(SdPlatformRequestId_1.RequestId.ApiTokenGet, key_id);
     }
     /**
      * Query the API tokens.
-     * @param { SdPlatformApiTokenQueryParameters } query
-     * @returns { Promise<SdPlatformQueryResponse<SdPlatformResponseApiToken>> }
+     * @param query - {@link SdPlatformApiTokenQueryParameters} optional query parameters.
+     * @returns query response with @see {@link SdPlatformResponseApiToken} as result.
      */
     query(query = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.ApiTokenQuery, query);
     }
     /**
      * Create a token.
-     * @param { SdPlatformRequestApiTokenCreate } body
-     * @returns {  Promise<SdPlatformPostResponse<SdPlatformResponseApiTokenWithSecret>> }
+     * @param body - {@link SdPlatformRequestApiTokenCreate} body or create token parameters.
+     * @returns @see {@link SdPlatformResponseApiTokenWithSecret} as result.
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.ApiTokenCreate, body);
     }
     /**
      * Update and API token.
-     * @param { string } key_id
-     * @param { SdPlatformRequestApiTokenPatch } body
-     * @returns { Promise<SdPlatformPatchResponse<SdPlatformResponseApiToken>> }
+     * @param key_id
+     * @param @see {@link SdPlatformRequestApiTokenPatch} patch body with parameters.
+     * @returns patch response with @see {@link SdPlatformResponseApiToken}
      */
     patch(key_id, body) {
         return super.__patch(SdPlatformRequestId_1.RequestId.ApiTokenPatch, key_id, body);
     }
     /**
      * Delete an API token.
-     * @param { string } key_id
-     * @returns { Promise<SdPlatformDeleteResponse> }
+     * @param  key_id
      */
     delete(key_id) {
         return super.__delete(SdPlatformRequestId_1.RequestId.ApiTokenDelete, key_id);
@@ -2147,33 +2152,33 @@ class SdPlatformBackendSystemApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Query the backend systems.
-     * @param { SdPlatformBackendSystemQueryParameters } query
-     * @returns { Promise<SdPlatformQueryResponse<SdPlatformResponseBackendSystem|SdPlatformResponseBackendSystemAdmin>> }
+     * @param query - {@link SdPlatformBackendSystemQueryParameters} query parameters.
+     * @returns - {@link SdPlatformQueryResponse} response with {@link SdPlatformResponseBackendSystem} or {@link SdPlatformResponseBackendSystemAdmin} as result.
      */
     query(query = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.BackendSystemQuery, query);
     }
     /**
      * Create the backend system.
-     * @param { SdPlatformRequestBackendSystemCreate } body
-     * @returns { Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemAdmin>> }
+     * @param body - {@link SdPlatformRequestBackendSystemCreate} body parameters.
+     * @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseBackendSystemAdmin} as result.
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.BackendSystemCreate, body);
     }
     /**
      * Updates the backend system.
-     * @param { string } id - the backend system id.
-     * @param { SdPlatformRequestBackendSystemPatch } body - the update parameters.
-     * @returns { Promise<SdPlatformPatchResponse<SdPlatformResponseBackendSystem|SdPlatformResponseBackendSystemAdmin>> }
+     * @param id - the backend system id.
+     * @param body - {@link SdPlatformRequestBackendSystemPatch} update parameters.
+     * @returns - {@link SdPlatformPatchResponse} with {@link SdPlatformResponseBackendSystem} or {@link SdPlatformResponseBackendSystemAdmin} as result.
      */
     patch(id, body) {
         return super.__patch(SdPlatformRequestId_1.RequestId.BackendSystemPatch, id, body);
     }
     /**
      * Get a token for interacting with a geometry backend system.
-     * @param { SdPlatformRequestBackendSystemToken } body
-     * @returns { Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemToken>> }
+     * @param body - {@link SdPlatformRequestBackendSystemToken} body
+     * @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseBackendSystemToken} as result.
      */
     token(body) {
         return super.__action(SdPlatformRequestId_1.RequestId.BackendSystemToken, ResourcesApi_1.Action.Post, "token", body);
@@ -2196,21 +2201,24 @@ const ResourcesApi_1 = __webpack_require__(61);
  * Operations for creating and deleting bookmarks
  */
 class SdPlatformBookmarkApi extends ResourcesApi_1.ResourcesApi {
+    /**
+     * The resource path.
+     */
     get __resourcePath() {
         return "bookmarks";
     }
     /**
      * Create a bookmark for the model for the user identified by @see SdPlatformAuthServiceApi
-     * @param { SdPlatformRequestBookmarkCreate } body
-     * @returns { Promise<SdPlatformPostResponse<void>> }
+     * @param body - {@link SdPlatformRequestBookmarkCreate} creae parameters.
+     * @returns - {@link SdPlatformPostResponse} with 'success' property being true,
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.BookmarkCreate, body);
     }
     /**
      * Delete a bookmark for the model for the user identified by  @see SdPlatformAuthServiceApi
-     * @param id Id of the model whose bookmark shall be deleted
-     * @returns { Promise<SdPlatformDeleteResponse> }
+     * @param id - id of the model whose bookmark shall be deleted
+     * @returns - {@link SdPlatformDeleteResponse}
      */
     delete(id) {
         return super.__delete(SdPlatformRequestId_1.RequestId.BookmarkDelete, id);
@@ -2236,15 +2244,38 @@ class SdPlatformChargebeeApi extends ResourcesApi_1.ResourcesApi {
     get __resourcePath() {
         return "chargebee";
     }
+    /**
+     * Get data required to integrate a chargebee with website.
+     * @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2} for more.
+     * @param body - the parameters of a request.
+     * @returns
+     */
     hostedPage(body) {
         return super.__action(SdPlatformRequestId_1.RequestId.ChargebeeHostedPage, ResourcesApi_1.Action.Post, "hosted_page", body);
     }
+    /**
+     * Get data required to integrade hosted page payment method with website.
+     * @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2#update_payment_method}
+     * @param body - the parameters of a request.
+     * @returns
+     */
     hostedPageUpdatePaymentMethod(body) {
         return super.__action(SdPlatformRequestId_1.RequestId.ChargebeeHostedPageUpdatePaymentMethod, ResourcesApi_1.Action.Post, "hosted_page_update_payment_method", body);
     }
+    /**
+     * Gets all the required data for opening a chargebee portal session.
+     * @see - {@link https://apidocs.chargebee.com/docs/api/portal_sessions?prod_cat_ver=2} for more.
+     * @param body - {@link @SdPlatformRequestChargebeePortalSession} body
+     * @returns - post response with {@link SdPlatformResponseChargebeePortalSession} data
+     */
     portalSession(body) {
         return super.__action(SdPlatformRequestId_1.RequestId.ChargebeePortalSession, ResourcesApi_1.Action.Post, "portal_session", body);
     }
+    /**
+     * Queries the chargebee plans.
+     * @param body - {@link SdPlatformChargebeePlanQueryParameters } body
+     * @returns - post response with {@link SdPlatformResponseChargebeePlan} data
+     */
     queryChargebeePlans(body) {
         return super.__action(SdPlatformRequestId_1.RequestId.ChargebeeQueryPlan, ResourcesApi_1.Action.Post, "plans/query", body);
     }
@@ -2287,8 +2318,8 @@ class SdPlatformDomainApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Get a domain by id.
      * @param id
-     * @param embed
-     * @returns
+     * @param embed - array of {@link SdPlatformDomainGetEmbeddableFields}
+     * @returns - {@link SdPlatformGetResponse} with {@link SdPlatformResponseDomain} as result.
      */
     get(id, embed = []) {
         return super.__get(SdPlatformRequestId_1.RequestId.DomainGet, id, embed);
@@ -2302,7 +2333,9 @@ class SdPlatformDomainApi extends ResourcesApi_1.ResourcesApi {
         return super.__query(SdPlatformRequestId_1.RequestId.DomainQuery, query);
     }
     /**
-     * Create a domain.
+     * Create a new domain.
+     * @param body - {@link SdPlatformRequestDomainCreate} as request body.
+     * @returns - new domain.
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.DomainCreate, body);
@@ -2310,7 +2343,7 @@ class SdPlatformDomainApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Patch a domain.
      * @param id - the id of a domain
-     * @param body - properties to patch
+     * @param body - {@link SdPlatformRequestDomainPatch} as properties to patch.
      */
     patch(id, body) {
         return super.__patch(SdPlatformRequestId_1.RequestId.DomainPatch, id, body);
@@ -2345,7 +2378,8 @@ class SdPlatformHttpLogApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Query HTTP logs.
-     * @param body
+     * @param body - the body of a request.
+     * @returns - http logs.
      */
     query(body = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.HttpLogQuery, body);
@@ -2364,6 +2398,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SdPlatformImageApi = exports.SdPlatformImageQueryEmbeddableFields = void 0;
 const SdPlatformRequestId_1 = __webpack_require__(56);
 const ResourcesApi_1 = __webpack_require__(61);
+/**
+ * Platform image emedabble fields.
+ */
 var SdPlatformImageQueryEmbeddableFields;
 (function (SdPlatformImageQueryEmbeddableFields) {
     SdPlatformImageQueryEmbeddableFields["User"] = "user";
@@ -2378,23 +2415,25 @@ class SdPlatformImageApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Get image by id
-     * @param id
-     * @param embed
-     * @returns
+     * @param id - the id of an image.
+     * @param embed - array of {@link SdPlatformImageQueryEmbeddableFields} fields to embed.
+     * @returns image
      */
     get(id, embed = []) {
         return super.__get(SdPlatformRequestId_1.RequestId.ImageGet, id, embed);
     }
     /**
      * Queries images
-     * @param body
+     * @param body - {@link SdPlatformImageQueryParameters} as body.
+     *
+     * @remarks body is optional.
      */
     query(body = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.ImageQuery, body);
     }
     /**
      * Create an image
-     * @param body
+     * @param body {@link SdPlatformRequestImageCreate}
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.ImageCreate, body);
@@ -2455,33 +2494,33 @@ class SdPlatformModelApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Get model by id, guid, slug, or link_sharing_slug.
-     * @param { string} id - the model id.
-     * @param { Array<SdPlatformModelGetEmbeddableFields> } embed - embeddable properties.
-     * @returns { Promise<SdPlatformGetResponse<T> }
+     * @param  id - the model id.
+     * @param embed array of {@link SdPlatformModelGetEmbeddableFields} embeddable properties.
+     * @returns get response with a model.
      */
     get(id, embed = []) {
         return super.__get(SdPlatformRequestId_1.RequestId.ModelGet, id, embed);
     }
     /**
      * Queries the models.
-     * @param { SdPlatformModelQueryParameters } query - the query
-     * @returns { Promise<SdPlatformQueryResponse<T>> }
+     * @param  query {@link SdPlatformModelQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} response with one of {@link SdPlatformResponseModelPublic} as result.
      */
     query(query = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.ModelQuery, query);
     }
     /**
      * Create a model.
-     * @param { SdPlatformRequestModelCreate } body - the parameters of a model.
-     * @returns { Promise<SdPlatformPostResponse<T>> }
+     * @param body {@link SdPlatformRequestModelCreate} the parameters of a model.
+     * @returns the {@link SdPlatformPostResponse} response with {@link SdPlatformResponseModelOwner} as result.
      */
     create(body = {}) {
         return super.__post(SdPlatformRequestId_1.RequestId.ModelCreate, body);
     }
     /**
      * Patch a model, e.g. to update its status to "done" after successful upload and model checking
-     * @param { string } id - the model id.
-     * @param {  SdPlatformRequestModelPatch | SdPlatformRequestModelPatchAdmin} params - patch paramaters
+     * @param id - the model id.
+     * @param params {@link SdPlatformRequestModelPatch} or {@link SdPlatformRequestModelPatchAdmin} as patch paramaters
      * @returns { Promise<SdPlatformPatchResponse<T>> }
      */
     patch(id, params) {
@@ -2489,16 +2528,16 @@ class SdPlatformModelApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Deletes a model.
-     * @param { string } id - the model id.
-     * @returns {  Promise<SdPlatformDeleteResponse> }
+     * @param id - the model id.
+     * @returns the {@link SdPlatformDeleteResponse} response.
      */
     delete(id) {
         return super.__delete(SdPlatformRequestId_1.RequestId.ModelDelete, id);
     }
     /**
      *  Decrypt a ticket, the calling user must have permission "decrypt_ticket" for the model identified by the ticket.
-     * @param { string }ticket
-     * @returns
+     * @param ticket
+     * @returns decrypted ticket result {@link SdPlatformResponseDecryptTicketResult}
      */
     decryptTicket(ticket) {
         return super.__action(SdPlatformRequestId_1.RequestId.DecryptTicket, ResourcesApi_1.Action.Post, "decrypt_ticket", {
@@ -2507,6 +2546,8 @@ class SdPlatformModelApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Post method which is to be used to fetch data necessary for iframe embedding of a model using the ShapeDiver Viewer.
+     * @param slug - the model slug.
+     * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseIFrameData} as data.
      */
     iframeEmbedding(slug) {
         const is_iframe = parent !== window;
@@ -2544,24 +2585,24 @@ class SdPlatformModelSharingApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Create a model sharing relationship.
-     * @param body
-     * @returns
+     * @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) {
         return super.__post(SdPlatformRequestId_1.RequestId.ModelSharingCreate, body);
     }
     /**
      * Create multiple sharings.
-     * @param { SdPlatformRequestModelSharingCreateMultiple } body
-     * @returns {  Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>> }
+     * @param body {@link SdPlatformRequestModelSharingCreateMultiple}
+     * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseModelSharing} as result.
      */
     createMultiple(body) {
         return super.__action(SdPlatformRequestId_1.RequestId.ModelSharingCreateMultiple, ResourcesApi_1.Action.Post, "model_sharing_multiple", body);
     }
     /**
      * Query model sharing relationships.
-     * @param query
-     * @returns
+     * @param query {@link SdPlatformModelSharingQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} response with {@see SdPlatformResponseModelSharing} as data result.
      */
     query(query = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.ModelSharingQuery, query);
@@ -2569,8 +2610,8 @@ class SdPlatformModelSharingApi extends ResourcesApi_1.ResourcesApi {
     /**
       * Query model sharing relationships by model id.
       * @param model_id
-      * @param query
-      * @returns
+      * @param query {@link SdPlatformModelSharingQueryParameters}
+      * @returns the {@link SdPlatformQueryResponse} response with {@see SdPlatformResponseModelSharing} as data result.
       */
     queryByModel(model_id, query = {}) {
         return super.__action(SdPlatformRequestId_1.RequestId.ModelSharingQueryByModel, ResourcesApi_1.Action.Post, `model/${model_id}/query`, query);
@@ -2578,7 +2619,8 @@ class SdPlatformModelSharingApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Query model sharing relationships by user id.
      * @param user_id
-     * @param query
+     * @param query  {@link SdPlatformModelSharingQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} response with {@see SdPlatformResponseModelSharing} as data result.
      */
     queryByUser(user_id, query = {}) {
         return super.__action(SdPlatformRequestId_1.RequestId.ModelSharingQueryByUser, ResourcesApi_1.Action.Post, `user/${user_id}/query`, query);
@@ -2587,7 +2629,7 @@ class SdPlatformModelSharingApi extends ResourcesApi_1.ResourcesApi {
      * Get model sharing relationships by model id and user id.
      * @param model_id
      * @param user_id
-     * @returns
+     * @returns the {@link SdPlatformGetResponse} response with {@see SdPlatformResponseModelSharing} as data result.
      */
     getByModelAndUser(model_id, user_id) {
         return super.__get(SdPlatformRequestId_1.RequestId.ModelSharingGetByModelAndUser, `model/${model_id}/user/${user_id}`);
@@ -2629,6 +2671,11 @@ class SdPlatformModelTokenApi extends ResourcesApi_1.ResourcesApi {
     get __resourcePath() {
         return "tokens";
     }
+    /**
+     * 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) {
         return super.__post(SdPlatformRequestId_1.RequestId.TokenCreate, body);
     }
@@ -2664,7 +2711,7 @@ class SdPlatformModelTransferApi extends ResourcesApi_1.ResourcesApi {
      * 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
+     * @param body {@link SdPlatformRequestModelTransferCreate}
      * @returns
      */
     createModelTransferRequest(model_id, body) {
@@ -2740,33 +2787,33 @@ class SdPlatformNotificationApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Query the notifications.
-     * @param { SdPlatformNotificationQueryParameters } body - the notifications query body.
-     * @returns {  Promise<SdPlatformQueryResponse<SdPlatformResponseNotification>> }
+     * @param body {@link SdPlatformNotificationQueryParameters} notifications query body.
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseNotification} as data result.
      */
     query(body = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.NotificationQuery, body);
     }
     /**
      * Creates the notification.
-     * @param {  SdPlatformRequestNotificationCreate } body
-     * @returns {  Promise<SdPlatformPostResponse<SdPlatformResponseNotification>> }
+     * @param body {@link SdPlatformRequestNotificationCreate}
+     * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseNotification} as result.
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.NotificationCreate, body);
     }
     /**
      * Updates the notification-
-     * @param { string } id - the id of a notification.
-     * @param { SdPlatformRequestNotificationPatch } body - the body of a notification.
-     * @returns { Promise<SdPlatformPatchResponse<SdPlatformResponseNotification>> }
+     * @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, body) {
         return this.__patch(SdPlatformRequestId_1.RequestId.NotificationPatch, id, body);
     }
     /**
      * Deletes the notification.
-     * @param { string } id - the id of a notification.
-     * @returns { Promise<SdPlatformDeleteResponse> }
+     * @param id - the id of a notification.
+     * @returns  the {@link SdPlatformDeleteResponse}
      */
     delete(id) {
         return this.__delete(SdPlatformRequestId_1.RequestId.NotificationDelete, id);
@@ -2774,23 +2821,23 @@ class SdPlatformNotificationApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Gets the summary of notifications.
      * Gives information about total number of notifications and unread number of notifications.
-     * @param {  Array<SdPlatformNotificationSummaryEmbeddableFields> } embed - the embed properties.
-     * @returns { Promise<SdPlatformGetResponse<SdPlatformResponseNotificationSummary>> }
+     * @param embed - array of {@link SdPlatformNotificationSummaryEmbeddableFields} embed properties.
+     * @returns the {@link SdPlatformGetResponse} response with {@link SdPlatformResponseNotificationSummary} as data.
      */
     summary(embed) {
         return super.__get(SdPlatformRequestId_1.RequestId.NotificationSummary, 'summary', embed);
     }
     /**
      * Gets the notification by id.
-     * @param { string } id - the id of notification.
-     * @returns {  Promise<SdPlatformGetResponse<T>> }
+     * @param  id - the id of notification.
+     * @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponseNotification} as data or one of it's derived classes.
      */
     get(id) {
         return super.__get(SdPlatformRequestId_1.RequestId.NotificationGet, id);
     }
     /**
      * Marks all notifications of signed in user as read.
-     * @returns { Promise<SdPlatformPostResponse<void>> }
+     * @returns the {@link SdPlatformPostResponse} response.
      */
     markAllAsRead() {
         return super.__action(SdPlatformRequestId_1.RequestId.NotificationReadAll, ResourcesApi_1.Action.Post, 'read_all', {});
@@ -2830,22 +2877,24 @@ class SdPlatformOrganizationApi extends ResourcesApi_1.ResourcesApi {
     /**
     * Get organization by id.
     * @param id - organization id.
-    * @param embed - embeddable resources.
+    * @param embed array of {@link SdPlatformOrganizationEmbeddableFields} embeddable resources.
+    * @returns the {@link SdPlatformGetResponse} response with {@link SdPlatformResponseOrganizationPublic} or derived interfaces as result.
     */
     get(id, embed) {
         return super.__get(SdPlatformRequestId_1.RequestId.OrganizationGet, id, embed);
     }
     /**
      * Query organizations.
-     * @param body
+     * @param body {@link SdPlatformOrganizationQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseOrganizationPublic} or one of it's derived interfaces as data result.
      */
     query(body = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.OrganizationQuery, body);
     }
     /**
      * Create an organization, and make the calling user owner of the organization. Will fail in case the user is member of an organization already.
-     * @param body
-     * @returns
+     * @param body {@see SdPlatformRequestOrganizationCreate}
+     * @returns the {@link SdPlatformPostResponse} with {@see SdPlatformResponseOrganizationOwner} as data.
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.OrganizationCreate, body);
@@ -2853,7 +2902,8 @@ class SdPlatformOrganizationApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Patch an organization.
      * @param id - id of the organization
-     * @param body - properties to patch
+     * @param body {@link SdPlatformRequestOrganizationPatchAny} properties to patch
+     * @response the {@link SdPlatformPatchResponse} with {@link SdPlatformResponseOrganizationAdministrator} or one of it's derived interfaces as data.
      */
     patch(id, body) {
         return super.__patch(SdPlatformRequestId_1.RequestId.OrganizationPatch, id, body);
@@ -2950,41 +3000,41 @@ class SdPlatformPolicyApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * The platform policy api.
-     * @param { SdPlatformPolicyQueryParameters } body - the query body.
-     * @returns { Promise<SdPlatformQueryResponse<SdPlatformResponsePolicy>> }
+     * @param body {@see SdPlatformPolicyQueryParameters} query body.
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponsePolicy} as response.
      */
     query(body = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.PolicyQuery, body);
     }
     /**
      * Get information about a policy based on its id or alias
-     * @param { string } id_or_alias - id or an alias.
-     * @returns {  Promise<SdPlatformGetResponse<SdPlatformResponsePolicy>>}
+     * @param id_or_alias - id or an alias.
+     * @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponsePolicy} as response.
      */
     get(id_or_alias) {
         return super.__get(SdPlatformRequestId_1.RequestId.PolicyGet, id_or_alias);
     }
     /**
      * Creates a platform policy.
-     * @param { SdPlatformRequestPolicyCreate } body
-     * @returns { Promise<SdPlatformPostResponse<SdPlatformResponsePolicy>> }
+     * @param body {@link SdPlatformRequestPolicyCreate}
+     * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponsePolicy} as response.
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.PolicyCreate, body);
     }
     /**
      * Updates a platform policy.
-     * @param { string } id - the policy id.
-     * @param { SdPlatformRequestPolicyPatch} body - the body of patch request.
-     * @returns { Promise<SdPlatformPatchResponse<SdPlatformResponsePolicy>> }
+     * @param id - the policy id.
+     * @param body {@link SdPlatformRequestPolicyPatch} of patch request.
+     * @returns the {@link SdPlatformPatchResponse} with {@link SdPlatformResponsePolicy} as data parameter.
      */
     patch(id, body) {
         return this.__patch(SdPlatformRequestId_1.RequestId.PolicyPatch, id, body);
     }
     /**
      * Deletes the policy
-     * @param { string } id - the policy id.
-     * @returns { Promise<SdPlatformDeleteResponse> }
+     * @param id - the policy id.
+     * @returns the {@link SdPlatformDeleteResponse}
      */
     delete(id) {
         return this.__delete(SdPlatformRequestId_1.RequestId.PolicyDelete, id);
@@ -3024,42 +3074,42 @@ class SdPlatformSavedStateApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
       * Gets a saved state by id.
-      * @param { string } id - saved state id.
-      * @param { Array<SdPlatformSavedStateGetEmbedFields> } embed - embeddable fields.
-      * @returns { Promise<SdPlatformGetResponse<T>> }
+      * @param id - saved state id.
+      * @param embed the array of {@link SdPlatformSavedStateGetEmbedFields} embeddable fields.
+      * @returns - the {@link SdPlatformGetResponse} with {@see SdPlatformResponseSavedStatePublic} or one of it's derived classes as response.
       */
     get(id, embed) {
         return super.__get(SdPlatformRequestId_1.RequestId.SavedStateGet, id, embed);
     }
     /**
      * Create a new saved state.
-     * @param { SdPlatformRequestSavedStateCreate } body - creates saved state body.
-     * @returns { Promise<SdPlatformPostResponse<T>>}
+     * @param body {@link SdPlatformRequestSavedStateCreate} create saved state body.
+     * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseSavedStateOwner} or one of it's derived classes as data.
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.SavedStateCreate, body);
     }
     /**
      * Patch a saved state.
-     * @param { string } id
-     * @param { SdPlatformRequestSavedStatePatch } body - saved state patch body.
-     * @returns { Promise<SdPlatformPatchResponse<T>> }
+     * @param id
+     * @param body {@link SdPlatformRequestSavedStatePatch} saved state patch body.
+     * @returns the {@link SdPlatformPatchResponse} with {@link SdPlatformResponseSavedStateOwner} or one of it's derived classes as result.
      */
     patch(id, body) {
         return super.__patch(SdPlatformRequestId_1.RequestId.SavedStatePatch, id, body);
     }
     /**
      * Delete a saved state.
-     * @param { string } id - the id of a saved state.
-     * @returns { Promise<SdPlatformDeleteResponse> }
+     * @param id - the id of a saved state.
+     * @returns the {@link SdPlatformDeleteResponse} response.
      */
     delete(id) {
         return super.__delete(SdPlatformRequestId_1.RequestId.SavedStateDelete, id);
     }
     /**
      * Query saved states.
-     * @param { SdPlatformSavedStateApiQueryParameters | undefined } params - the query parameters.
-     * @returns { Promise<SdPlatformQueryResponse<T>> }
+     * @param params {@link SdPlatformSavedStateApiQueryParameters} query parameters.
+     * @returns the {@link SdPlatformQueryResponse} response with {@link SdPlatformResponseSavedStatePublic} or one of it's derived classes as response.
      */
     query(params) {
         return super.__query(SdPlatformRequestId_1.RequestId.SavedStateQuery, params);
@@ -3093,16 +3143,16 @@ class SdPlatformSavedStateSharingApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
       * Create a saved state sharing relationship
-      * @param body
-      * @returns
+      * @param body {@link SdPlatformResponseSavedStateSharingCreate}
+      * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseSavedStateSharing} as response.
       */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.SavedStateCreate, body);
     }
     /**
       * Create multiple sharings.
-      * @param { SdPlatformRequestSavedStateSharingCreateMultiple } body
-      * @returns {  Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>> }
+      * @param body {@link SdPlatformRequestSavedStateSharingCreateMultiple}
+      * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseModelSharing} as data response.
       */
     createMultiple(body) {
         return super.__action(SdPlatformRequestId_1.RequestId.ModelSharingCreateMultiple, ResourcesApi_1.Action.Post, "saved_state_sharing_multiple", body);
@@ -3110,7 +3160,7 @@ class SdPlatformSavedStateSharingApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Delete a saved state.
      * @param saved_state_sharing_id Id of the saved state sharing relationship to delete.
-     * @returns
+     * @returns the {@link SdPlatformDeleteResponse} as response.
      */
     delete(saved_state_sharing_id) {
         return super.__delete(SdPlatformRequestId_1.RequestId.SavedStateSharingDelete, saved_state_sharing_id);
@@ -3119,15 +3169,15 @@ class SdPlatformSavedStateSharingApi extends ResourcesApi_1.ResourcesApi {
       * Get saved state sharing relationships by saved state id and user id.
       * @param saved_state_id - saved state id.
       * @param user_id - user id.
-      * @returns
+      * @returns the {@link SdPlatformGetResponse} with array of {@link SdPlatformResponseSavedStateSharing} as data.
       */
     getBySavedStateAndUser(saved_state_id, user_id) {
         return super.__get(SdPlatformRequestId_1.RequestId.SavedStateSharingGetBySavedStateAndUser, `saved_state/${saved_state_id}/user/${user_id}`);
     }
     /**
      * Query saved state sharing relationships.
-     * @param params
-     * @returns
+     * @param params {@link SdPlatformSavedStateSharingQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseSavedStateSharing} as data.
      */
     query(query) {
         return super.__query(SdPlatformRequestId_1.RequestId.SavedStateSharingQuery, query);
@@ -3135,8 +3185,8 @@ class SdPlatformSavedStateSharingApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Query saved state sharing relationships by saved state id.
      * @param saved_state_id
-     * @param query
-     * @returns
+     * @param query {@link SdPlatformSavedStateSharingQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseSavedStateSharing} as data,
      */
     queryBySavedState(saved_state_id, query) {
         return super.__action(SdPlatformRequestId_1.RequestId.SavedStateSharingQueryBySavedState, ResourcesApi_1.Action.Post, `saved_state/${saved_state_id}/query`, query);
@@ -3144,8 +3194,8 @@ class SdPlatformSavedStateSharingApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Query saved state sharing relationships by user id.
      * @param user_id
-     * @param query
-     * @returns
+     * @param query {@link SdPlatformSavedStateSharingQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseSavedStateSharing} as data,
      */
     queryByUser(user_id, query) {
         return super.__action(SdPlatformRequestId_1.RequestId.SavedStateSharingQueryByUser, ResourcesApi_1.Action.Post, `user/${user_id}/query`, query);
@@ -3153,7 +3203,7 @@ class SdPlatformSavedStateSharingApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Gets the model sharings grouped by user.
      * @param saved_state_id
-     * @returns
+     * @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponseSavedStateSharing} as data,
      */
     getGroupedByUser(saved_state_id) {
         return super.__action(SdPlatformRequestId_1.RequestId.SavedStateSharingGroupedByuser, ResourcesApi_1.Action.Get, `saved_state/${saved_state_id}/grouped_by_user`, {});
@@ -3183,9 +3233,19 @@ class SdPlatformTagApi extends ResourcesApi_1.ResourcesApi {
     get __resourcePath() {
         return "tags";
     }
+    /**
+     * Gets the {@link SdPlatformResponseTag} by id.
+     * @param id - the id of a tag.
+     * @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponseTag} or {@link SdPlatformResponseTagAdmin} as data.
+     */
     get(id) {
         return super.__get(SdPlatformRequestId_1.RequestId.TagGet, id);
     }
+    /**
+     * Queries the {@link SdPlatformResponseTag} tags.
+     * @param query {@link SdPlatformTagQueryParameters} - query parameters for tags.
+     * @returns collection of {@link SdPlatformResponseTag} based on query parameters.
+     */
     query(query = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.TagQuery, query);
     }
@@ -3212,8 +3272,8 @@ class SdPlatformUserAnalyticsApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Query session analytics aggregated per user.
-     * @param body
-     * @returns
+     * @param body the query parameters.
+     * @returns collection of {@link SdPlatformResponseUserModelSessionAnalyticsPerTimestamp} based on query parameters.
      */
     query(body = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.UserModelSessionsQuery, body);
@@ -3263,21 +3323,21 @@ class SdPlatformUserApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Gets the specific user by id
      * @param id - user id.
-     * @param embed - embeddable resources.
+     * @param embed array of {@link SdPlatformUserGetEmbeddableFields} embeddable resources.
      */
     get(id, embed) {
         return super.__get(SdPlatformRequestId_1.RequestId.UserGet, id, embed);
     }
     /**
      * Register a new user. If successful a registration confirmation email will be sent.
-     * @param body
+     * @param body {@link SdPlatformRequestUserRegister}
      */
     register(body) {
         return super.__action(SdPlatformRequestId_1.RequestId.UserRegister, ResourcesApi_1.Action.Post, "register", body);
     }
     /**
      * Query users.
-     * @param body
+     * @param body {@link SdPlatformUserQueryParameters}
      */
     query(body = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.UserQuery, body);
@@ -3285,7 +3345,7 @@ class SdPlatformUserApi extends ResourcesApi_1.ResourcesApi {
     /**
      * Patch a user.
      * @param id - the id of a user
-     * @param body - properties to patch
+     * @param body {@link SdPlatformRequestUserPatch} properties to patch
      */
     // note - think about whether or not admin user resource should be default ?
     patch(id, body) {
@@ -3320,24 +3380,24 @@ class SdPlatformUserApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Change password using token
-     * @param body
+     * @param body {@see SdPlatformRequestUserPasswordResetConfirm}
      */
     passwordResetConfirm(body) {
         return super.__action(SdPlatformRequestId_1.RequestId.PasswordResetConfirm, ResourcesApi_1.Action.Post, 'password_reset_confirm', body);
     }
     /**
      * Returns an array of data about authorized client applications and their refresh tokens.
-     * @param {string } user_id
-     * @returns { Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>> }
+     * @param  user_id
+     * @returns the {@link SdPlatformGetResponse} with array of {@link SdPlatformResponseUserRefreshToken} as data
      */
     getUserRefreshTokens(user_id) {
         return super.__action(SdPlatformRequestId_1.RequestId.UserRefreshToken, ResourcesApi_1.Action.Get, `users/${user_id}/apiclients`, {});
     }
     /**
      * Delete refresh token.
-     * @param { string } user_id
-     * @param { string } refresh_token_id
-     * @returns { Promise<SdPlatformDeleteResponse> }
+     * @param user_id
+     * @param  refresh_token_id
+     * @returns the {@link SdPlatformDeleteResponse} response.
      */
     deleteRefreshToken(user_id, refresh_token_id) {
         return super.__action(SdPlatformRequestId_1.RequestId.UserDeleteRefreshToken, ResourcesApi_1.Action.Delete, `users/${user_id}/apiclients/${refresh_token_id}`, {});
@@ -3381,8 +3441,8 @@ class SdPlatformWebhookApi {
     }
     /**
      * Webhook which notifies the platform of chargebee events.
-     * @param auth
-     * @param body
+     * @param auth {@link SdPlatformWebhookBasicAuth}
+     * @param body {@link SdPlatformRequestWebhookChargebeeEvent}
      * @returns
      */
     chargebeeEvent(auth, body) {
@@ -3393,8 +3453,8 @@ class SdPlatformWebhookApi {
     }
     /**
     * Model message webhook call - send a message to the owner of a model.
-    * @param auth
-    * @param body
+    * @param auth {@link SdPlatformWebhookTokenAuth}
+    * @param body {@link SdPlatformRequestWebhookModelMessage}
     * @returns
     */
     modelMessage(auth, body) {
@@ -3405,8 +3465,8 @@ class SdPlatformWebhookApi {
     }
     /**
     * Notification webhook call - create a notification related to a model.
-    * @param auth
-    * @param body
+    * @param auth {@link SdPlatformWebhookTokenAuth}
+    * @param body {@link SdPlatformRequestWebhookNotification}
     * @returns
     */
     notification(auth, body) {
@@ -8286,16 +8346,16 @@ class SdPlatformDocumentApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Create a document.
-     * @param { SdPlatformRequestDocumentCreate } body
-     * @returns {  Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>> }
+     * @param body - {@link SdPlatformRequestDocumentCreate } body
+     * @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseDomainAdmin} data
      */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.DocumentCreate, body);
     }
     /**
      * Query documents.
-     * @param { SdPlatformDocumentQueryParameters } query
-     * @returns { Promise<SdPlatformQueryResponse<SdPlatformResponseDocument>> }
+     * @param query - {@link SdPlatformDocumentQueryParameters} query parameters.
+     * @returns - the {@link SdPlatformQueryResponse} query response with array of {@link SdPlatformResponseDocument} as data.
      */
     query(query = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.DocumentQuery, query);
@@ -8309,7 +8369,7 @@ class SdPlatformDocumentApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
     * Get a list of documents which are relevant to the requesting user.
-    * @param { SdPlatformDocumentGetQueryParameters | undefined | null } query_parameters
+    * @param query_parameters - optional, {@link SdPlatformDocumentGetQueryParameters}
     * @returns { Promise<SdPlatformGetResponse<Array<SdPlatformResponseDocumentUser>>> }
     */
     list(query_parameters) {
@@ -8378,8 +8438,8 @@ class SdPlatformOrganizationAnalyticsApi extends ResourcesApi_1.ResourcesApi {
     }
     /**
      * Query session analytics aggregated per user.
-     * @param { SdPlatformQueryParameters<unknown> } body - the query body.
-     * @returns { Promise<SdPlatformQueryResponse<SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp>> }
+     * @param body - {@link SdPlatformQueryParameters} query body.
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp} as query data response.
      */
     query(body = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.OrganizationModelSessionsQuery, body);
@@ -8462,25 +8522,49 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SdPlatformApiClientsApi = exports.SdPlatformApiClientsQueryEmbeddableFields = void 0;
 const SdPlatformRequestId_1 = __webpack_require__(56);
 const ResourcesApi_1 = __webpack_require__(61);
+/**
+ * The embeddable fields for query parameter.
+ */
 var SdPlatformApiClientsQueryEmbeddableFields;
 (function (SdPlatformApiClientsQueryEmbeddableFields) {
 })(SdPlatformApiClientsQueryEmbeddableFields = exports.SdPlatformApiClientsQueryEmbeddableFields || (exports.SdPlatformApiClientsQueryEmbeddableFields = {}));
 /**
- * Operations for models on the ShapeDiver Platform.
+ * API client operations (API clients of the platform backend).
  */
 class SdPlatformApiClientsApi extends ResourcesApi_1.ResourcesApi {
     get __resourcePath() {
         return "apiclients";
     }
+    /**
+     * Query the api clients.
+     * @param query - {@link SdPlatformApiClientsQueryParameters} optional query parameters
+     * @returns query result
+     */
     query(query = {}) {
         return super.__query(SdPlatformRequestId_1.RequestId.ApiClientQuery, query);
     }
+    /**
+     * Create a new api client.
+     * @param body - {@link SdPlatformRequestApiClientCreate} body or parameters for create request.
+     * @returns returns created api client response.
+     */
     create(body) {
         return super.__post(SdPlatformRequestId_1.RequestId.ApiClientCreate, body);
     }
+    /**
+     * Patch an api client
+     * @param id
+     * @param body - {@link SdPlatformRequestApiClientPatch} body or patch parameters.
+     * @returns patch response.
+     */
     patch(id, body) {
         return super.__patch(SdPlatformRequestId_1.RequestId.ApiClientPatch, id, body);
     }
+    /**
+     * Delete an api client.
+     * @param id
+     * @returns delete response.
+     */
     delete(id) {
         return super.__delete(SdPlatformRequestId_1.RequestId.ApiClientDelete, id);
     }