@icure/cardinal-sdk 2.1.0 → 2.1.2

package/model/Group.mjs

@@ -7,25 +7,97 @@ import { AuthenticationClass } from './embed/AuthenticationClass.mjs';
 import { UserType } from './embed/UserType.mjs';
 import { ExternalJwtConfig } from './security/ExternalJwtConfig.mjs';
 import { OperationToken } from './security/OperationToken.mjs';
+/**
+ *
+ *  Represents a group in the iCure platform. A group corresponds to a practice, hospital, or
+ *  organization
+ *  that contains its own set of databases and users.
+ *  /
+ */
 export class Group {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the group in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  Tags that qualify the group as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Tags that are publicly visible for the group.
+         */
         this.publicTags = [];
+        /**
+         *
+         *  Username for the group.
+         */
         this.name = undefined;
+        /**
+         *
+         *  Password for the group access.
+         */
         this.password = undefined;
+        /**
+         *
+         *  List of servers accessible to the group.
+         */
         this.servers = undefined;
+        /**
+         *
+         *  Whether the group has a super admin permission.
+         */
         this.superAdmin = false;
+        /**
+         *
+         *  Extra properties for the group. Those properties are typed (see class Property).
+         */
         this.properties = [];
+        /**
+         *
+         *  The default roles for each user type, if not otherwise specified on the user.
+         */
         this.defaultUserRoles = {};
+        /**
+         *
+         *  Single-used token to perform specific operations.
+         */
         this.operationTokens = {};
+        /**
+         *
+         *  List of entities that have to be collected from a shared database.
+         */
         this.sharedEntities = {};
+        /**
+         *
+         *  Minimum version of Kraken required to access API.
+         */
         this.minimumKrakenVersion = undefined;
+        /**
+         *
+         *  Verified public keys that can be used to allow log in with external JWTs.
+         */
         this.externalJwtConfig = {};
+        /**
+         *
+         *  The id of the parent super group, if any.
+         */
         this.superGroup = undefined;
+        /**
+         *
+         *  A user-chosen identifier for the applications for which this group holds data.
+         */
         this.projectId = undefined;
+        this.templates = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)
             this.rev = partial.rev;
