@dynamic-labs/sdk-api 0.0.864 → 0.0.869

package/src/apis/WaasApi.cjs

@@ -124,7 +124,8 @@ require('../models/WalletTransactionType.cjs');
  */
 class WaasApi extends runtime.BaseAPI {
     /**
-     * Authenticate for WAAS using api key
+     * Authenticates for WaaS using an API key.
+     * Authenticate for WAAS using an API key
      */
     authenticateWaasRaw(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -150,7 +151,8 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Authenticate for WAAS using api key
+     * Authenticates for WaaS using an API key.
+     * Authenticate for WAAS using an API key
      */
     authenticateWaas(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -204,6 +206,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Creates new encryption public key credentials for WaaS wallet delegation.
      * Create credentials for waas wallet delegation
      */
     createDelegatedCredentialsRaw(requestParameters, initOverrides) {
@@ -228,6 +231,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Creates new encryption public key credentials for WaaS wallet delegation.
      * Create credentials for waas wallet delegation
      */
     createDelegatedCredentials(requestParameters, initOverrides) {
@@ -237,6 +241,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Creates a new WaaS policy for the specified environment.
      * Create a new WAAS policy for an environment or add new rules to an existing policy
      */
     createWaasPolicyRaw(requestParameters, initOverrides) {
@@ -261,6 +266,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Creates a new WaaS policy for the specified environment.
      * Create a new WAAS policy for an environment or add new rules to an existing policy
      */
     createWaasPolicy(requestParameters, initOverrides) {
@@ -270,6 +276,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Creates a new WaaS signature policy for the specified wallet.
      * Create a new WAAS signature policy for a wallet
      */
     createWaasSignaturePolicyRaw(requestParameters, initOverrides) {
@@ -297,6 +304,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Creates a new WaaS signature policy for the specified wallet.
      * Create a new WAAS signature policy for a wallet
      */
     createWaasSignaturePolicy(requestParameters, initOverrides) {
@@ -307,7 +315,7 @@ class WaasApi extends runtime.BaseAPI {
     }
     /**
      * Creates a new WAAS wallet for a user given an email or userId. If an email is provided and it is not associated with an existing user this call will also create a new user.
-     * Create a new WAAS for a user given an identifier
+     * Create a WAAS wallet for a user
      */
     createWaasWalletRaw(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -339,7 +347,7 @@ class WaasApi extends runtime.BaseAPI {
     }
     /**
      * Creates a new WAAS wallet for a user given an email or userId. If an email is provided and it is not associated with an existing user this call will also create a new user.
-     * Create a new WAAS for a user given an identifier
+     * Create a WAAS wallet for a user
      */
     createWaasWallet(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -348,6 +356,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Signs a message using a delegated WaaS account.
      * Sign a message with a delegated waas account
      */
     delegatedSignMessageRaw(requestParameters, initOverrides) {
@@ -375,6 +384,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Signs a message using a delegated WaaS account.
      * Sign a message with a delegated waas account
      */
     delegatedSignMessage(requestParameters, initOverrides) {
@@ -416,6 +426,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified WaaS policy rule.
      * Delete a WAAS policy rule by ruleId
      */
     deleteWaasPolicyRaw(requestParameters, initOverrides) {
@@ -440,6 +451,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified WaaS policy rule.
      * Delete a WAAS policy rule by ruleId
      */
     deleteWaasPolicy(requestParameters, initOverrides) {
@@ -449,6 +461,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Permanently removes a WaaS signature policy by wallet ID and policy ID.
      * Delete a WAAS signature policy by walletId and policyId
      */
     deleteWaasSignaturePolicyByWalletIdAndPolicyIdRaw(requestParameters, initOverrides) {
@@ -474,6 +487,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Permanently removes a WaaS signature policy by wallet ID and policy ID.
      * Delete a WAAS signature policy by walletId and policyId
      */
     deleteWaasSignaturePolicyByWalletIdAndPolicyId(requestParameters, initOverrides) {
@@ -513,6 +527,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a delegated access encryption public key by its ID.
      * Get a specific delegated access encryption public key by ID
      */
     getDelegatedAccessEncryptionPublicKeyByIdRaw(requestParameters, initOverrides) {
@@ -535,6 +550,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a delegated access encryption public key by its ID.
      * Get a specific delegated access encryption public key by ID
      */
     getDelegatedAccessEncryptionPublicKeyById(requestParameters, initOverrides) {
@@ -577,6 +593,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns the WaaS policy for the specified environment.
      * Get the WAAS policy for an environment
      */
     getWaasPolicyRaw(requestParameters, initOverrides) {
@@ -596,6 +613,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns the WaaS policy for the specified environment.
      * Get the WAAS policy for an environment
      */
     getWaasPolicy(requestParameters, initOverrides) {
@@ -605,6 +623,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns all active WaaS signature policies for the specified wallet.
      * Get all active WAAS signature policies for a wallet
      */
     getWaasSignaturePoliciesRaw(requestParameters, initOverrides) {
@@ -627,6 +646,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns all active WaaS signature policies for the specified wallet.
      * Get all active WAAS signature policies for a wallet
      */
     getWaasSignaturePolicies(requestParameters, initOverrides) {
@@ -636,6 +656,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a WaaS signature policy by wallet ID and policy ID.
      * Get a WAAS signature policy by walletId and policyId
      */
     getWaasSignaturePolicyByWalletIdAndPolicyIdRaw(requestParameters, initOverrides) {
@@ -661,6 +682,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a WaaS signature policy by wallet ID and policy ID.
      * Get a WAAS signature policy by walletId and policyId
      */
     getWaasSignaturePolicyByWalletIdAndPolicyId(requestParameters, initOverrides) {
@@ -670,6 +692,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a WaaS wallet by its wallet ID.
      * Get a specific WAAS wallet by walletId
      */
     getWaasWalletByWalletIdRaw(requestParameters, initOverrides) {
@@ -692,6 +715,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a WaaS wallet by its wallet ID.
      * Get a specific WAAS wallet by walletId
      */
     getWaasWalletByWalletId(requestParameters, initOverrides) {
@@ -765,6 +789,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Updates the WaaS policy for the specified environment.
      * Update the WAAS policy for an environment by ruleId
      */
     updateWaasPolicyRaw(requestParameters, initOverrides) {
@@ -789,6 +814,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Updates the WaaS policy for the specified environment.
      * Update the WAAS policy for an environment by ruleId
      */
     updateWaasPolicy(requestParameters, initOverrides) {
@@ -798,6 +824,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Updates a WaaS signature policy by wallet ID and policy ID.
      * Update a WAAS signature policy by walletId and policyId
      */
     updateWaasSignaturePolicyByWalletIdAndPolicyIdRaw(requestParameters, initOverrides) {
@@ -828,6 +855,7 @@ class WaasApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Updates a WaaS signature policy by wallet ID and policy ID.
      * Update a WAAS signature policy by walletId and policyId
      */
     updateWaasSignaturePolicyByWalletIdAndPolicyId(requestParameters, initOverrides) {
@@ -840,10 +868,10 @@ class WaasApi extends runtime.BaseAPI {
      * Simple endpoint to verify if the provided API key (DYN_API_TOKEN) is valid and has access to the specified environment. Returns true if the token is verified, false otherwise.
      * Verify if an API key is valid for a specific environment
      */
-    verifyApiKeyRaw(requestParameters, initOverrides) {
+    waasVerifyApiKeyRaw(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             if (requestParameters.environmentId === null || requestParameters.environmentId === undefined) {
-                throw new runtime.RequiredError('environmentId', 'Required parameter requestParameters.environmentId was null or undefined when calling verifyApiKey.');
+                throw new runtime.RequiredError('environmentId', 'Required parameter requestParameters.environmentId was null or undefined when calling waasVerifyApiKey.');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -867,9 +895,9 @@ class WaasApi extends runtime.BaseAPI {
      * Simple endpoint to verify if the provided API key (DYN_API_TOKEN) is valid and has access to the specified environment. Returns true if the token is verified, false otherwise.
      * Verify if an API key is valid for a specific environment
      */
-    verifyApiKey(requestParameters, initOverrides) {
+    waasVerifyApiKey(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const response = yield this.verifyApiKeyRaw(requestParameters, initOverrides);
+            const response = yield this.waasVerifyApiKeyRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }

package/src/apis/WaasApi.d.ts

@@ -98,7 +98,7 @@ export interface UpdateWaasSignaturePolicyByWalletIdAndPolicyIdRequest {
     policyId: string;
     waasWalletSignaturePolicyTmpCreateRequest: WaasWalletSignaturePolicyTmpCreateRequest;
 }
-export interface VerifyApiKeyRequest {
+export interface WaasVerifyApiKeyRequest {
     environmentId: string;
 }
 /**
@@ -106,11 +106,13 @@ export interface VerifyApiKeyRequest {
  */
 export declare class WaasApi extends runtime.BaseAPI {
     /**
-     * Authenticate for WAAS using api key
+     * Authenticates for WaaS using an API key.
+     * Authenticate for WAAS using an API key
      */
     authenticateWaasRaw(requestParameters: AuthenticateWaasRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasAuthenticateResponse>>;
     /**
-     * Authenticate for WAAS using api key
+     * Authenticates for WaaS using an API key.
+     * Authenticate for WAAS using an API key
      */
     authenticateWaas(requestParameters: AuthenticateWaasRequest, initOverrides?: RequestInit): Promise<WaasAuthenticateResponse>;
     /**
@@ -124,44 +126,52 @@ export declare class WaasApi extends runtime.BaseAPI {
      */
     backupKeySharesToLocationsForPregen(requestParameters: BackupKeySharesToLocationsForPregenRequest, initOverrides?: RequestInit): Promise<BackupKeySharesToLocationsResponse>;
     /**
+     * Creates new encryption public key credentials for WaaS wallet delegation.
      * Create credentials for waas wallet delegation
      */
     createDelegatedCredentialsRaw(requestParameters: CreateDelegatedCredentialsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasDelegationCredentialsResponse>>;
     /**
+     * Creates new encryption public key credentials for WaaS wallet delegation.
      * Create credentials for waas wallet delegation
      */
     createDelegatedCredentials(requestParameters: CreateDelegatedCredentialsRequest, initOverrides?: RequestInit): Promise<WaasDelegationCredentialsResponse>;
     /**
+     * Creates a new WaaS policy for the specified environment.
      * Create a new WAAS policy for an environment or add new rules to an existing policy
      */
     createWaasPolicyRaw(requestParameters: CreateWaasPolicyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasPolicyResponse>>;
     /**
+     * Creates a new WaaS policy for the specified environment.
      * Create a new WAAS policy for an environment or add new rules to an existing policy
      */
     createWaasPolicy(requestParameters: CreateWaasPolicyRequest, initOverrides?: RequestInit): Promise<WaasPolicyResponse>;
     /**
+     * Creates a new WaaS signature policy for the specified wallet.
      * Create a new WAAS signature policy for a wallet
      */
     createWaasSignaturePolicyRaw(requestParameters: CreateWaasSignaturePolicyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasWalletSignaturePolicyTmpResponse>>;
     /**
+     * Creates a new WaaS signature policy for the specified wallet.
      * Create a new WAAS signature policy for a wallet
      */
     createWaasSignaturePolicy(requestParameters: CreateWaasSignaturePolicyRequest, initOverrides?: RequestInit): Promise<WaasWalletSignaturePolicyTmpResponse>;
     /**
      * Creates a new WAAS wallet for a user given an email or userId. If an email is provided and it is not associated with an existing user this call will also create a new user.
-     * Create a new WAAS for a user given an identifier
+     * Create a WAAS wallet for a user
      */
     createWaasWalletRaw(requestParameters: CreateWaasWalletRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserResponse>>;
     /**
      * Creates a new WAAS wallet for a user given an email or userId. If an email is provided and it is not associated with an existing user this call will also create a new user.
-     * Create a new WAAS for a user given an identifier
+     * Create a WAAS wallet for a user
      */
     createWaasWallet(requestParameters: CreateWaasWalletRequest, initOverrides?: RequestInit): Promise<UserResponse>;
     /**
+     * Signs a message using a delegated WaaS account.
      * Sign a message with a delegated waas account
      */
     delegatedSignMessageRaw(requestParameters: DelegatedSignMessageRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OpenRoomResponse>>;
     /**
+     * Signs a message using a delegated WaaS account.
      * Sign a message with a delegated waas account
      */
     delegatedSignMessage(requestParameters: DelegatedSignMessageRequest, initOverrides?: RequestInit): Promise<OpenRoomResponse>;
@@ -176,18 +186,22 @@ export declare class WaasApi extends runtime.BaseAPI {
      */
     deleteDelegatedAccess(requestParameters: DeleteDelegatedAccessRequest, initOverrides?: RequestInit): Promise<void>;
     /**
+     * Permanently removes the specified WaaS policy rule.
      * Delete a WAAS policy rule by ruleId
      */
     deleteWaasPolicyRaw(requestParameters: DeleteWaasPolicyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasPolicyResponse>>;
     /**
+     * Permanently removes the specified WaaS policy rule.
      * Delete a WAAS policy rule by ruleId
      */
     deleteWaasPolicy(requestParameters: DeleteWaasPolicyRequest, initOverrides?: RequestInit): Promise<WaasPolicyResponse>;
     /**
+     * Permanently removes a WaaS signature policy by wallet ID and policy ID.
      * Delete a WAAS signature policy by walletId and policyId
      */
     deleteWaasSignaturePolicyByWalletIdAndPolicyIdRaw(requestParameters: DeleteWaasSignaturePolicyByWalletIdAndPolicyIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasWalletSignaturePolicyTmpResponse>>;
     /**
+     * Permanently removes a WaaS signature policy by wallet ID and policy ID.
      * Delete a WAAS signature policy by walletId and policyId
      */
     deleteWaasSignaturePolicyByWalletIdAndPolicyId(requestParameters: DeleteWaasSignaturePolicyByWalletIdAndPolicyIdRequest, initOverrides?: RequestInit): Promise<WaasWalletSignaturePolicyTmpResponse>;
@@ -202,10 +216,12 @@ export declare class WaasApi extends runtime.BaseAPI {
      */
     getDelegatedAccessEncryptionPublicKey(requestParameters: GetDelegatedAccessEncryptionPublicKeyRequest, initOverrides?: RequestInit): Promise<DelegatedAccessEncryptionPublicKeyResponse>;
     /**
+     * Returns a delegated access encryption public key by its ID.
      * Get a specific delegated access encryption public key by ID
      */
     getDelegatedAccessEncryptionPublicKeyByIdRaw(requestParameters: GetDelegatedAccessEncryptionPublicKeyByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<DelegatedAccessEncryptionPublicKeyResponse>>;
     /**
+     * Returns a delegated access encryption public key by its ID.
      * Get a specific delegated access encryption public key by ID
      */
     getDelegatedAccessEncryptionPublicKeyById(requestParameters: GetDelegatedAccessEncryptionPublicKeyByIdRequest, initOverrides?: RequestInit): Promise<DelegatedAccessEncryptionPublicKeyResponse>;
@@ -220,34 +236,42 @@ export declare class WaasApi extends runtime.BaseAPI {
      */
     getDelegatedAccessEncryptionPublicKeys(requestParameters: GetDelegatedAccessEncryptionPublicKeysRequest, initOverrides?: RequestInit): Promise<DelegatedAccessEncryptionPublicKeysUnifiedResponse>;
     /**
+     * Returns the WaaS policy for the specified environment.
      * Get the WAAS policy for an environment
      */
     getWaasPolicyRaw(requestParameters: GetWaasPolicyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasPolicyResponse>>;
     /**
+     * Returns the WaaS policy for the specified environment.
      * Get the WAAS policy for an environment
      */
     getWaasPolicy(requestParameters: GetWaasPolicyRequest, initOverrides?: RequestInit): Promise<WaasPolicyResponse>;
     /**
+     * Returns all active WaaS signature policies for the specified wallet.
      * Get all active WAAS signature policies for a wallet
      */
     getWaasSignaturePoliciesRaw(requestParameters: GetWaasSignaturePoliciesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<WaasWalletSignaturePolicyTmpResponse>>>;
     /**
+     * Returns all active WaaS signature policies for the specified wallet.
      * Get all active WAAS signature policies for a wallet
      */
     getWaasSignaturePolicies(requestParameters: GetWaasSignaturePoliciesRequest, initOverrides?: RequestInit): Promise<Array<WaasWalletSignaturePolicyTmpResponse>>;
     /**
+     * Returns a WaaS signature policy by wallet ID and policy ID.
      * Get a WAAS signature policy by walletId and policyId
      */
     getWaasSignaturePolicyByWalletIdAndPolicyIdRaw(requestParameters: GetWaasSignaturePolicyByWalletIdAndPolicyIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasWalletSignaturePolicyTmpResponse>>;
     /**
+     * Returns a WaaS signature policy by wallet ID and policy ID.
      * Get a WAAS signature policy by walletId and policyId
      */
     getWaasSignaturePolicyByWalletIdAndPolicyId(requestParameters: GetWaasSignaturePolicyByWalletIdAndPolicyIdRequest, initOverrides?: RequestInit): Promise<WaasWalletSignaturePolicyTmpResponse>;
     /**
+     * Returns a WaaS wallet by its wallet ID.
      * Get a specific WAAS wallet by walletId
      */
     getWaasWalletByWalletIdRaw(requestParameters: GetWaasWalletByWalletIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasWalletResponse>>;
     /**
+     * Returns a WaaS wallet by its wallet ID.
      * Get a specific WAAS wallet by walletId
      */
     getWaasWalletByWalletId(requestParameters: GetWaasWalletByWalletIdRequest, initOverrides?: RequestInit): Promise<WaasWalletResponse>;
@@ -272,18 +296,22 @@ export declare class WaasApi extends runtime.BaseAPI {
      */
     revokeDelegatedAccess(requestParameters: RevokeDelegatedAccessOperationRequest, initOverrides?: RequestInit): Promise<RevokeDelegatedAccessResponse>;
     /**
+     * Updates the WaaS policy for the specified environment.
      * Update the WAAS policy for an environment by ruleId
      */
     updateWaasPolicyRaw(requestParameters: UpdateWaasPolicyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasPolicyResponse>>;
     /**
+     * Updates the WaaS policy for the specified environment.
      * Update the WAAS policy for an environment by ruleId
      */
     updateWaasPolicy(requestParameters: UpdateWaasPolicyRequest, initOverrides?: RequestInit): Promise<WaasPolicyResponse>;
     /**
+     * Updates a WaaS signature policy by wallet ID and policy ID.
      * Update a WAAS signature policy by walletId and policyId
      */
     updateWaasSignaturePolicyByWalletIdAndPolicyIdRaw(requestParameters: UpdateWaasSignaturePolicyByWalletIdAndPolicyIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasWalletSignaturePolicyTmpResponse>>;
     /**
+     * Updates a WaaS signature policy by wallet ID and policy ID.
      * Update a WAAS signature policy by walletId and policyId
      */
     updateWaasSignaturePolicyByWalletIdAndPolicyId(requestParameters: UpdateWaasSignaturePolicyByWalletIdAndPolicyIdRequest, initOverrides?: RequestInit): Promise<WaasWalletSignaturePolicyTmpResponse>;
@@ -291,10 +319,10 @@ export declare class WaasApi extends runtime.BaseAPI {
      * Simple endpoint to verify if the provided API key (DYN_API_TOKEN) is valid and has access to the specified environment. Returns true if the token is verified, false otherwise.
      * Verify if an API key is valid for a specific environment
      */
-    verifyApiKeyRaw(requestParameters: VerifyApiKeyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasVerifyApiKeyResponse>>;
+    waasVerifyApiKeyRaw(requestParameters: WaasVerifyApiKeyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasVerifyApiKeyResponse>>;
     /**
      * Simple endpoint to verify if the provided API key (DYN_API_TOKEN) is valid and has access to the specified environment. Returns true if the token is verified, false otherwise.
      * Verify if an API key is valid for a specific environment
      */
-    verifyApiKey(requestParameters: VerifyApiKeyRequest, initOverrides?: RequestInit): Promise<WaasVerifyApiKeyResponse>;
+    waasVerifyApiKey(requestParameters: WaasVerifyApiKeyRequest, initOverrides?: RequestInit): Promise<WaasVerifyApiKeyResponse>;
 }