@fonoster/sdk 0.9.15 → 0.9.19

package/dist/node/Users.d.ts

@@ -1,4 +1,4 @@
-import { BaseApiObject, CreateUserRequest, UpdateUserRequest, User } from "@fonoster/types";
+import { BaseApiObject, CreateUserRequest, ResetPasswordRequest, UpdateUserRequest, User } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
 /**
  * @classdesc Fonoster Users, part of the Fonoster Identity subsystem,
@@ -98,6 +98,45 @@ declare class Users {
      *   .catch(console.error); // an error occurred
      */
     updateUser(request: UpdateUserRequest): Promise<BaseApiObject>;
+    /**
+     * Sends a reset password code to the User.
+     *
+     * @param {string} username - The username of the User
+     * @return {Promise<void>} - The response object that contains the reference to the User
+     * @example
+     * const users = new SDK.Users(client); // Existing client object
+     *
+     * const username = "john.doe@example.com";
+     *
+     * users
+     *   .sendResetPasswordCode(username)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
+     */
+    sendResetPasswordCode(username: string): Promise<BaseApiObject>;
+    /**
+     * Resets the password of the User.
+     *
+     * @param {ResetPasswordRequest} request - The request object that contains the necessary information to reset the password of a User
+     * @param {string} request.username - The username of the User
+     * @param {string} request.password - The new password of the User
+     * @param {string} request.verificationCode - The verification code of the User
+     * @return {Promise<void>} - The response object that contains the reference to the User
+     * @example
+     * const users = new SDK.Users(client); // Existing client object
+     *
+     * const request = {
+     *   username: "john.doe@example.com",
+     *   password: "password",
+     *   verificationCode: "123456"
+     * };
+     *
+     * users
+     *   .resetPassword(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
+     */
+    resetPassword(request: ResetPasswordRequest): Promise<void>;
     /**
      * Deletes an existing User from Fonoster.
      * Note that this operation is irreversible.

package/dist/node/Users.js

@@ -127,6 +127,61 @@ class Users {
             request
         });
     }
+    /**
+     * Sends a reset password code to the User.
+     *
+     * @param {string} username - The username of the User
+     * @return {Promise<void>} - The response object that contains the reference to the User
+     * @example
+     * const users = new SDK.Users(client); // Existing client object
+     *
+     * const username = "john.doe@example.com";
+     *
+     * users
+     *   .sendResetPasswordCode(username)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
+     */
+    async sendResetPasswordCode(username) {
+        const client = this.client.getIdentityClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.sendResetPasswordCode.bind(client),
+            requestPBObjectConstructor: identity_pb_1.SendResetPasswordCodeRequest,
+            metadata: this.client.getMetadata(),
+            request: { username }
+        });
+    }
+    /**
+     * Resets the password of the User.
+     *
+     * @param {ResetPasswordRequest} request - The request object that contains the necessary information to reset the password of a User
+     * @param {string} request.username - The username of the User
+     * @param {string} request.password - The new password of the User
+     * @param {string} request.verificationCode - The verification code of the User
+     * @return {Promise<void>} - The response object that contains the reference to the User
+     * @example
+     * const users = new SDK.Users(client); // Existing client object
+     *
+     * const request = {
+     *   username: "john.doe@example.com",
+     *   password: "password",
+     *   verificationCode: "123456"
+     * };
+     *
+     * users
+     *   .resetPassword(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
+     */
+    async resetPassword(request) {
+        const client = this.client.getIdentityClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.resetPassword.bind(client),
+            requestPBObjectConstructor: identity_pb_1.ResetPasswordRequest,
+            metadata: this.client.getMetadata(),
+            request
+        });
+    }
     /**
      * Deletes an existing User from Fonoster.
      * Note that this operation is irreversible.

package/dist/node/Workspaces.d.ts

@@ -1,4 +1,4 @@
-import { BaseApiObject, CreateWorkspaceRequest, InviteUserToWorkspaceRequest, ListWorkspacesResponse, RemoveUserFromWorkspaceResponse, ResendWorkspaceMembershipInvitationResponse, UpdateWorkspaceRequest, Workspace } from "@fonoster/types";
+import { BaseApiObject, CreateWorkspaceRequest, InviteUserToWorkspaceRequest, ListWorkspacesResponse, ListWorkspaceMembersRequest, ListWorkspaceMembersResponse, RemoveUserFromWorkspaceResponse, ResendWorkspaceMembershipInvitationResponse, UpdateWorkspaceRequest, Workspace } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
 /**
  * @classdesc Fonoster Workspaces, part of the Fonoster Identity subsystem,
@@ -117,7 +117,7 @@ declare class Workspaces {
      */
     deleteWorkspace(ref: string): Promise<BaseApiObject>;
     /**
-     * Retrieves a list of Workspaces from a Workspace.
+     * Retrieves a list of all Workspaces for the logged in user.
      *
      * @return {Promise<ListWorkspacesResponse>} - The response object that contains the list of Workspaces
      * @example
@@ -169,6 +169,27 @@ declare class Workspaces {
      *   .catch(console.error); // an error occurred
      */
     resendWorkspaceMembershipInvitation(userRef: string): Promise<ResendWorkspaceMembershipInvitationResponse>;