@@ -60,6 +132,8 @@ export class Group {
             this.superGroup = partial.superGroup;
         if ('projectId' in partial)
             this.projectId = partial.projectId;
+        if ('templates' in partial)
+            this.templates = partial.templates;
     }
     toJSON() {
         const res = {};
@@ -89,6 +163,8 @@ export class Group {
             res['superGroup'] = this.superGroup;
         if (this.projectId != undefined)
             res['projectId'] = this.projectId;
+        if (this.templates != undefined)
+            res['templates'] = this.templates.toJSON();
         return res;
     }
     static fromJSON(json, ignoreUnknownKeys = false, path = ['Group']) {
@@ -114,6 +190,7 @@ export class Group {
             minimumAuthenticationClassForElevatedPrivileges: expectStringEnum(extractEntry(jCpy, 'minimumAuthenticationClassForElevatedPrivileges', true, path), false, [...path, ".minimumAuthenticationClassForElevatedPrivileges"], AuthenticationClass, 'AuthenticationClass'),
             superGroup: expectString(extractEntry(jCpy, 'superGroup', false, path), true, [...path, ".superGroup"]),
             projectId: expectString(extractEntry(jCpy, 'projectId', false, path), true, [...path, ".projectId"]),
+            templates: expectObject(extractEntry(jCpy, 'templates', false, path), true, ignoreUnknownKeys, [...path, ".templates"], Group.TemplatesConfiguration.fromJSON),
         });
         if (!ignoreUnknownKeys) {
             const unused = Object.keys(jCpy);
@@ -123,3 +200,66 @@ export class Group {
         return res;
     }
 }
+(function (Group) {
+    class TemplatesConfiguration {
+        constructor(partial) {
+            this.emailSender = undefined;
+            this.smsSender = undefined;
+            this.emailVerificationTemplateId = undefined;
+            this.mobilePhoneVerificationTemplateId = undefined;
+            this.existingEmailNotificationTemplateId = undefined;
+            this.existingMobilePhoneNotificationTemplateId = undefined;
+            this.specId = partial.specId;
+            if ('emailSender' in partial)
+                this.emailSender = partial.emailSender;
+            if ('smsSender' in partial)
+                this.smsSender = partial.smsSender;
+            if ('emailVerificationTemplateId' in partial)
+                this.emailVerificationTemplateId = partial.emailVerificationTemplateId;
+            if ('mobilePhoneVerificationTemplateId' in partial)
+                this.mobilePhoneVerificationTemplateId = partial.mobilePhoneVerificationTemplateId;
+            if ('existingEmailNotificationTemplateId' in partial)
+                this.existingEmailNotificationTemplateId = partial.existingEmailNotificationTemplateId;
+            if ('existingMobilePhoneNotificationTemplateId' in partial)
+                this.existingMobilePhoneNotificationTemplateId = partial.existingMobilePhoneNotificationTemplateId;
+        }
+        toJSON() {
+            const res = {};
+            res['specId'] = this.specId;
+            if (this.emailSender != undefined)
+                res['emailSender'] = this.emailSender;
+            if (this.smsSender != undefined)
+                res['smsSender'] = this.smsSender;
+            if (this.emailVerificationTemplateId != undefined)
+                res['emailVerificationTemplateId'] = this.emailVerificationTemplateId;
+            if (this.mobilePhoneVerificationTemplateId != undefined)
+                res['mobilePhoneVerificationTemplateId'] = this.mobilePhoneVerificationTemplateId;
+            if (this.existingEmailNotificationTemplateId != undefined)
+                res['existingEmailNotificationTemplateId'] = this.existingEmailNotificationTemplateId;
+            if (this.existingMobilePhoneNotificationTemplateId != undefined)
+                res['existingMobilePhoneNotificationTemplateId'] = this.existingMobilePhoneNotificationTemplateId;
+            return res;
+        }
+        static fromJSON(json, ignoreUnknownKeys = false, path = ['TemplatesConfiguration']) {
+            if (typeof json != 'object')
+                throw new Error(`Expected json object at path ${path.join("")}`);
+            const jCpy = Object.assign({}, json);
+            const res = new TemplatesConfiguration({
+                specId: expectString(extractEntry(jCpy, 'specId', true, path), false, [...path, ".specId"]),
+                emailSender: expectString(extractEntry(jCpy, 'emailSender', false, path), true, [...path, ".emailSender"]),
+                smsSender: expectString(extractEntry(jCpy, 'smsSender', false, path), true, [...path, ".smsSender"]),
+                emailVerificationTemplateId: expectString(extractEntry(jCpy, 'emailVerificationTemplateId', false, path), true, [...path, ".emailVerificationTemplateId"]),
+                mobilePhoneVerificationTemplateId: expectString(extractEntry(jCpy, 'mobilePhoneVerificationTemplateId', false, path), true, [...path, ".mobilePhoneVerificationTemplateId"]),
+                existingEmailNotificationTemplateId: expectString(extractEntry(jCpy, 'existingEmailNotificationTemplateId', false, path), true, [...path, ".existingEmailNotificationTemplateId"]),
+                existingMobilePhoneNotificationTemplateId: expectString(extractEntry(jCpy, 'existingMobilePhoneNotificationTemplateId', false, path), true, [...path, ".existingMobilePhoneNotificationTemplateId"]),
+            });
+            if (!ignoreUnknownKeys) {
+                const unused = Object.keys(jCpy);
+                if (unused.length > 0)
+                    throw new Error(`Unexpected key(s) for json object TemplatesConfiguration at path ${path.join("")}: ${unused}`);
+            }
+            return res;
+        }
+    }
+    Group.TemplatesConfiguration = TemplatesConfiguration;
+})(Group || (Group = {}));

package/model/GroupDeletionReport.d.mts

@@ -1,6 +1,23 @@
+/**
+ *
+ *
+ *   DTO representing a report generated after a group deletion operation.
+ */
 export declare class GroupDeletionReport {
+    /**
+     *
+     *  The type of the deleted resource.
+     */
     type: string;
+    /**
+     *
+     *  The unique identifier of the deleted group.
+     */
     id: string;
+    /**
+     *
+     *  The server on which the group was deleted.
+     */
     server: string;
     constructor(partial: Partial<GroupDeletionReport> & Pick<GroupDeletionReport, "type" | "server">);
     toJSON(): object;

package/model/GroupDeletionReport.mjs

@@ -1,6 +1,11 @@
 // auto-generated file
 import { expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
+/**
+ *
+ *
+ *   DTO representing a report generated after a group deletion operation.
+ */
 export class GroupDeletionReport {
     constructor(partial) {
         var _a;

package/model/GroupScoped.d.mts

@@ -1,3 +1,13 @@
+/**
+ *
+ *  Wraps an entity and associates it with the group it exists in.
+ *
+ *  In-group api methods take in input and return group scoped entities.
+ *
+ *  To prevent mistakes, you shouldn't instantiate this class yourself, instead you should always get the GroupScoped
+ *  entity from the `inGroup` methods of the apis. Using GroupScoped entities with the wrong groupId, or created by
+ *  instances of the SDK working on a different base group, can cause errors and other unexpected behavior.
+ */
 export declare class GroupScoped<E> {
     entity: E;
     groupId: string;

package/model/GroupScoped.mjs

@@ -1,4 +1,14 @@
 // auto-generated file
+/**
+ *
+ *  Wraps an entity and associates it with the group it exists in.
+ *
+ *  In-group api methods take in input and return group scoped entities.
+ *
+ *  To prevent mistakes, you shouldn't instantiate this class yourself, instead you should always get the GroupScoped
+ *  entity from the `inGroup` methods of the apis. Using GroupScoped entities with the wrong groupId, or created by
+ *  instances of the SDK working on a different base group, can cause errors and other unexpected behavior.
+ */
 export class GroupScoped {
     constructor(partial) {
         this.entity = partial.entity;