@cubist-labs/cubesigner-sdk 0.3.1 → 0.3.8

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cubist-labs/cubesigner-sdk",
-    "version": "0.3.1",
+    "version": "0.3.8",
     "description": "CubeSigner TypeScript SDK",
     "license": "MIT OR Apache-2.0",
     "author": "Cubist, Inc.",

package/dist/cjs/src/api.d.ts

@@ -1,7 +1,7 @@
 import createClient, { FetchOptions, FetchResponse, FilterKeys, HttpMethod, PathsWith } from "openapi-fetch";
 import { paths, operations } from "./schema";
 import { SignerSessionData, SignerSessionLifetime, SignerSessionManager } from "./session/signer_session_manager";
-import { CreateOidcUserOptions, IdentityProof, KeyInRoleInfo, KeyInfoApi, ListKeysResponse, ListRoleKeysResponse, ListRoleUsersResponse, ListRolesResponse, OidcIdentity, SessionsResponse, PublicKeyCredential, RoleInfo, UpdateKeyRequest, UpdateOrgRequest, UpdateOrgResponse, UpdateRoleRequest, UserIdInfo, UserInRoleInfo, UserInfo, SessionInfo, OrgInfo, RatchetConfig, Eip191SignRequest, Eip712SignRequest, Eip191Or712SignResponse, EvmSignRequest, EvmSignResponse, Eth2SignRequest, Eth2SignResponse, Eth2StakeRequest, Eth2StakeResponse, Eth2UnstakeRequest, Eth2UnstakeResponse, BlobSignRequest, BlobSignResponse, BtcSignResponse, BtcSignRequest, SolanaSignRequest, SolanaSignResponse, AvaSignResponse, AvaTx, MfaRequestInfo, MemberRole, UserExportCompleteResponse, UserExportInitResponse, UserExportListResponse, Empty } from "./schema_types";
+import { CreateOidcUserOptions, IdentityProof, KeyInRoleInfo, KeyInfoApi, ListKeysResponse, ListKeyRolesResponse, ListRoleKeysResponse, ListRoleUsersResponse, ListRolesResponse, OidcIdentity, SessionsResponse, PublicKeyCredential, RoleInfo, UpdateKeyRequest, UpdateOrgRequest, UpdateOrgResponse, UpdateRoleRequest, UserIdInfo, UserInRoleInfo, UserInfo, SessionInfo, OrgInfo, RatchetConfig, Eip191SignRequest, Eip712SignRequest, Eip191Or712SignResponse, EvmSignRequest, EvmSignResponse, Eth2SignRequest, Eth2SignResponse, Eth2StakeRequest, Eth2StakeResponse, Eth2UnstakeRequest, Eth2UnstakeResponse, BlobSignRequest, BlobSignResponse, BtcSignResponse, BtcSignRequest, SolanaSignRequest, SolanaSignResponse, AvaSignResponse, AvaTx, MfaRequestInfo, MfaVote, MemberRole, UserExportCompleteResponse, UserExportInitResponse, UserExportListResponse, Empty } from "./schema_types";
 import { AddFidoChallenge, MfaFidoChallenge, MfaReceipt, TotpChallenge } from "./mfa";
 import { CubeSignerResponse } from "./response";
 import { Key, KeyType } from "./key";
@@ -241,6 +241,14 @@ export declare class CubeSignerApi {
      * @return {KeyInfoApi} The key information.
      */
     keyGet(keyId: string): Promise<KeyInfoApi>;
+    /**
+     * List all roles a key is in.
+     *
+     * @param {string} keyId The id of the key to get.
+     * @param {PageOpts} page Pagination options. Defaults to fetching the entire result set.
+     * @return {Paginator<ListKeyRolesResponse, KeyInRoleInfo>} Paginator for iterating over the roles a key is in.
+     */
+    keyRolesList(keyId: string, page?: PageOpts): Paginator<ListKeyRolesResponse, KeyInRoleInfo>;
     /**
      * Update key.
      * @param {string} keyId The ID of the key to update.
@@ -346,6 +354,13 @@ export declare class CubeSignerApi {
      * @param {string} userId The ID of the user to add to the role.
      */
     roleUserAdd(roleId: string, userId: string): Promise<void>;
+    /**
+     * Remove an existing user from an existing role.
+     *
+     * @param {string} roleId The ID of the role.
+     * @param {string} userId The ID of the user to remove from the role.
+     */
+    roleUserRemove(roleId: string, userId: string): Promise<void>;
     /**
      * List all users in a role.
      *
@@ -418,20 +433,22 @@ export declare class CubeSignerApi {
      */
     mfaList(): Promise<MfaRequestInfo[]>;
     /**
-     * Approve a pending MFA request using the current session.
+     * Approve or reject a pending MFA request using the current session.
      *
      * @param {string} mfaId The id of the MFA request
+     * @param {MfaVote} mfaVote Approve or reject the MFA request
      * @return {Promise<MfaRequestInfo>} The result of the MFA request
      */
-    mfaApprove(mfaId: string): Promise<MfaRequestInfo>;
+    mfaVoteCs(mfaId: string, mfaVote: MfaVote): Promise<MfaRequestInfo>;
     /**
-     * Approve a pending MFA request using TOTP.
+     * Approve or reject a pending MFA request using TOTP.
      *
-     * @param {string} mfaId The MFA request to approve
+     * @param {string} mfaId The ID of the MFA request
      * @param {string} code The TOTP code
+     * @param {MfaVote} mfaVote Approve or reject the MFA request
      * @return {Promise<MfaRequestInfo>} The current status of the MFA request
      */
-    mfaApproveTotp(mfaId: string, code: string): Promise<MfaRequestInfo>;
+    mfaVoteTotp(mfaId: string, code: string, mfaVote: MfaVote): Promise<MfaRequestInfo>;
     /**
      * Initiate approval of an existing MFA request using FIDO. A challenge is
      * returned which must be answered via {@link MfaFidoChallenge.answer} or {@link mfaApproveFidoComplete}.
@@ -439,19 +456,20 @@ export declare class CubeSignerApi {
      * @param {string} mfaId The MFA request ID.
      * @return {Promise<MfaFidoChallenge>} A challenge that needs to be answered to complete the approval.
      */
-    mfaApproveFidoInit(mfaId: string): Promise<MfaFidoChallenge>;
+    mfaFidoInit(mfaId: string): Promise<MfaFidoChallenge>;
     /**
-     * Complete a previously initiated (via {@link mfaApproveFidoInit}) MFA request approval using FIDO.
+     * Complete a previously initiated (via {@link mfaApproveFidoInit}) MFA request using FIDO.
      *
      * Instead of calling this method directly, prefer {@link MfaFidoChallenge.answer} or
      * {@link MfaFidoChallenge.createCredentialAndAnswer}.
      *
      * @param {string} mfaId The MFA request ID
+     * @param {MfaVote} mfaVote Approve or reject the MFA request
      * @param {string} challengeId The ID of the challenge issued by {@link mfaApproveFidoInit}
      * @param {PublicKeyCredential} credential The answer to the challenge
      * @return {Promise<MfaRequestInfo>} The current status of the MFA request.
      */
-    mfaApproveFidoComplete(mfaId: string, challengeId: string, credential: PublicKeyCredential): Promise<MfaRequestInfo>;
+    mfaVoteFidoComplete(mfaId: string, mfaVote: MfaVote, challengeId: string, credential: PublicKeyCredential): Promise<MfaRequestInfo>;
     /**
      * Sign an EVM transaction.
      * @param {Key | string} key The key to sign with (either {@link Key} or its material ID).