Fixed url for [2fa , addresses, archive, applicationPassword, audit, …

…authentication] files.
Absolit-FOSS · Jul 16, 2024 · 891e463 · 891e463
1 parent 76f9364
commit 891e463
Show file tree

Hide file tree

Showing 18 changed files with 37 additions and 37 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/requests/2fa/delete.ts b/src/requests/2fa/delete.ts
@@ -8,7 +8,7 @@ import { URL } from "./config";
  * This method disables all 2FA mechanisms a user
  * might have set up
  *
- * https://docs.wildduck.email/api/#operation/disable2FA
+ * https://docs.wildduck.email/api/#operation/deleteusersuser2fa
  *
  * @param userId Users unique ID
  * @param queryData query parameters for additional options
@@ -32,7 +32,7 @@ export const disable2FA = async (
  * set up, then account password for IMAP/POP3/SMTP gets
  * enabled again.
  *
- * https://docs.wildduck.email/api/#operation/disableCustom2FA
+ * https://docs.wildduck.email/api/#operation/deleteusersuser2facustom
  *
  * @param userId Users unique ID
  * @param queryData query parameters for additional options
@@ -55,7 +55,7 @@ export const disableCustom2FA = async (
  * This method disables TOTP for a user. Does not affect
  * other 2FA mechanisms a user might have set up.
  *
- * https://docs.wildduck.email/api/#operation/disableTotp2FA
+ * https://docs.wildduck.email/api/#operation/deleteusersuser2fatotp
  *
  * @param userId Users unique ID
  * @param queryData query parameters for additional options

diff --git a/src/requests/2fa/post.ts b/src/requests/2fa/post.ts
@@ -14,7 +14,7 @@ import {
  * This method checks if a TOTP token provided by a User
  * is valid for authentication.
  *
- * https://docs.wildduck.email/api/#operation/checkTotp2FA
+ * https://docs.wildduck.email/api/#operation/postusersuser2fatotpcheck
  *
  * @param userId the users wildduck ID
  * @param bodyData body parameters for request
@@ -36,7 +36,7 @@ export const validateTOTPToken = async (
  * This method enables TOTP for a user by verifying the
  * seed value generated from 2fa/totp/setup.
  *
- * https://docs.wildduck.email/api/#operation/enableTotp2FA
+ * https://docs.wildduck.email/api/#operation/postusersuser2fatotpenable
  *
  * @param userId the users wildduck ID
  * @param bodyData body parameters for request
@@ -62,7 +62,7 @@ export const enableTOTPSeed = async (
  * User needs to verify the seed value using
  * 2fa/totp/enable endpoint.
  *
- * https://docs.wildduck.email/api/#operation/setupTotp2FA
+ * https://docs.wildduck.email/api/#operation/postusersuser2fatotpsetup
  *
  * @param userId the users wildduck ID
  * @param bodyData body parameters for request

diff --git a/src/requests/2fa/put.ts b/src/requests/2fa/put.ts
@@ -7,7 +7,7 @@ import { URL } from "./config";
 /**
  * This method disables account password for IMAP/POP3/SMTP.
  *
- * https://docs.wildduck.email/api/#operation/enableCustom2FA
+ * https://docs.wildduck.email/api/#operation/putusersuser2facustom
  *
  * @param userId the users wildduck ID
  * @param bodyData data to update on the mailbox

diff --git a/src/requests/addresses/delete.ts b/src/requests/addresses/delete.ts
@@ -7,7 +7,7 @@ import { URL } from "./config";
 /**
  * Delete a forwarded Address.
  *
- * https://docs.wildduck.email/api/#operation/deleteForwardedAddress
+ * https://docs.wildduck.email/api/#operation/deleteusersuseraddressesaddress
  *
  * @param addressId ID of the Address
  */
@@ -26,7 +26,7 @@ export const deleteForwardedAddress = async (
 /**
  * Delete an Address.
  *
- * https://docs.wildduck.email/api/#operation/deleteUserAddress
+ * https://docs.wildduck.email/api/#operation/deleteusersuseraddressesaddress
  *
  * @param userId ID of the User
  * @param addressId ID of the Address

diff --git a/src/requests/addresses/get.ts b/src/requests/addresses/get.ts
@@ -18,7 +18,7 @@ import {
 /**
  * Request forwarded Addresses information.
  *
- * https://docs.wildduck.email/api/#operation/getForwardedAddress
+ * https://docs.wildduck.email/api/#operation/getaddressesforwardedaddress
  *
  * @param addressId ID of the Address
  */
@@ -37,7 +37,7 @@ export const getForwardedAddressInfo = async (
 /**
  * Request User Addresses information.
  *
- * https://docs.wildduck.email/api/#operation/getUserAddress
+ * https://docs.wildduck.email/api/#operation/getusersuseraddressesaddress
  *
  * @param userId ID of the User
  * @param addressId ID of the Address
@@ -58,7 +58,7 @@ export const getAddressesInfo = async (
 /**
  * Get Address info.
  *
- * https://docs.wildduck.email/api/#operation/resolveAddress
+ * https://docs.wildduck.email/api/#operation/getaddressesresolveaddress
  *
  * @param addressId ID of the Address or e-mail address string
  * @param queryData query parameters for additional options
@@ -80,7 +80,7 @@ export const getAddressInfo = async (
 /**
  * List registered Addresses.
  *
- * https://docs.wildduck.email/api/#operation/getAddresses
+ * https://docs.wildduck.email/api/#operation/addresses
  *
  * @param userId ID of the User
  * @param queryData query parameters for additional options
@@ -101,7 +101,7 @@ export const listRegisteredAddresses = async (
 /**
  * List registered Addresses for a User
  *
- * https://docs.wildduck.email/api/#operation/getUserAddresses
+ * https://docs.wildduck.email/api/#operation/getusersuseraddresses
  *
  * @param userId ID of the User
  * @param queryData query parameters for additional options
@@ -125,7 +125,7 @@ export const listRegisteredAddressesForUser = async (
 /**
  * Lists addresses from email headers. Includes addresses both from sent and received messages. Sorted by last usage
  *
- * https://docs.wildduck.email/api/#operation/getUserAddressregister
+ * https://docs.wildduck.email/api/#operation/getusersuseraddressregister
  *
  * @param userId ID of the User, Example: 507f1f77bcf86cd799439011
  * @param queryData query parameters for additional options

diff --git a/src/requests/addresses/post.ts b/src/requests/addresses/post.ts
@@ -16,7 +16,7 @@ import {
  * Special addresses *@example.com, *[email protected] and username@* catches all emails to these domains
  * or users without a registered destination (requires allowWildcard argument)
  *
- * https://docs.wildduck.email/api/#operation/createUserAddress
+ * https://docs.wildduck.email/api/#operation/postusersuseraddresses
  *
  * @param userId ID of the User
  * @param bodyData body parameters to create a user
@@ -43,7 +43,7 @@ export const createAddress = async (
  * catches all emails to these domains or users without a registered destination
  * (requires allowWildcard argument)
  *
- * https://docs.wildduck.email/api/#operation/createForwardedAddress
+ * https://docs.wildduck.email/api/#operation/postaddressesforwarded
  *
  * @param bodyData body parameters to cancel user deletion
  */

diff --git a/src/requests/addresses/put.ts b/src/requests/addresses/put.ts
@@ -12,7 +12,7 @@ import {
 /**
  * Update forwarded Address information
  *
- * https://docs.wildduck.email/api/#operation/updateForwardedAddress
+ * https://docs.wildduck.email/api/#operation/putaddressesforwardedid
  *
  * @param addressId ID of the Address
  * @param bodyData data to update on the user
@@ -34,7 +34,7 @@ export const updateForwardedAddressInfo = async (
  * Update Address information
  * Renames domain names for addresses, DKIM keys and Domain Aliases
  *
- * https://docs.wildduck.email/api/#operation/updateUserAddress
+ * https://docs.wildduck.email/api/#operation/putusersuseraddressesid
  *
  * @param userId ID of the User
  * @param addressId ID of the Address
@@ -57,7 +57,7 @@ export const updateAddressInfo = async (
 /**
  * Rename domain in addresses
  *
- * https://docs.wildduck.email/api/#operation/renameDomain
+ * https://docs.wildduck.email/api/#operation/putaddressesrenamedomain
  *
  * @param bodyData data to update on the user
  */

diff --git a/src/requests/applicationPasswords/delete.ts b/src/requests/applicationPasswords/delete.ts
@@ -7,7 +7,7 @@ import { URL } from "./config";
 /**
  * Delete an Application Password
  *
- * https://docs.wildduck.email/api/#operation/deleteASP
+ * https://docs.wildduck.email/api/#operation/deleteusersuseraspsasp
  *
  * @param userId ID of the User
  * @param aspId ID of the Application Password

diff --git a/src/requests/applicationPasswords/get.ts b/src/requests/applicationPasswords/get.ts
@@ -11,7 +11,7 @@ import {
 /**
  * Request ASP information
  *
- * https://docs.wildduck.email/api/#operation/getASP
+ * https://docs.wildduck.email/api/#operation/getusersuseraspsasp
  *
  * @param userId the users wildduck ID
  * @param aspId ID of the Application Password
@@ -32,7 +32,7 @@ export const getAppPasswordInformation = async (
 /**
  * List Application Passwords
  *
- * https://docs.wildduck.email/api/#operation/getASPs
+ * https://docs.wildduck.email/api/#operation/getusersuserasps
  *
  * @param userId ID of the User
  * @param queryData query parameters for additional options

diff --git a/src/requests/applicationPasswords/post.ts b/src/requests/applicationPasswords/post.ts
@@ -10,7 +10,7 @@ import {
 /**
  * Create new Application Password
  *
- * https://docs.wildduck.email/api/#operation/createASP
+ * https://docs.wildduck.email/api/#operation/postusersuserasps
  *
  * @param userId ID of the User
  * @param bodyData body parameters to reset user password

diff --git a/src/requests/archive/get.ts b/src/requests/archive/get.ts
@@ -12,7 +12,7 @@ import {
  *
  * Archive contains all recently deleted messages besides Drafts etc.
  *
- * https://docs.wildduck.email/api/#operation/getArchivedMessages
+ * https://docs.wildduck.email/api/#operation/archived
  *
  * @param userId ID of the User
  * @param queryData query parameters for additional options

diff --git a/src/requests/archive/post.ts b/src/requests/archive/post.ts
@@ -12,7 +12,7 @@ import {
 /**
  * Restore archived Message
  *
- * https://docs.wildduck.email/api/#operation/restoreMessage
+ * https://docs.wildduck.email/api/#operation/create_restore_task
  *
  * @param userId ID of the User
  * @param messageId Message ID
@@ -44,7 +44,7 @@ export const restoreArchivedMessage = async (
  * is fully recovered, except any email addresses that might have been
  * already recycled
  *
- * https://docs.wildduck.email/api/#operation/restoreMessages
+ * https://docs.wildduck.email/api/#operation/archived_restore
  *
  * @param userId ID of the User
  */

diff --git a/src/requests/audit/get.ts b/src/requests/audit/get.ts
@@ -8,7 +8,7 @@ import { GetAuditInformationResponseModel } from "./models";
 /**
  * Request Audit Info
  *
- * https://docs.wildduck.email/api/#operation/getAudit
+ * https://docs.wildduck.email/api/#operation/getauditaudit
  *
  * @param auditId ID of the Audit
  */
@@ -27,7 +27,7 @@ export const getAuditInformation = async (
 /**
  * Export Audited Emails
  *
- * https://docs.wildduck.email/api/#operation/getAuditEmails
+ * https://docs.wildduck.email/api/#operation/getauditauditexportmbox
  *
  * @param auditId ID of the Audit
  */

diff --git a/src/requests/audit/post.ts b/src/requests/audit/post.ts
@@ -8,7 +8,7 @@ import { CreateNewAuditBodyParametersModel } from "./models";
 /**
  * Create new audit
  *
- * https://docs.wildduck.email/api/#operation/createAudit
+ * https://docs.wildduck.email/api/#operation/postaudit
  *
  * @param bodyData body parameters to reset user password
  */

diff --git a/src/requests/authentication/delete.ts b/src/requests/authentication/delete.ts
@@ -9,7 +9,7 @@ import { URL } from "./config";
  *
  * This method invalidates currently used authentication token. If token is not provided then nothing happens
  *
- * https://docs.wildduck.email/api/#operation/invalidateAccessToken
+ * https://docs.wildduck.email/api/#operation/deleteauthenticate
  */
 export const invalidateAuthenticationToken = async (): Promise<
 	AxiosResponse<DefaultResponseModel, any>

diff --git a/src/requests/authentication/get.ts b/src/requests/authentication/get.ts
@@ -10,7 +10,7 @@ import {
 /**
  * List authentication Events
  *
- * https://docs.wildduck.email/api/#operation/getAuthlog
+ * https://docs.wildduck.email/api/#operation/authlog
  *
  * @param userId ID of the User
  * @param queryData query parameters for additional options
@@ -32,7 +32,7 @@ export const listAuthenticationEvents = async (
 /**
  * Request Event information
  *
- * https://docs.wildduck.email/api/#operation/getAuthlogEvent
+ * https://docs.wildduck.email/api/#operation/getusersuserauthlogevent
  *
  * @param userId ID of the User
  * @param eventId ID of the Event

diff --git a/src/requests/authentication/post.ts b/src/requests/authentication/post.ts
@@ -12,7 +12,7 @@ import {
 /**
  * Authenticate a User
  *
- * https://docs.wildduck.email/api/#operation/authenticate
+ * https://docs.wildduck.email/api/#operation/postauthenticate
  *
  * @param bodyData body parameters to reset user password
  */
@@ -35,7 +35,7 @@ export const authenticateUser = async (
  * Pre-auth check
  * Check if an username exists and can be used for authentication
  *
- * https://docs.wildduck.email/api/#operation/preauth
+ * https://docs.wildduck.email/api/#operation/postpreauth
  *
  * @param bodyData body parameters to reset user password
  */