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

package/dist/resources/SdPlatformOrganizationApi.d.ts

@@ -20,24 +20,27 @@ export declare class SdPlatformOrganizationApi extends 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<T = SdPlatformResponseOrganizationPublic>(id: string, embed?: Array<SdPlatformOrganizationEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
     /**
      * 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<T = SdPlatformResponseOrganizationPublic>(body?: SdPlatformOrganizationQueryParameters): Promise<SdPlatformQueryResponse<T>>;
     /**
      * 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: SdPlatformRequestOrganizationCreate): Promise<SdPlatformPostResponse<SdPlatformResponseOrganizationOwner>>;
     /**
      * 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<T = SdPlatformResponseOrganizationAdministrator>(id: string, body: SdPlatformRequestOrganizationPatchAny): Promise<SdPlatformPatchResponse<T>>;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformOrganizationApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformOrganizationApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,8BAA8B,EAAE,mCAAmC,EAAE,qCAAqC,EAAE,oCAAoC,EAAE,mCAAmC,EAAE,2CAA2C,EAAE,gCAAgC,EAAgC,MAAM,qCAAqC,CAAA;AACxV,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,sCAAsC;IAE9C,aAAa,kBAAkB;IAC/B,aAAa,mBAAmB;IAChC,OAAO,YAAY;IACnB,iBAAiB,uBAAuB;IACxC,qBAAqB,2BAA2B;IAChD,aAAa,mBAAmB;IAChC,eAAe,qBAAqB;IACpC,cAAc,oBAAoB;CACrC;AAED,oBAAY,qCAAqC,GAAG,yBAAyB,CAAC,sCAAsC,CAAC,CAAA;AAErH;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IAEvD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;MAIE;IACK,GAAG,CAAC,CAAC,GAAG,oCAAoC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,sCAAsC,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAK1J;;;OAGG;IACI,KAAK,CAAC,CAAC,GAAG,oCAAoC,EAAE,IAAI,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK7I;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,mCAAmC,CAAC,CAAC;IAK9H;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,2CAA2C,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,qCAAqC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK3J;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;;OAKG;IACI,4BAA4B,CAAC,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;IAKlJ;;;;;OAKG;IACI,4BAA4B,CAAC,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAKpH;;;;OAIG;IACI,0BAA0B,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAMjI;;;;OAIG;IACI,4BAA4B,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAMnG;;;;OAIG;IACI,0BAA0B,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAKjG;;;OAGG;IACI,eAAe,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAO7J;;;;OAIG;IACI,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;CAM1G"}
+{"version":3,"file":"SdPlatformOrganizationApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformOrganizationApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,8BAA8B,EAAE,mCAAmC,EAAE,qCAAqC,EAAE,oCAAoC,EAAE,mCAAmC,EAAE,2CAA2C,EAAE,gCAAgC,EAAgC,MAAM,qCAAqC,CAAA;AACxV,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,sCAAsC;IAE9C,aAAa,kBAAkB;IAC/B,aAAa,mBAAmB;IAChC,OAAO,YAAY;IACnB,iBAAiB,uBAAuB;IACxC,qBAAqB,2BAA2B;IAChD,aAAa,mBAAmB;IAChC,eAAe,qBAAqB;IACpC,cAAc,oBAAoB;CACrC;AAED,oBAAY,qCAAqC,GAAG,yBAAyB,CAAC,sCAAsC,CAAC,CAAA;AAErH;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IAEvD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;MAKE;IACK,GAAG,CAAC,CAAC,GAAG,oCAAoC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,sCAAsC,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAK1J;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,oCAAoC,EAAE,IAAI,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK7I;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,mCAAmC,CAAC,CAAC;IAK9H;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,2CAA2C,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,qCAAqC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK3J;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;;OAKG;IACI,4BAA4B,CAAC,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;IAKlJ;;;;;OAKG;IACI,4BAA4B,CAAC,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAKpH;;;;OAIG;IACI,0BAA0B,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAMjI;;;;OAIG;IACI,4BAA4B,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAMnG;;;;OAIG;IACI,0BAA0B,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAKjG;;;OAGG;IACI,eAAe,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAO7J;;;;OAIG;IACI,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;CAM1G"}

package/dist/resources/SdPlatformPolicyApi.d.ts

@@ -11,33 +11,33 @@ export declare class SdPlatformPolicyApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
      * 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?: SdPlatformPolicyQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponsePolicy>>;
     /**
      * 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: string): Promise<SdPlatformGetResponse<SdPlatformResponsePolicy>>;
     /**
      * 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: SdPlatformRequestPolicyCreate): Promise<SdPlatformPostResponse<SdPlatformResponsePolicy>>;
     /**
      * 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: string, body: SdPlatformRequestPolicyPatch): Promise<SdPlatformPatchResponse<SdPlatformResponsePolicy>>;
     /**
      * Deletes the policy
-     * @param { string } id - the policy id.
-     * @returns { Promise<SdPlatformDeleteResponse> }
+     * @param id - the policy id.
+     * @returns the {@link SdPlatformDeleteResponse}
      */
     delete(id: string): Promise<SdPlatformDeleteResponse>;
 }

