bruce-models 7.1.95 → 7.1.97

package/dist/types/account/account-invite.d.ts

@@ -23,10 +23,34 @@ export declare namespace AccountInvite {
         IsClosed?: boolean;
         Status: EStatus;
         "UserGroup.ID"?: string[];
+        SentTo?: string;
+        RequiresIdentity?: boolean;
+        IdentityProof?: EIdentityProof;
         InviteCode?: string;
         "Invited.User": User.IUser;
         "InvitedBy.User"?: User.IUser;
     }
+    /**
+     * One invited user's invitations, as returned by the grouped list.
+     */
+    interface IInviteGroup {
+        "Invited.User.ID": string;
+        "Invited.User"?: User.IUser;
+        "Invite.ID": number[];
+        OpenCount: number;
+        InviteMethod: EInviteMethod[];
+        "UserGroup.ID"?: string[];
+        "InviteCode.ExpiryTime"?: string;
+        SentTo?: string;
+        Items: IInvite[];
+    }
+    const ERROR_ALREADY_MEMBER = "AlreadyMember";
+    /**
+     * Returns whether a failed Create was refused because the user is already in the account.
+     * @param error the value thrown by Create.
+     * @returns
+     */
+    function IsAlreadyMemberError(error: any): boolean;
     /**
      * Possible invite statuses.
      */
@@ -35,7 +59,8 @@ export declare namespace AccountInvite {
         Cancelled = "Cancelled",
         Sent = "Sent",
         NotSent = "Not sent",
-        Accepted = "Accepted"
+        Accepted = "Accepted",
+        Superseded = "Superseded"
     }
     /**
      * Returns whether an invite is still awaiting a response from its recipient.
@@ -44,6 +69,13 @@ export declare namespace AccountInvite {
      * @returns
      */
     function IsPending(invite: IInvite): boolean;
+    /**
+     * Ways an invited user can prove they are who the invitation was addressed to.
+     */
+    enum EIdentityProof {
+        Password = "Password",
+        Session = "Session"
+    }
     /**
      * Possible invite methods.
      */
@@ -65,6 +97,54 @@ export declare namespace AccountInvite {
     }): Promise<{
         invite: IInvite;
     }>;
+    /**
+     * Returns one invite by its ID. Requires the session to be an account owner or admin.
+     * @param params
+     * @returns
+     */
+    function GetByID(params: {
+        api?: GuardianApi.Api;
+        id: number;
+        req?: Api.IReqParams;
+    }): Promise<{
+        invite: IInvite;
+    }>;
+    /**
+     * Returns a list of invites grouped by the invited user.
+     * Paging covers users rather than invites, so a user's invitations never straddle a page.
+     * @param params
+     * @returns
+     */
+    function GetListByUser(params: {
+        api?: GuardianApi.Api;
+        accountId?: string;
+        userId?: string;
+        status?: EStatus[];
+        expired?: boolean;
+        expandUsers?: boolean;
+        expandGroups?: boolean;
+        pageSize?: number;
+        pageIndex?: number;
+        req?: Api.IReqParams;
+    }): Promise<{
+        users: IInviteGroup[];
+        totalCount?: number;
+        hasNextPage?: boolean;
+        userGroups?: UserGroup.IGroup[];
+    }>;
+    /**
+     * Re-delivers an invitation that is still open, renewing its code and expiry.
+     * @param params
+     * @returns
+     */
+    function Resend(params: {
+        api?: GuardianApi.Api;
+        id: number;
+        emailTemplateKey?: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        invite: IInvite;
+    }>;
     /**
      * Returns a list of invites matching provided criteria.
      * For example you can get a list of invites for a specific account or user (or both).
@@ -79,6 +159,7 @@ export declare namespace AccountInvite {
         expired?: boolean;
         expandUsers?: boolean;
         expandGroups?: boolean;
+        groupByUser?: boolean;
         pageSize?: number;
         pageIndex?: number;
         req?: Api.IReqParams;
@@ -111,9 +192,10 @@ export declare namespace AccountInvite {
         api?: GuardianApi.Api;
         code?: string;
         id?: number;
-        status: EStatus | string;
+        status?: EStatus | string;
         groupIds?: string[];
         user?: User.IUser;
+        password?: string;
         req?: Api.IReqParams;
     }): Promise<{
         invite: IInvite;

package/dist/types/bruce-models.d.ts

@@ -117,4 +117,4 @@ export * from "./util/math-utils";
 export * from "./util/object-utils";
 export * from "./util/path-utils";
 export * from "./util/url-utils";
-export declare const VERSION = "7.1.95";
+export declare const VERSION = "7.1.97";

package/dist/types/user/user.d.ts

@@ -216,12 +216,10 @@ export declare namespace User {
          */
         function ForgotPassword(params: {
             api?: GuardianApi.Api;
-            accountId: string;
+            accountId?: string;
             email: string;
             req?: Api.IReqParams;
-        }): Promise<{
-            userId: string;
-        }>;
+        }): Promise<void>;
         /**
          * Completes password reset using a password reset code and new password.
          * @param params
@@ -230,7 +228,8 @@ export declare namespace User {
         function ForgotPasswordComplete(params: {
             api?: GuardianApi.Api;
             code: string;
-            userId: string;
+            email?: string;
+            userId?: string;
             password: string;
             req?: Api.IReqParams;
         }): Promise<{

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bruce-models",
-    "version": "7.1.95",
+    "version": "7.1.97",
     "description": "",
     "keywords": [],
     "main": "dist/bruce-models.umd.js",