+    /**
+     * List the members of a Workspace
+     *
+     * @param {ListWorkspaceMembersRequest} request - Request object to list the members of a Workspace
+     * @param {number} request.pageSize - The number of members to return in the response
+     * @param {string} request.pageToken - The page token to return the next page of members
+     * @return {Promise<ListWorkspaceMembersResponse>} - The response object that contains the list of members
+     * @example
+     * const workspaces = new SDK.Workspaces(client); // Existing client object
+     *
+     * const request = {
+     *   pageSize: 10,
+     *   pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * workspaces
+     *   .listWorkspaceMembers(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
+     */
+    listWorkspaceMembers(request: ListWorkspaceMembersRequest): Promise<ListWorkspaceMembersResponse>;
     /**
      * Removes a User from a Workspace.
      *

package/dist/node/Workspaces.js

@@ -154,7 +154,7 @@ class Workspaces {
         });
     }
     /**
-     * Retrieves a list of Workspaces from a Workspace.
+     * Retrieves a list of all Workspaces for the logged in user.
      *
      * @return {Promise<ListWorkspacesResponse>} - The response object that contains the list of Workspaces
      * @example
@@ -231,6 +231,36 @@ class Workspaces {
             request: { userRef }
         });
     }
+    /**
+     * List the members of a Workspace
+     *
+     * @param {ListWorkspaceMembersRequest} request - Request object to list the members of a Workspace
+     * @param {number} request.pageSize - The number of members to return in the response
+     * @param {string} request.pageToken - The page token to return the next page of members
+     * @return {Promise<ListWorkspaceMembersResponse>} - The response object that contains the list of members
+     * @example
+     * const workspaces = new SDK.Workspaces(client); // Existing client object
+     *
+     * const request = {
+     *   pageSize: 10,
+     *   pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * workspaces
+     *   .listWorkspaceMembers(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
+     */
+    async listWorkspaceMembers(request) {
+        const client = this.client.getIdentityClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.listWorkspaceMembers.bind(client),
+            requestPBObjectConstructor: identity_pb_1.ListWorkspaceMembersRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            repeatableObjectMapping: [["itemsList", identity_pb_1.WorkspaceMember]]
+        });
+    }
     /**
      * Removes a User from a Workspace.
      *

package/dist/node/client/types/IdentityClient.d.ts

@@ -1,4 +1,4 @@
-import { CreateApiKeyRequest, CreateApiKeyResponse, CreateUserRequest, CreateUserResponse, CreateWorkspaceRequest, DeleteApiKeyRequest, DeleteApiKeyResponse, DeleteUserRequest, DeleteUserResponse, DeleteWorkspaceRequest, DeleteWorkspaceResponse, ExchangeApiKeyRequest, ExchangeApiKeyResponse, ExchangeCredentialsRequest, ExchangeCredentialsResponse, ExchangeOauth2CodeRequest, ExchangeOauth2CodeResponse, ExchangeRefreshTokenRequest, ExchangeRefreshTokenResponse, GetUserRequest, GetWorkspaceRequest, InviteUserToWorkspaceRequest, InviteUserToWorkspaceResponse, ListApiKeysRequest, ListApiKeysResponse, ListWorkspacesRequest, ListWorkspacesResponse, RegenerateApiKeyRequest, RegenerateApiKeyResponse, RemoveUserFromWorkspaceRequest, RemoveUserFromWorkspaceResponse, ResendWorkspaceMembershipInvitationRequest, ResendWorkspaceMembershipInvitationResponse, SendVerificationCodeRequest, UpdateUserRequest, UpdateWorkspaceRequest, UpdateWorkspaceResponse, User, VerifyCodeRequest, Workspace } from "../../generated/web/identity_pb";
+import { CreateApiKeyRequest, CreateApiKeyResponse, CreateUserRequest, CreateUserResponse, CreateWorkspaceRequest, DeleteApiKeyRequest, DeleteApiKeyResponse, DeleteUserRequest, DeleteUserResponse, DeleteWorkspaceRequest, DeleteWorkspaceResponse, ExchangeApiKeyRequest, ExchangeApiKeyResponse, ExchangeCredentialsRequest, ExchangeCredentialsResponse, ExchangeOauth2CodeRequest, ExchangeOauth2CodeResponse, ExchangeRefreshTokenRequest, ExchangeRefreshTokenResponse, GetUserRequest, GetWorkspaceRequest, InviteUserToWorkspaceRequest, InviteUserToWorkspaceResponse, ListApiKeysRequest, ListApiKeysResponse, ListWorkspacesRequest, ListWorkspacesResponse, RegenerateApiKeyRequest, RegenerateApiKeyResponse, RemoveUserFromWorkspaceRequest, RemoveUserFromWorkspaceResponse, ResendWorkspaceMembershipInvitationRequest, ResendWorkspaceMembershipInvitationResponse, ListWorkspaceMembersRequest, ListWorkspaceMembersResponse, SendVerificationCodeRequest, SendResetPasswordCodeRequest, ResetPasswordRequest, UpdateUserRequest, UpdateWorkspaceRequest, UpdateWorkspaceResponse, User, VerifyCodeRequest, Workspace } from "../../generated/web/identity_pb";
 import { ClientFunction } from "../types";
 type IdentityClient = {
     createApiKey: ClientFunction<CreateApiKeyRequest, CreateApiKeyResponse>;
@@ -15,12 +15,15 @@ type IdentityClient = {
     deleteUser: ClientFunction<DeleteUserRequest, DeleteUserResponse>;
     sendVerificationCode: ClientFunction<SendVerificationCodeRequest, never>;
     verifyCode: ClientFunction<VerifyCodeRequest, never>;
+    sendResetPasswordCode: ClientFunction<SendResetPasswordCodeRequest, never>;
+    resetPassword: ClientFunction<ResetPasswordRequest, never>;
     createWorkspace: ClientFunction<CreateWorkspaceRequest, CreateUserResponse>;
     getWorkspace: ClientFunction<GetWorkspaceRequest, Workspace>;
     listWorkspaces: ClientFunction<ListWorkspacesRequest, ListWorkspacesResponse>;
     updateWorkspace: ClientFunction<UpdateWorkspaceRequest, UpdateWorkspaceResponse>;
     inviteUserToWorkspace: ClientFunction<InviteUserToWorkspaceRequest, InviteUserToWorkspaceResponse>;
     resendWorkspaceMembershipInvitation: ClientFunction<ResendWorkspaceMembershipInvitationRequest, ResendWorkspaceMembershipInvitationResponse>;
+    listWorkspaceMembers: ClientFunction<ListWorkspaceMembersRequest, ListWorkspaceMembersResponse>;
     removeUserFromWorkspace: ClientFunction<RemoveUserFromWorkspaceRequest, RemoveUserFromWorkspaceResponse>;
     deleteWorkspace: ClientFunction<DeleteWorkspaceRequest, DeleteWorkspaceResponse>;
 };

package/dist/node/generated/node/identity_grpc_pb.js

@@ -430,6 +430,17 @@ function deserialize_fonoster_identity_v1beta2_ResendWorkspaceMembershipInvitati
   return identity_pb.ResendWorkspaceMembershipInvitationResponse.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
+function serialize_fonoster_identity_v1beta2_ResetPasswordRequest(arg) {
+  if (!(arg instanceof identity_pb.ResetPasswordRequest)) {
+    throw new Error('Expected argument of type fonoster.identity.v1beta2.ResetPasswordRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_fonoster_identity_v1beta2_ResetPasswordRequest(buffer_arg) {
+  return identity_pb.ResetPasswordRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_fonoster_identity_v1beta2_RevokeTokenRequest(arg) {
   if (!(arg instanceof identity_pb.RevokeTokenRequest)) {
     throw new Error('Expected argument of type fonoster.identity.v1beta2.RevokeTokenRequest');
@@ -452,6 +463,17 @@ function deserialize_fonoster_identity_v1beta2_RevokeTokenResponse(buffer_arg) {
   return identity_pb.RevokeTokenResponse.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
+function serialize_fonoster_identity_v1beta2_SendResetPasswordCodeRequest(arg) {
+  if (!(arg instanceof identity_pb.SendResetPasswordCodeRequest)) {
+    throw new Error('Expected argument of type fonoster.identity.v1beta2.SendResetPasswordCodeRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_fonoster_identity_v1beta2_SendResetPasswordCodeRequest(buffer_arg) {
+  return identity_pb.SendResetPasswordCodeRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_fonoster_identity_v1beta2_SendVerificationCodeRequest(arg) {
   if (!(arg instanceof identity_pb.SendVerificationCodeRequest)) {
     throw new Error('Expected argument of type fonoster.identity.v1beta2.SendVerificationCodeRequest');
@@ -720,6 +742,28 @@ createUser: {
     responseSerialize: serialize_google_protobuf_Empty,
     responseDeserialize: deserialize_google_protobuf_Empty,
   },
+  sendResetPasswordCode: {
+    path: '/fonoster.identity.v1beta2.Identity/SendResetPasswordCode',
+    requestStream: false,
+    responseStream: false,
+    requestType: identity_pb.SendResetPasswordCodeRequest,
+    responseType: google_protobuf_empty_pb.Empty,
+    requestSerialize: serialize_fonoster_identity_v1beta2_SendResetPasswordCodeRequest,
+    requestDeserialize: deserialize_fonoster_identity_v1beta2_SendResetPasswordCodeRequest,
+    responseSerialize: serialize_google_protobuf_Empty,
+    responseDeserialize: deserialize_google_protobuf_Empty,
+  },
+  resetPassword: {
+    path: '/fonoster.identity.v1beta2.Identity/ResetPassword',
+    requestStream: false,
+    responseStream: false,
+    requestType: identity_pb.ResetPasswordRequest,
+    responseType: google_protobuf_empty_pb.Empty,
+    requestSerialize: serialize_fonoster_identity_v1beta2_ResetPasswordRequest,
+    requestDeserialize: deserialize_fonoster_identity_v1beta2_ResetPasswordRequest,
+    responseSerialize: serialize_google_protobuf_Empty,
+    responseDeserialize: deserialize_google_protobuf_Empty,
+  },
   // ApiKey actions
 createApiKey: {
     path: '/fonoster.identity.v1beta2.Identity/CreateApiKey',