package/dist/resources/SdPlatformSavedStateApi.d.ts

@@ -18,34 +18,34 @@ export declare class SdPlatformSavedStateApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
       * 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<T = SdPlatformResponseSavedStatePublic>(id: string, embed?: Array<SdPlatformSavedStateGetEmbedFields>): Promise<SdPlatformGetResponse<T>>;
     /**
      * 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<T = SdPlatformResponseSavedStateOwner>(body: SdPlatformRequestSavedStateCreate): Promise<SdPlatformPostResponse<T>>;
     /**
      * 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<T = SdPlatformResponseSavedStateOwner>(id: string, body: SdPlatformRequestSavedStatePatch): Promise<SdPlatformPatchResponse<T>>;
     /**
      * 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: string): Promise<SdPlatformDeleteResponse>;
     /**
      * 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<T = SdPlatformResponseSavedStatePublic>(params?: SdPlatformSavedStateApiQueryParameters): Promise<SdPlatformQueryResponse<T>>;
 }

package/dist/resources/SdPlatformSavedStateSharingApi.d.ts

@@ -14,53 +14,53 @@ export declare class SdPlatformSavedStateSharingApi extends ResourcesApi {
     protected get __resourcePath(): string;
     /**
       * Create a saved state sharing relationship
-      * @param body
-      * @returns
+      * @param body {@link SdPlatformResponseSavedStateSharingCreate}
+      * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseSavedStateSharing} as response.
       */
     create(body: SdPlatformResponseSavedStateSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseSavedStateSharing>>;
     /**
       * 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: SdPlatformRequestSavedStateSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseSavedStateSharing>>>;
     /**
      * 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: string): Promise<SdPlatformDeleteResponse>;
     /**
       * 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: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharing>>>;
     /**
      * Query saved state sharing relationships.
-     * @param params
-     * @returns
+     * @param params {@link SdPlatformSavedStateSharingQueryParameters}
+     * @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseSavedStateSharing} as data.
      */
     query(query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
     /**
      * 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: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
     /**
      * 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: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
     /**
      * 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: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharingGroupedByUser>>>;
 }

package/dist/resources/SdPlatformTagApi.d.ts

@@ -10,7 +10,17 @@ export declare type SdPlatformTagQueryParameters = SdPlatformQueryParameters<SdP
  */
 export declare class SdPlatformTagApi extends ResourcesApi {
     protected get __resourcePath(): string;
+    /**
+     * 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: string): Promise<SdPlatformGetResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
+    /**
+     * Queries the {@link SdPlatformResponseTag} tags.
+     * @param query {@link SdPlatformTagQueryParameters} - query parameters for tags.
+     * @returns collection of {@link SdPlatformResponseTag} based on query parameters.
+     */
     query(query?: SdPlatformTagQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
 }
 //# sourceMappingURL=SdPlatformTagApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SdPlatformTagApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformTagApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAA;AACvG,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAE/H,oBAAY,kCAAkC;IAE1C,WAAW,iBAAiB;CAC/B;AAED,oBAAY,4BAA4B,GAAG,yBAAyB,CAAC,kCAAkC,CAAC,CAAC;AAEzG;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAE9C,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,qBAAqB,GAAG,0BAA0B,CAAC,CAAC;IAKnG,KAAK,CAAC,KAAK,GAAE,4BAAiC,GAAG,OAAO,CAAC,uBAAuB,CAAC,qBAAqB,GAAG,0BAA0B,CAAC,CAAC;CAI/I"}
+{"version":3,"file":"SdPlatformTagApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformTagApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAA;AACvG,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAE/H,oBAAY,kCAAkC;IAE1C,WAAW,iBAAiB;CAC/B;AAED,oBAAY,4BAA4B,GAAG,yBAAyB,CAAC,kCAAkC,CAAC,CAAC;AAEzG;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAE9C,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,qBAAqB,GAAG,0BAA0B,CAAC,CAAC;IAK1G;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,4BAAiC,GAAG,OAAO,CAAC,uBAAuB,CAAC,qBAAqB,GAAG,0BAA0B,CAAC,CAAC;CAI/I"}

package/dist/resources/SdPlatformUserAnalyticsApi.d.ts

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

package/dist/resources/SdPlatformUserApi.d.ts

@@ -29,23 +29,23 @@ export declare class SdPlatformUserApi extends ResourcesApi {
     /**
      * Gets the specific user by id
      * @param id - user id.
-     * @param embed - embeddable resources.
+     * @param embed array of {@link SdPlatformUserGetEmbeddableFields} embeddable resources.
      */
     get<T = SdPlatformResponseUserMinimal>(id: string, embed?: Array<SdPlatformUserGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
     /**
      * Register a new user. If successful a registration confirmation email will be sent.
-     * @param body
+     * @param body {@link SdPlatformRequestUserRegister}
      */
     register(body: SdPlatformRequestUserRegister): Promise<SdPlatformPostResponse<void>>;
     /**
      * Query users.
-     * @param body
+     * @param body {@link SdPlatformUserQueryParameters}
      */
     query<T = SdPlatformResponseUserMinimal>(body?: SdPlatformUserQueryParameters): Promise<SdPlatformQueryResponse<T>>;
     /**
      * Patch a user.
      * @param id - the id of a user
-     * @param body - properties to patch
+     * @param body {@link SdPlatformRequestUserPatch} properties to patch
      */
     patch<T = SdPlatformResponseUserSelf>(id: string, body: SdPlatformRequestUserPatch | SdPlatformRequestUserPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
     /**
@@ -67,20 +67,20 @@ export declare class SdPlatformUserApi extends ResourcesApi {
     passwordReset(email: string): Promise<SdPlatformPostResponse<void>>;
     /**
      * Change password using token
-     * @param body
+     * @param body {@see SdPlatformRequestUserPasswordResetConfirm}
      */
     passwordResetConfirm(body: SdPlatformRequestUserPasswordResetConfirm): Promise<SdPlatformPostResponse<void>>;
     /**
      * 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: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>>>;
     /**
      * 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: string, refresh_token_id: string): Promise<SdPlatformDeleteResponse>;
 }

package/dist/resources/SdPlatformWebhookApi.d.ts

@@ -30,22 +30,22 @@ export declare class SdPlatformWebhookApi {
     }): SdPlatformSdkRequestConfig;
     /**
      * Webhook which notifies the platform of chargebee events.
-     * @param auth
-     * @param body
+     * @param auth {@link SdPlatformWebhookBasicAuth}
+     * @param body {@link SdPlatformRequestWebhookChargebeeEvent}
      * @returns
      */
     chargebeeEvent(auth: SdPlatformWebhookBasicAuth, body: SdPlatformRequestWebhookChargebeeEvent): Promise<SdPlatformPostResponse<void>>;
     /**
     * 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: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookModelMessage): Promise<SdPlatformPostResponse<void>>;
     /**
     * 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: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookNotification): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapediver/sdk.platform-api-sdk-v1",
-  "version": "2.12.8",
+  "version": "2.12.9",
   "description": "SDK to communicate with the Platform API version 1",
   "keywords": [
     "shapediver",