@stackfactor/client-api 1.1.140 → 1.1.143

package/dist/esm/users.d.ts

@@ -0,0 +1,206 @@
+/**
+ * Add a new API Token
+ * @param {string} name Name of the token
+ * @param {Date} expiration Expiration date of the token
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const addAPIToken: (name: string, expiration: Date, token: string) => Promise<object>;
+/**
+ * Confirm email address
+ * @param {string} validationCode The code was provided to the user in advance by email
+ * @returns {Promise<void>}
+ */
+export declare const confirmEmailAddress: (validationCode: string) => Promise<void>;
+/**
+ * Confirm phone number
+ * @param {string} validationCode The code was provided to the user in advance by email
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const confirmPhone: (validationCode: string, token: string) => Promise<object>;
+/**
+ * Generate confirmation code
+ * @param {string} phoneNumber Send confirmation code to the phone number
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const confirmPhoneGenerateCode: (phoneNumber: string, token: string) => Promise<object>;
+/**
+ * Create a new account (tenant). It returns a promise
+ * @param {string} email User's email address
+ * @param {string} firstName User's first name
+ * @param {string} lastName User's last name
+ * @param {string} password User's password
+ * @param {string} subSite Subsite where the new account will be created
+ * @param {string} inviteCode Invitation code received in advance from one of the account owners
+ * @returns {Promise<object>}
+ */
+export declare const createAccount: (email: string, firstName: string, lastName: string, password: string, subSite: string, inviteCode: string) => Promise<object>;
+/**
+ * Create a new user account. It returns a promise
+ * @param {string} email User's email address
+ * @param {string} firstName User's first name
+ * @param {string} lastName User's last name
+ * @param {string} password User's password
+ * @param {string} token Invitation token provided to the user
+ * @returns {Promise<object>}
+ */
+export declare const createUserAccount: (email: string, firstName: string, lastName: string, password: string, token: string) => Promise<object>;
+/**
+ * Delete an existing API token
+ * @param {string} token Expiration date of the token
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
+ */
+export declare const deleteAPIToken: (token: string, authToken: string) => Promise<string>;
+/**
+ * Delete existing users
+ * @param {string[]} userIds The ID of the users to be deleted
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const deleteUsers: (userIds: string[], token: string) => Promise<object>;
+/**
+ * Get all the API tokens
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const getAPITokens: (token: string) => Promise<object>;
+/**
+ * Get the specified user account by Id. It returns a promise
+ * @param {string} id Id of the user for which information is being requested
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const getUserById: (id: string, token: string) => Promise<object>;
+/**
+ * Get user information
+ * @param {string} userId User Id
+ * @param {string} category User information category
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const getUserInformation: (userId: string, category: string, token: string) => Promise<object>;
+/**
+ * Get the list of users
+ * @param {object} filter Filter to select the users. Ex: {firstName : "John"}
+ * @param {string[]} fields Fields to be loaded. Ex: ["firstName"]
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const getUsers: (filter: object, fields: string[], token: string) => Promise<object>;
+/**
+ * Invite other users to join the same account
+ * @param {string[]} invitees List of emails of the invitees
+ * @param {string} groupId The group the user should be added to
+ * @param {string} teamId The team the user should be added to
+ * @param {string} authToken Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const inviteUsers: (invitees: string[], groupId: string, teamId: string, authToken: string) => Promise<object>;
+/**
+ * Login using email and password. It returns a promise
+ * @param {string} email User's email address
+ * @param {string} password User's password
+ * @returns {Promise<object>}
+ */
+export declare const login: (email: string, password: string) => Promise<object>;
+/**
+ * Login callback after authentication to exchange the code token for authentication and refresh tokens
+ * @param {string} code
+ * @param {string} codeVerifier
+ * @param {string} redirectUri
+ * @returns {Promise<object>}
+ */
+export declare const loginExchangeKeys: (code: string, codeVerifier: string, redirectUri: string) => Promise<object>;
+/**
+ * Logout from the server. It returns a promise
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const logout: (token: string) => Promise<object>;
+/**
+ * Checks the current auth token and maintain it alive. It returns a promise. In case the token is invalid
+ * a new token can be restablished using login
+ * @param {string} refreshToken User's auth token to be refreshed
+ * @returns {Promise<object>}
+ */
+export declare const refreshToken: (refreshToken: string) => Promise<object>;
+/**
+ * Remove an existing API token
+ * @param {string} id The ID of the token to be removed
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
+ */
+export declare const removeAPIToken: (id: string, authToken: string) => Promise<string>;
+/**
+ * Resend invitation emails
+ * @param {string[]} invitees List of emails of the invitees
+ * @param {string} authToken Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const resendInvitationEmails: (invitees: string[], authToken: string) => Promise<object>;
+/**
+ * Reset the password. It returns a promise
+ * @param {string} code Code provided to the user by email
+ * @param {string} email User's email address
+ * @param {string} password User's new password
+ * @returns {Promise<object>}
+ */
+export declare const resetPassword: (email: string, code: string, password: string) => Promise<object>;
+/**
+ * Send email confirmation code
+ * @param {string} email
+ * @param {string} token
+ * @returns {Promise<object>}
+ */
+export declare const sendEmailConfirmationCode: (email: string, token: string) => Promise<object>;
+/**
+ * Send an email to the user indicated by the email address to reset the password. It returns a promise
+ * @param {string} email Email of the user who needs to reset the password
+ * @returns {Promise<object>}
+ */
+export declare const sendPasswordResetNotification: (email: string) => Promise<object>;
+/**
+ * Set user profile information
+ * @param {string} userId User Id
+ * @param {string} category User information category
+ * @param {object} data New or updated user data information
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const setUserInformation: (userId: string, category: string, data: object, token: string) => Promise<object>;
+/**
+ * Update user email
+ * @param {string} email The new email address
+ * @param {string} verificationCode The verification code
+ * @param {string} password The current password
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const updateUserEmail: (email: string, verificationCode: string, password: string, token: string) => Promise<object>;
+/**
+ * Update user groups
+ * @param {String} userId The id of the user
+ * @param {Array<String>} groups The id of the groups the user should belong to
+ * @param {String} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const updateUserGroups: (userId: string, groups: string[], token: string) => Promise<object>;
+/**
+ * Update user password
+ * @param {String} password The current password
+ * @param {String} newPassword The new password
+ * @param {String} token Authorization token
+ * @returns {Promise<object>}
+ */
+export declare const updateUserPassword: (password: string, newPassword: string, token: string) => Promise<object>;
+/**
+ * Validate reset password code. It returns a promise
+ * @param {String} email User's email address
+ * @param {String} code Provided reset code
+ * @returns {Promise<object>}
+ */
+export declare const validateResetPasswordCode: (email: string, code: string) => Promise<object>;
+//# sourceMappingURL=users.d.ts.map

