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

package/dist/resources/SdPlatformApiClientsApi.d.ts

@@ -1,17 +1,44 @@
 import { ResourcesApi } from "./commons/ResourcesApi";
 import { SdPlatformResponseApiClient, SdPlatformRequestApiClientCreate, SdPlatformRequestApiClientPatch } from "@shapediver/api.platform-api-dto-v1";
 import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
+/**
+ * The embeddable fields for query parameter.
+ */
 export declare enum SdPlatformApiClientsQueryEmbeddableFields {
 }
+/**
+ * The query parameters for platform api clients.
+ */
 export declare type SdPlatformApiClientsQueryParameters = SdPlatformQueryParameters<SdPlatformApiClientsQueryEmbeddableFields>;
 /**
- * Operations for models on the ShapeDiver Platform.
+ * API client operations (API clients of the platform backend).
  */
 export declare class SdPlatformApiClientsApi extends ResourcesApi {
     protected get __resourcePath(): string;
+    /**
+     * Query the api clients.
+     * @param query - {@link SdPlatformApiClientsQueryParameters} optional query parameters
+     * @returns query result
+     */
     query(query?: SdPlatformApiClientsQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiClient>>;
+    /**
+     * Create a new api client.
+     * @param body - {@link SdPlatformRequestApiClientCreate} body or parameters for create request.
+     * @returns returns created api client response.
+     */
     create(body: SdPlatformRequestApiClientCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiClient>>;
+    /**
+     * Patch an api client
+     * @param id
+     * @param body - {@link SdPlatformRequestApiClientPatch} body or patch parameters.
+     * @returns patch response.
+     */
     patch(id: string, body: SdPlatformRequestApiClientPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiClient>>;
+    /**
+     * Delete an api client.
+     * @param id
+     * @returns delete response.
+     */
     delete(id: string): Promise<SdPlatformDeleteResponse>;
 }
 //# sourceMappingURL=SdPlatformApiClientsApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformApiClientsApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiClientsApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAmM,2BAA2B,EAAE,gCAAgC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAA;AACrV,OAAO,EAAE,yBAAyB,EAAyB,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,yCAAyC;CACnD;AAGF,oBAAY,mCAAmC,GAAG,yBAAyB,CAAC,yCAAyC,CAAC,CAAC;AAEvH;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAIM,KAAK,CAAC,KAAK,GAAE,mCAAwC,GAAG,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAKrH,MAAM,CAAC,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;IAK5G,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,GAAI,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAKxH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAM/D"}
+{"version":3,"file":"SdPlatformApiClientsApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiClientsApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAA;AACpJ,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEnL;;GAEG;AACH,oBAAY,yCAAyC;CACnD;AAGF;;GAEG;AACH,oBAAY,mCAAmC,GAAG,yBAAyB,CAAC,yCAAyC,CAAC,CAAC;AAEvH;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,mCAAwC,GAAG,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAK5H;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;IAKnH;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,GAAI,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAK/H;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAM/D"}

package/dist/resources/SdPlatformApiTokenApi.d.ts

@@ -12,33 +12,32 @@ export declare class SdPlatformApiTokenApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * Get the token.
-     * @param { string } key_id
-     * @returns { Promise<SdPlatformGetResponse<SdPlatformResponseApiToken>> }
+     * @param key_id
+     * @returns api token response.
      */
     get(key_id: string): Promise<SdPlatformGetResponse<SdPlatformResponseApiToken>>;
     /**
      * 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?: SdPlatformApiTokenQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiToken>>;
     /**
      * 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: SdPlatformRequestApiTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiTokenWithSecret>>;
     /**
      * 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: string, body: SdPlatformRequestApiTokenPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiToken>>;
     /**
      * Delete an API token.
-     * @param { string } key_id
-     * @returns { Promise<SdPlatformDeleteResponse> }
+     * @param  key_id
      */
     delete(key_id: string): Promise<SdPlatformDeleteResponse>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformApiTokenApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiTokenApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAC/K,OAAO,EAAC,yBAAyB,EAAE,+BAA+B,EAAE,8BAA8B,EAAE,0BAA0B,EAAE,oCAAoC,EAAC,MAAM,qCAAqC,CAAC;AAEjN,oBAAY,iCAAiC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;IAKtF;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,iCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKzH;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAK3H;;;;;OAKG;IACI,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAInE"}
+{"version":3,"file":"SdPlatformApiTokenApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiTokenApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAC/K,OAAO,EAAC,yBAAyB,EAAE,+BAA+B,EAAE,8BAA8B,EAAE,0BAA0B,EAAE,oCAAoC,EAAC,MAAM,qCAAqC,CAAC;AAEjN,oBAAY,iCAAiC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;IAKtF;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,iCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKzH;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAK3H;;;;;OAKG;IACI,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKhI;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAInE"}

package/dist/resources/SdPlatformBackendSystemApi.d.ts

@@ -1,6 +1,9 @@
 import { ResourcesApi } from "./commons/ResourcesApi";
 import { SdPlatformRequestBackendSystemCreate, SdPlatformRequestBackendSystemPatch, SdPlatformRequestBackendSystemToken, SdPlatformResponseBackendSystem, SdPlatformResponseBackendSystemAdmin, SdPlatformResponseBackendSystemToken } from "@shapediver/api.platform-api-dto-v1";
 import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
+/**
+ * The query parameters for fetching the @see {@link SdPlatformResponseBackendSystem}
+ */
 export declare type SdPlatformBackendSystemQueryParameters = SdPlatformQueryParameters<string> | undefined;
 /**
  * Operations for ShapeDiver Geometry Backend Systems known by the Platform Backend.
@@ -9,27 +12,27 @@ export declare class SdPlatformBackendSystemApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * 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?: SdPlatformBackendSystemQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
     /**
      * 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: SdPlatformRequestBackendSystemCreate): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemAdmin>>;
     /**
      * 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: string, body: SdPlatformRequestBackendSystemPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
     /**
      * 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: SdPlatformRequestBackendSystemToken): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemToken>>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformBackendSystemApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBackendSystemApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,oCAAoC,EAAE,mCAAmC,EAAE,mCAAmC,EAAE,+BAA+B,EAAE,oCAAoC,EAAE,oCAAoC,EAAE,MAAM,qCAAqC,CAAC;AAClR,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAGzJ,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAEnG;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAExD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,sCAA2C,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAKxK;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,oCAAoC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAKhI;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAK3K;;;;OAIG;IACI,KAAK,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;CAIjI"}
+{"version":3,"file":"SdPlatformBackendSystemApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBackendSystemApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,oCAAoC,EAAE,mCAAmC,EAAE,mCAAmC,EAAE,+BAA+B,EAAE,oCAAoC,EAAE,oCAAoC,EAAE,MAAM,qCAAqC,CAAC;AAClR,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAGzJ;;GAEG;AACH,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAEnG;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAExD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,sCAA2C,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAKxK;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,oCAAoC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAKhI;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAK3K;;;;OAIG;IACI,KAAK,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;CAIjI"}

package/dist/resources/SdPlatformBookmarkApi.d.ts

@@ -5,17 +5,20 @@ import { SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/ap
  * Operations for creating and deleting bookmarks
  */
 export declare class SdPlatformBookmarkApi extends ResourcesApi {
+    /**
+     * The resource path.
+     */
     protected get __resourcePath(): string;
     /**
      * 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: SdPlatformRequestBookmarkCreate): Promise<SdPlatformPostResponse<void>>;
     /**
      * 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: string): Promise<SdPlatformDeleteResponse>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformBookmarkApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBookmarkApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAItG;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAK3F;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
+{"version":3,"file":"SdPlatformBookmarkApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBookmarkApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAGtG;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD;;OAEG;IACH,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAK3F;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}

package/dist/resources/SdPlatformChargebeeApi.d.ts

@@ -8,9 +8,32 @@ export declare type SdPlatformChargebeePlanQueryParameters = SdPlatformQueryPara
  */
 export declare class SdPlatformChargebeeApi extends ResourcesApi {
     protected get __resourcePath(): string;
+    /**
+     * 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: SdPlatformRequestChargebeeHostedPage): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
+    /**
+     * 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: SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
+    /**
+     * 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: SdPlatformRequestChargebeePortalSession): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePortalSession>>;
+    /**
+     * Queries the chargebee plans.
+     * @param body - {@link SdPlatformChargebeePlanQueryParameters } body
+     * @returns - post response with {@link SdPlatformResponseChargebeePlan} data
+     */
     queryChargebeePlans(body: SdPlatformChargebeePlanQueryParameters): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePlan>>;
     /**
      *

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformChargebeeApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformChargebeeApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oCAAoC,EAAE,uDAAuD,EAAE,uCAAuC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAChO,OAAO,EAAE,qCAAqC,EAAE,wCAAwC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACvK,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAE9H,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAErF;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IAEpD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,UAAU,CAAC,IAAI,EAAE,oCAAoC,GAAI,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAK/H,6BAA6B,CAAC,IAAI,EAAE,uDAAuD,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAKpK,aAAa,CAAC,IAAI,EAAE,uCAAuC,GAAG,OAAO,CAAC,sBAAsB,CAAC,wCAAwC,CAAC,CAAC;IAKvI,mBAAmB,CAAC,IAAI,EAAE,sCAAsC,GAAG,OAAO,CAAC,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;IAK1I;;;OAGG;IACI,MAAM,IAAI,OAAO,CAAC,qBAAqB,CAAC,iCAAiC,CAAC,CAAC;CAIrF"}
+{"version":3,"file":"SdPlatformChargebeeApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformChargebeeApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oCAAoC,EAAE,uDAAuD,EAAE,uCAAuC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAChO,OAAO,EAAE,qCAAqC,EAAE,wCAAwC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACvK,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAE9H,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAErF;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IAEpD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,UAAU,CAAC,IAAI,EAAE,oCAAoC,GAAI,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAKtI;;;;;OAKG;IACI,6BAA6B,CAAC,IAAI,EAAE,uDAAuD,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAK3K;;;;;OAKG;IACI,aAAa,CAAC,IAAI,EAAE,uCAAuC,GAAG,OAAO,CAAC,sBAAsB,CAAC,wCAAwC,CAAC,CAAC;IAK9I;;;;OAIG;IACI,mBAAmB,CAAC,IAAI,EAAE,sCAAsC,GAAG,OAAO,CAAC,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;IAK1I;;;OAGG;IACI,MAAM,IAAI,OAAO,CAAC,qBAAqB,CAAC,iCAAiC,CAAC,CAAC;CAIrF"}

package/dist/resources/SdPlatformDocumentApi.d.ts

@@ -29,14 +29,14 @@ export declare class SdPlatformDocumentApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * Create a document.
-     * @param { SdPlatformRequestDocumentCreate } body
-     * @returns {  Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>> }
+     * @param body - {@link SdPlatformRequestDocumentCreate } body
+     * @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseDomainAdmin} data
      */
     create(body: SdPlatformRequestDocumentCreate): Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>>;
     /**
      * 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?: SdPlatformDocumentQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseDocument>>;
     /**
@@ -46,7 +46,7 @@ export declare class SdPlatformDocumentApi extends ResourcesApi {
     delete(id: string): Promise<SdPlatformDeleteResponse>;
     /**
     * 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?: SdPlatformDocumentGetQueryParameters): Promise<SdPlatformGetResponse<Array<SdPlatformResponseDocumentUser>>>;

package/dist/resources/SdPlatformDomainApi.d.ts

@@ -16,8 +16,8 @@ export declare class SdPlatformDomainApi extends 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: string, embed?: Array<SdPlatformDomainGetEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseDomain | SdPlatformResponseDomainAdmin>>;
     /**
@@ -27,13 +27,15 @@ export declare class SdPlatformDomainApi extends ResourcesApi {
      */
     query(query?: SdPlatformDomainQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseDomain | SdPlatformResponseDomainAdmin>>;
     /**
-     * Create a domain.
+     * Create a new domain.
+     * @param body - {@link SdPlatformRequestDomainCreate} as request body.
+     * @returns - new domain.
      */
     create(body: SdPlatformRequestDomainCreate): Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>>;
     /**
      * 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: string, body: SdPlatformRequestDomainPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseDomainAdmin>>;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformDomainApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformDomainApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,wBAAwB,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AAC3K,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAG1M,oBAAY,mCAAmC;IAE3C,MAAM,WAAW;CACpB;AAED,oBAAY,qCAAqC;IAE7C,WAAW,iBAAiB;CAC/B;AAED,oBAAY,+BAA+B,GAAG,yBAAyB,CAAC,qCAAqC,CAAC,CAAC;AAE/G;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IAEjD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,mCAAmC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKxK;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,+BAAoC,GAAG,OAAO,CAAC,uBAAuB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKrJ;;OAEG;IACI,MAAM,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;IAKlH;;;;OAIG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,uBAAuB,CAAC,6BAA6B,CAAC,CAAC;IAK7H;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
+{"version":3,"file":"SdPlatformDomainApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformDomainApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,wBAAwB,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AAC3K,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAG1M,oBAAY,mCAAmC;IAE3C,MAAM,WAAW;CACpB;AAED,oBAAY,qCAAqC;IAE7C,WAAW,iBAAiB;CAC/B;AAED,oBAAY,+BAA+B,GAAG,yBAAyB,CAAC,qCAAqC,CAAC,CAAC;AAE/G;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IAEjD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,mCAAmC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKxK;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,+BAAoC,GAAG,OAAO,CAAC,uBAAuB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKrJ;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;IAKlH;;;;OAIG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,uBAAuB,CAAC,6BAA6B,CAAC,CAAC;IAK7H;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}

package/dist/resources/SdPlatformHttpLogApi.d.ts

@@ -9,7 +9,8 @@ export declare class SdPlatformHttpLogApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * Query HTTP logs.
-     * @param body
+     * @param body - the body of a request.
+     * @returns - http logs.
      */
     query(body?: SdPlatformHttpLogQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseHttpLog>>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformHttpLogApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformHttpLogApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAG,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAExG,oBAAY,gCAAgC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAE/E;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IAElD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,GAAE,gCAAqC,GAAG,OAAO,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;CAIzH"}
+{"version":3,"file":"SdPlatformHttpLogApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformHttpLogApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAG,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAExG,oBAAY,gCAAgC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAE/E;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IAElD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,GAAE,gCAAqC,GAAG,OAAO,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;CAIzH"}

package/dist/resources/SdPlatformImageApi.d.ts

@@ -1,10 +1,16 @@
 import { SdPlatformResponseImage, SdPlatformResponseImageAdmin, SdPlatformResponseImagePublic, SdPlatformRequestImageCreate } from "@shapediver/api.platform-api-dto-v1";
 import { ResourcesApi } from "./commons/ResourcesApi";
 import { SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformQueryParameters, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
+/**
+ * Platform image emedabble fields.
+ */
 export declare enum SdPlatformImageQueryEmbeddableFields {
     User = "user",
     Models = "models"
 }
+/**
+ * Platform query image parameters.
+ */
 export declare type SdPlatformImageQueryParameters = SdPlatformQueryParameters<SdPlatformImageQueryEmbeddableFields>;
 /**
  * Operations for images which can be attached to models.
@@ -13,19 +19,21 @@ export declare class SdPlatformImageApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * 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: string, embed?: Array<SdPlatformImageQueryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
     /**
      * Queries images
-     * @param body
+     * @param body - {@link SdPlatformImageQueryParameters} as body.
+     *
+     * @remarks body is optional.
      */
     query(body?: SdPlatformImageQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
     /**
      * Create an image
-     * @param body
+     * @param body {@link SdPlatformRequestImageCreate}
      */
     create(body: SdPlatformRequestImageCreate): Promise<SdPlatformPostResponse<SdPlatformResponseImage>>;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformImageApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformImageApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACzK,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEjL,oBAAY,oCAAoC;IAE5C,IAAI,SAAS;IACb,MAAM,WAAW;CACpB;AAED,oBAAY,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,oCAAoC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKvM;;;OAGG;IACI,KAAK,CAAC,IAAI,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKjL;;;OAGG;IACI,MAAM,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;IAK3G;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
+{"version":3,"file":"SdPlatformImageApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformImageApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACzK,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEjL;;GAEG;AACH,oBAAY,oCAAoC;IAE5C,IAAI,SAAS;IACb,MAAM,WAAW;CACpB;AAED;;GAEG;AACH,oBAAY,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,oCAAoC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKvM;;;;;OAKG;IACI,KAAK,CAAC,IAAI,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKjL;;;OAGG;IACI,MAAM,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;IAK3G;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}

package/dist/resources/SdPlatformModelApi.d.ts

@@ -33,44 +33,46 @@ export declare class SdPlatformModelApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * 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<T = SdPlatformResponseModelPublic>(id: string, embed?: Array<SdPlatformModelGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
     /**
      * 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<T = SdPlatformResponseModelPublic>(query?: SdPlatformModelQueryParameters): Promise<SdPlatformQueryResponse<T>>;
     /**
      * 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<T = SdPlatformResponseModelOwner>(body?: SdPlatformRequestModelCreate): Promise<SdPlatformPostResponse<T>>;
     /**
      * 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<T = SdPlatformResponseModelOwner>(id: string, params: SdPlatformRequestModelPatch | SdPlatformRequestModelPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
     /**
      * Deletes a model.
-     * @param { string } id - the model id.
-     * @returns {  Promise<SdPlatformDeleteResponse> }
+     * @param id - the model id.
+     * @returns the {@link SdPlatformDeleteResponse} response.
      */
     delete(id: string): Promise<SdPlatformDeleteResponse>;
     /**
      *  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: string): Promise<SdPlatformPostResponse<SdPlatformResponseDecryptTicketResult>>;
     /**
      * 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: string): Promise<SdPlatformPostResponse<SdPlatformResponseIFrameData>>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformModelApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,qCAAqC,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAA;AACnR,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,oCAAoC;IAE5C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,kCAAkC;IAE1C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,iBAAiB,uBAAuB;IACxC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,YAAY,kBAAkB;IAC9B,aAAa,mBAAmB;IAChC,YAAY,iBAAiB;CAChC;AAED,oBAAY,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,CAAC,GAAG,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,kCAAkC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAKnJ;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,6BAA6B,EAAE,KAAK,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,CAAC,GAAG,4BAA4B,EAAE,IAAI,GAAE,4BAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAK5H;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,4BAA4B,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKvK;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;OAIG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAO5G;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,4BAA4B,CAAC,CAAC;CAStG"}
+{"version":3,"file":"SdPlatformModelApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,qCAAqC,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAA;AACnR,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,oCAAoC;IAE5C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,kCAAkC;IAE1C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,iBAAiB,uBAAuB;IACxC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,YAAY,kBAAkB;IAC9B,aAAa,mBAAmB;IAChC,YAAY,iBAAiB;CAChC;AAED,oBAAY,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,CAAC,GAAG,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,kCAAkC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAKnJ;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,6BAA6B,EAAE,KAAK,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,CAAC,GAAG,4BAA4B,EAAE,IAAI,GAAE,4BAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAK5H;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,4BAA4B,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKvK;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;OAIG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAO5G;;;;OAIG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,4BAA4B,CAAC,CAAC;CAStG"}

package/dist/resources/SdPlatformModelSharingApi.d.ts

@@ -13,40 +13,41 @@ export declare class SdPlatformModelSharingApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * 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: SdPlatformRequestModelSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseModelSharing>>;
     /**
      * 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: SdPlatformRequestModelSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>>;
     /**
      * Query model sharing relationships.
-     * @param query
-     * @returns
+     * @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
-      * @returns
+      * @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
+     * @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
+     * @returns the {@link SdPlatformGetResponse} response with {@see SdPlatformResponseModelSharing} as data result.
      */
     getByModelAndUser(model_id: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharing>>>;
     /**

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;;;;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"}
+{"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"}

package/dist/resources/SdPlatformModelTokenApi.d.ts

@@ -6,6 +6,11 @@ import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
  */
 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/SdPlatformModelTokenApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformModelTokenApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelTokenApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,4BAA4B,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AACtH,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAE5E;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,MAAM,CAAC,IAAI,EAAE,iCAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,4BAA4B,CAAC,CAAC;CAIxH"}
+{"version":3,"file":"SdPlatformModelTokenApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelTokenApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,4BAA4B,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AACtH,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAE5E;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,iCAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,4BAA4B,CAAC,CAAC;CAIxH"}

package/dist/resources/SdPlatformModelTransferApi.d.ts

@@ -15,7 +15,7 @@ export declare class SdPlatformModelTransferApi extends 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: string, body: SdPlatformRequestModelTransferCreate): Promise<SdPlatformPostResponse<SdPlatformResponseNotification | undefined>>;

package/dist/resources/SdPlatformNotificationApi.d.ts

@@ -21,45 +21,45 @@ export declare class SdPlatformNotificationApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * 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?: SdPlatformNotificationQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseNotification>>;
     /**
      * 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: SdPlatformRequestNotificationCreate): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
     /**
      * 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: string, body: SdPlatformRequestNotificationPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseNotification>>;
     /**
      * 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: string): Promise<SdPlatformDeleteResponse>;
     /**
      * 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: Array<SdPlatformNotificationSummaryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseNotificationSummary>>;
     /**
      * 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<T = SdPlatformResponseNotification>(id: string): Promise<SdPlatformGetResponse<T>>;
     /**
      * Marks all notifications of signed in user as read.
-     * @returns { Promise<SdPlatformPostResponse<void>> }
+     * @returns the {@link SdPlatformPostResponse} response.
      */
     markAllAsRead(): Promise<SdPlatformPostResponse<void>>;
 }

package/dist/resources/SdPlatformOrganizationAnalyticsApi.d.ts

@@ -8,8 +8,8 @@ export declare class SdPlatformOrganizationAnalyticsApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * 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?: SdPlatformQueryParameters<unknown>): Promise<SdPlatformQueryResponse<SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp>>;
 }