@appwrite.io/console 1.8.0 → 1.10.0

package/src/services/domains.ts

@@ -38,6 +38,7 @@ export class Domains {
             payload
         );
     }
+
     /**
      *     Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.
      *
@@ -74,6 +75,7 @@ export class Domains {
             payload
         );
     }
+
     /**
      *     Get a domain by its unique ID.
      *
@@ -99,9 +101,10 @@ export class Domains {
             payload
         );
     }
+
     /**
      * Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
-Once deleted, the domain will no longer be available for use and all associated resources will be removed.
+     * Once deleted, the domain will no longer be available for use and all associated resources will be removed.
      *
      * @param {string} domainId
      * @throws {AppwriteException}
@@ -126,10 +129,11 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     Verify which NS records are used and update the domain accordingly. This will check the domain's 
-    nameservers and update the domain's status based on whether the nameservers match the expected 
-    Appwrite nameservers.
+     *     nameservers and update the domain's status based on whether the nameservers match the expected 
+     *     Appwrite nameservers.
      *
      * @param {string} domainId
      * @throws {AppwriteException}
@@ -154,6 +158,7 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     List Google Workspace DNS records.
      *
@@ -179,9 +184,10 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     Add Google Workspace DNS records to the domain. This will create the required MX records 
-    for Google Workspace email hosting.
+     *     for Google Workspace email hosting.
      *
      * @param {string} domainId
      * @throws {AppwriteException}
@@ -206,6 +212,7 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     List iCloud DNS records.
      *
@@ -231,9 +238,10 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     Add iCloud DNS records to the domain. This will create the required MX and SPF records
-    for using iCloud email services with your domain.
+     *     for using iCloud email services with your domain.
      *
      * @param {string} domainId
      * @throws {AppwriteException}
@@ -258,6 +266,7 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     List Mailgun DNS records.
      *
@@ -283,9 +292,10 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     Add Mailgun DNS records to the domain. This endpoint will create the required DNS records 
-    for Mailgun in the specified domain.
+     *     for Mailgun in the specified domain.
      *
      * @param {string} domainId
      * @throws {AppwriteException}
@@ -310,6 +320,7 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     List Outlook DNS records.
      *
@@ -335,9 +346,10 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     Add Outlook DNS records to the domain. This will create the required MX records
-    for setting up Outlook email hosting for your domain.
+     *     for setting up Outlook email hosting for your domain.
      *
      * @param {string} domainId
      * @throws {AppwriteException}
@@ -362,6 +374,7 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     List ProtonMail DNS records.
      *
@@ -387,9 +400,10 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     Add ProtonMail DNS records to the domain. This will create the required MX records
-    for using ProtonMail with your custom domain.
+     *     for using ProtonMail with your custom domain.
      *
      * @param {string} domainId
      * @throws {AppwriteException}
@@ -414,6 +428,7 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     List Zoho DNS records.
      *
@@ -439,9 +454,10 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     Add Zoho Mail DNS records to the domain. This will create the required MX records
-    for setting up Zoho Mail on your domain.
+     *     for setting up Zoho Mail on your domain.
      *
      * @param {string} domainId
      * @throws {AppwriteException}
@@ -466,9 +482,10 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      *     List DNS records for a given domain. You can use this endpoint to list all the DNS records
-    associated with your domain.
+     *     associated with your domain.
      *
      * @param {string} domainId
      * @param {string[]} queries
@@ -496,9 +513,10 @@ Once deleted, the domain will no longer be available for use and all associated
             payload
         );
     }
+
     /**
      * Create a new A record for the given domain. A records are used to point a domain name 
-to an IPv4 address. The record value should be a valid IPv4 address.
+     * to an IPv4 address. The record value should be a valid IPv4 address.
      *
      * @param {string} domainId
      * @param {string} name
@@ -548,10 +566,11 @@ to an IPv4 address. The record value should be a valid IPv4 address.
             payload
         );
     }
+
     /**
      *     Update an existing A record for the given domain. This endpoint allows you to modify 
-    the properties of an A record including its name (subdomain), IPv4 address, TTL, 
-    and optional comment.
+     *     the properties of an A record including its name (subdomain), IPv4 address, TTL, 
+     *     and optional comment.
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -605,9 +624,10 @@ to an IPv4 address. The record value should be a valid IPv4 address.
             payload
         );
     }
+
     /**
      *     Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record 
-    to your domain. The record will be used to point a hostname to an IPv6 address.
+     *     to your domain. The record will be used to point a hostname to an IPv6 address.
      *
      * @param {string} domainId
      * @param {string} name
@@ -657,10 +677,11 @@ to an IPv4 address. The record value should be a valid IPv4 address.
             payload
         );
     }
+
     /**
      *     Update an existing AAAA record for the given domain. This endpoint allows you to modify
-    the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
-    TTL, and optional comment.
+     *     the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
+     *     TTL, and optional comment.
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -714,10 +735,11 @@ to an IPv4 address. The record value should be a valid IPv4 address.
             payload
         );
     }
+
     /**
      *     Create a new ALIAS record for the given domain. This record type can be used to point your domain 
-    to another domain name that will serve as an alias. This is particularly useful when you want to 
-    map your domain to a target domain that may change its IP address.
+     *     to another domain name that will serve as an alias. This is particularly useful when you want to 
+     *     map your domain to a target domain that may change its IP address.
      *
      * @param {string} domainId
      * @param {string} name
@@ -767,12 +789,13 @@ to an IPv4 address. The record value should be a valid IPv4 address.
             payload
         );
     }
+
     /**
      *     Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
-    the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
-    
-    The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
-    It provides a way to map one domain name to another.
+     *     the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
+     *     
+     *     The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
+     *     It provides a way to map one domain name to another.
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -826,9 +849,10 @@ to an IPv4 address. The record value should be a valid IPv4 address.
             payload
         );
     }
+
     /**
      * Create a new CAA record for the given domain. CAA records are used to specify which 
-Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
+     * Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
      *
      * @param {string} domainId
      * @param {string} name
@@ -878,10 +902,11 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
             payload
         );
     }
+
     /**
      *     Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization) 
-    record is used to specify which certificate authorities (CAs) are authorized to issue certificates 
-    for a domain.
+     *     record is used to specify which certificate authorities (CAs) are authorized to issue certificates 
+     *     for a domain.
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -935,12 +960,13 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
             payload
         );
     }
+
     /**
      *     Create a new CNAME record for the given domain.
-    
-    A CNAME record maps a subdomain to another domain name, allowing you to create aliases 
-    for your domain. For example, you can create a CNAME record to point 'blog.example.com' 
-    to 'example.wordpress.com'.
+     *     
+     *     A CNAME record maps a subdomain to another domain name, allowing you to create aliases 
+     *     for your domain. For example, you can create a CNAME record to point 'blog.example.com' 
+     *     to 'example.wordpress.com'.
      *
      * @param {string} domainId
      * @param {string} name
@@ -990,6 +1016,7 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
             payload
         );
     }
+
     /**
      *     Update an existing CNAME record for the given domain.
      *
@@ -1045,9 +1072,10 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
             payload
         );
     }
+
     /**
      *     Create a new HTTPS record for the given domain. This record is used to configure HTTPS 
-    settings for your domain, enabling secure communication over SSL/TLS.
+     *     settings for your domain, enabling secure communication over SSL/TLS.
      *
      * @param {string} domainId
      * @param {string} name
@@ -1097,10 +1125,11 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
             payload
         );
     }
+
     /**
      * Update an existing HTTPS record for the given domain. This endpoint allows you to modify 
-the properties of an HTTPS record associated with your domain, including the name (subdomain), 
-target value, TTL, and optional comment.
+     * the properties of an HTTPS record associated with your domain, including the name (subdomain), 
+     * target value, TTL, and optional comment.
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -1154,11 +1183,12 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Create a new MX record for the given domain. MX records are used to define the mail servers responsible 
-    for accepting email messages for the domain. Multiple MX records can be created with different priorities.
-    The priority parameter determines the order in which mail servers are used, with lower values indicating 
-    higher priority.
+     *     for accepting email messages for the domain. Multiple MX records can be created with different priorities.
+     *     The priority parameter determines the order in which mail servers are used, with lower values indicating 
+     *     higher priority.
      *
      * @param {string} domainId
      * @param {string} name
@@ -1215,6 +1245,7 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Update an existing MX record for the given domain.
      *
@@ -1277,9 +1308,10 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Create a new NS record for the given domain. NS records specify the nameservers that are used 
-    to resolve the domain name to IP addresses. Each domain can have multiple NS records.
+     *     to resolve the domain name to IP addresses. Each domain can have multiple NS records.
      *
      * @param {string} domainId
      * @param {string} name
@@ -1329,11 +1361,12 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Update an existing NS record for the given domain. This endpoint allows you to modify 
-    the properties of an NS (nameserver) record associated with your domain. You can update 
-    the record name (subdomain), target nameserver value, TTL, and add or modify comments 
-    for better record management.
+     *     the properties of an NS (nameserver) record associated with your domain. You can update 
+     *     the record name (subdomain), target nameserver value, TTL, and add or modify comments 
+     *     for better record management.
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -1387,10 +1420,11 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Create a new SRV record for the given domain. SRV records are used to define the location 
-    of servers for specific services. For example, they can be used to specify which server 
-    handles a specific service like SIP or XMPP for the domain.
+     *     of servers for specific services. For example, they can be used to specify which server 
+     *     handles a specific service like SIP or XMPP for the domain.
      *
      * @param {string} domainId
      * @param {string} name
@@ -1461,21 +1495,22 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Update an existing SRV record for the given domain.
-    
-    Required parameters:
-    - domainId: Domain unique ID
-    - recordId: DNS record unique ID
-    - name: Record name (service name)
-    - value: Target hostname for this SRV record
-    - ttl: Time to live, in seconds
-    - priority: Record priority
-    - weight: Record weight
-    - port: Port number for the service
-    
-    Optional parameters:
-    - comment: A comment for this record
+     *     
+     *     Required parameters:
+     *     - domainId: Domain unique ID
+     *     - recordId: DNS record unique ID
+     *     - name: Record name (service name)
+     *     - value: Target hostname for this SRV record
+     *     - ttl: Time to live, in seconds
+     *     - priority: Record priority
+     *     - weight: Record weight
+     *     - port: Port number for the service
+     *     
+     *     Optional parameters:
+     *     - comment: A comment for this record
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -1550,10 +1585,11 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Create a new TXT record for the given domain. TXT records can be used 
-    to provide additional information about your domain, such as domain 
-    verification records, SPF records, or DKIM records.
+     *     to provide additional information about your domain, such as domain 
+     *     verification records, SPF records, or DKIM records.
      *
      * @param {string} domainId
      * @param {string} name
@@ -1600,11 +1636,12 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Update an existing TXT record for the given domain.
-    
-    Update the TXT record details for a specific domain by providing the domain ID,
-    record ID, and the new record configuration including name, value, TTL, and an optional comment.
+     *     
+     *     Update the TXT record details for a specific domain by providing the domain ID,
+     *     record ID, and the new record configuration including name, value, TTL, and an optional comment.
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -1658,12 +1695,13 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Get a single DNS record for a given domain by record ID.
-    
-    This endpoint allows you to retrieve a specific DNS record associated with a domain
-    using its unique identifier. The record contains information about the DNS configuration
-    such as type, value, and TTL settings.
+     *     
+     *     This endpoint allows you to retrieve a specific DNS record associated with a domain
+     *     using its unique identifier. The record contains information about the DNS configuration
+     *     such as type, value, and TTL settings.
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -1691,9 +1729,10 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record 
-    from a specific domain.
+     *     from a specific domain.
      *
      * @param {string} domainId
      * @param {string} recordId
@@ -1722,11 +1761,12 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Update the team ID for a specific domain. This endpoint requires admin access.
-    
-    Updating the team ID will transfer ownership and access control of the domain
-    and all its DNS records to the new team.
+     *     
+     *     Updating the team ID will transfer ownership and access control of the domain
+     *     and all its DNS records to the new team.
      *
      * @param {string} domainId
      * @param {string} teamId
@@ -1758,9 +1798,10 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      *     Retrieve the DNS zone file for the given domain. This endpoint will return the DNS 
-    zone file in a standardized format that can be used to configure DNS servers.
+     *     zone file in a standardized format that can be used to configure DNS servers.
      *
      * @param {string} domainId
      * @throws {AppwriteException}
@@ -1784,9 +1825,10 @@ target value, TTL, and optional comment.
             payload
         );
     }
+
     /**
      * Update the DNS zone for the given domain using the provided zone file content. 
-All parsed records are imported and then the main domain document is returned.
+     * All parsed records are imported and then the main domain document is returned.
      *
      * @param {string} domainId
      * @param {string} content