package/dist/esm/users.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/lib/users.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,SAAU,MAAM,cAAc,IAAI,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAyBzF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,mBAAoB,MAAM,KAAG,OAAO,CAAC,IAAI,CAiBxE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,mBAAoB,MAAM,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAoBlF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,gBAAiB,MAAM,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAoB3F,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,UACjB,MAAM,aACF,MAAM,YACP,MAAM,YACN,MAAM,WACP,MAAM,cACH,MAAM,KACjB,OAAO,CAAC,MAAM,CA8BhB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,UACrB,MAAM,aACF,MAAM,YACP,MAAM,YACN,MAAM,SACT,MAAM,KACZ,OAAO,CAAC,MAAM,CA4BhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,UAAW,MAAM,aAAa,MAAM,KAAG,OAAO,CAAC,MAAM,CAgB/E,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,YAAa,MAAM,EAAE,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAgB5E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,UAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAa1D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,OAAQ,MAAM,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAiBrE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,WAAY,MAAM,YAAY,MAAM,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAgBlG,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,WAAY,MAAM,UAAU,MAAM,EAAE,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAiBxF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,aAAc,MAAM,EAAE,WAAW,MAAM,UAAU,MAAM,aAAa,MAAM,KAAG,OAAO,CAAC,MAAM,CAmBlH,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,KAAK,UAAW,MAAM,YAAY,MAAM,KAAG,OAAO,CAAC,MAAM,CAerE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,SAAU,MAAM,gBAAgB,MAAM,eAAe,MAAM,KAAG,OAAO,CAAC,MAAM,CAgBzG,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,UAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAiBpD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,iBAAkB,MAAM,KAAG,OAAO,CAAC,MAAM,CAajE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,OAAQ,MAAM,aAAa,MAAM,KAAG,OAAO,CAAC,MAAM,CAoB5E,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,aAAc,MAAM,EAAE,aAAa,MAAM,KAAG,OAAO,CAAC,MAAM,CAiB5F,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,UAAW,MAAM,QAAQ,MAAM,YAAY,MAAM,KAAG,OAAO,CAAC,MAAM,CAgB3F,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,UAAW,MAAM,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAoBtF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,UAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAiB3E,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,WAAY,MAAM,YAAY,MAAM,QAAQ,MAAM,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAiBhH,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,UACnB,MAAM,oBACK,MAAM,YACd,MAAM,SACT,MAAM,KACZ,OAAO,CAAC,MAAM,CAsBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,WACnB,MAAM,UACN,MAAM,EAAE,SACT,MAAM,KACZ,OAAO,CAAC,MAAM,CAqBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,aACnB,MAAM,eACH,MAAM,SACZ,MAAM,KACZ,OAAO,CAAC,MAAM,CAqBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,UAC7B,MAAM,QACP,MAAM,KACX,OAAO,CAAC,MAAM,CAehB,CAAC"}