@appwrite.io/console 1.8.0 → 1.10.0

package/src/services/projects.ts

@@ -49,6 +49,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Create a new project. You can create a maximum of 100 projects per account. 
      *
@@ -132,6 +133,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. 
      *
@@ -157,6 +159,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update a project by its unique ID.
      *
@@ -226,6 +229,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Delete a project by its unique ID.
      *
@@ -252,6 +256,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
      *
@@ -292,6 +297,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
      *
@@ -325,6 +331,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update how long sessions created within a project should stay active for.
      *
@@ -358,6 +365,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the maximum number of users allowed in this project. Set to 0 for unlimited users. 
      *
@@ -391,6 +399,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
      *
@@ -424,6 +433,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status. 
      *
@@ -471,6 +481,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development. 
      *
@@ -504,6 +515,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords. 
      *
@@ -537,6 +549,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
      *
@@ -570,6 +583,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords. 
      *
@@ -603,6 +617,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
      *
@@ -636,6 +651,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project. 
      *
@@ -673,6 +689,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * List all the project\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'
      *
@@ -702,6 +719,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.
      *
@@ -742,6 +760,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a project\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
      *
@@ -771,6 +790,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update a project\'s dev key by its unique ID. Use this endpoint to update a project\'s dev key name or expiration time.'
      *
@@ -815,6 +835,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Delete a project\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
      *
@@ -845,6 +866,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. 
      *
@@ -882,6 +904,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a list of all API keys from the current project. 
      *
@@ -907,6 +930,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
      *
@@ -951,6 +975,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
      *
@@ -980,6 +1005,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key. 
      *
@@ -1028,6 +1054,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls. 
      *
@@ -1058,6 +1085,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers. 
      *
@@ -1103,6 +1131,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations. 
      *
@@ -1128,6 +1157,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
      *
@@ -1180,6 +1210,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations. 
      *
@@ -1209,6 +1240,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname. 
      *
@@ -1258,6 +1290,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project. 
      *
@@ -1288,6 +1321,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the status of a specific service. Use this endpoint to enable or disable a service in your project. 
      *
@@ -1328,6 +1362,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the status of all services. Use this endpoint to enable or disable all optional services at once. 
      *
@@ -1361,6 +1396,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails. 
      *
@@ -1426,6 +1462,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Send a test email to verify SMTP configuration. 
      *
@@ -1500,6 +1537,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the team ID of a project allowing for it to be transferred to another team.
      *
@@ -1533,6 +1571,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details. 
      *
@@ -1566,6 +1605,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
      *
@@ -1626,6 +1666,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state. 
      *
@@ -1660,6 +1701,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a custom SMS template for the specified locale and type returning it's contents.
      *
@@ -1693,6 +1735,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. 
      *
@@ -1734,6 +1777,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. 
      *
@@ -1768,6 +1812,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a list of all webhooks belonging to the project. You can use the query params to filter your results. 
      *
@@ -1793,6 +1838,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur. 
      *
@@ -1859,6 +1905,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. 
      *
@@ -1888,6 +1935,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook. 
      *
@@ -1958,6 +2006,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. 
      *
@@ -1988,6 +2037,7 @@ export class Projects {
             payload
         );
     }
+
     /**
      * Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook. 
      *

package/src/services/proxy.ts

@@ -2,6 +2,7 @@ import { Service } from '../service';
 import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
 import type { Models } from '../models';
 import { StatusCode } from '../enums/status-code';
+import { ProxyResourceType } from '../enums/proxy-resource-type';
 
 export class Proxy {
     client: Client;
@@ -39,6 +40,7 @@ export class Proxy {
             payload
         );
     }
+
     /**
      * Create a new proxy rule for serving Appwrite's API on custom domain.
      *
@@ -68,6 +70,7 @@ export class Proxy {
             payload
         );
     }
+
     /**
      * Create a new proxy rule for executing Appwrite Function on custom domain.
      *
@@ -108,16 +111,19 @@ export class Proxy {
             payload
         );
     }
+
     /**
      * Create a new proxy rule for to redirect from custom domain to another domain.
      *
      * @param {string} domain
      * @param {string} url
      * @param {StatusCode} statusCode
+     * @param {string} resourceId
+     * @param {ProxyResourceType} resourceType
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      */
-    createRedirectRule(domain: string, url: string, statusCode: StatusCode): Promise<Models.ProxyRule> {
+    createRedirectRule(domain: string, url: string, statusCode: StatusCode, resourceId: string, resourceType: ProxyResourceType): Promise<Models.ProxyRule> {
         if (typeof domain === 'undefined') {
             throw new AppwriteException('Missing required parameter: "domain"');
         }
@@ -127,6 +133,12 @@ export class Proxy {
         if (typeof statusCode === 'undefined') {
             throw new AppwriteException('Missing required parameter: "statusCode"');
         }
+        if (typeof resourceId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "resourceId"');
+        }
+        if (typeof resourceType === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "resourceType"');
+        }
         const apiPath = '/proxy/rules/redirect';
         const payload: Payload = {};
         if (typeof domain !== 'undefined') {
@@ -138,6 +150,12 @@ export class Proxy {
         if (typeof statusCode !== 'undefined') {
             payload['statusCode'] = statusCode;
         }
+        if (typeof resourceId !== 'undefined') {
+            payload['resourceId'] = resourceId;
+        }
+        if (typeof resourceType !== 'undefined') {
+            payload['resourceType'] = resourceType;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
@@ -151,6 +169,7 @@ export class Proxy {
             payload
         );
     }
+
     /**
      * Create a new proxy rule for serving Appwrite Site on custom domain.
      *
@@ -191,6 +210,7 @@ export class Proxy {
             payload
         );
     }
+
     /**
      * Get a proxy rule by its unique ID.
      *
@@ -216,6 +236,7 @@ export class Proxy {
             payload
         );
     }
+
     /**
      * Delete a proxy rule by its unique ID.
      *
@@ -242,6 +263,7 @@ export class Proxy {
             payload
         );
     }
+
     /**
      * Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.
      *

package/src/services/sites.ts

@@ -44,6 +44,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Create a new site.
      *
@@ -150,6 +151,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Get a list of all frameworks that are currently available on the server instance.
      *
@@ -171,6 +173,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * List allowed site specifications for this instance.
      *
@@ -192,6 +195,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
      *
@@ -229,6 +233,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Get a site template using ID. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
      *
@@ -254,6 +259,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Get usage metrics and statistics for all sites in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
      *
@@ -279,6 +285,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Get a site by its unique ID.
      *
@@ -304,6 +311,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Update site by its unique ID.
      *
@@ -404,6 +412,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Delete a site by its unique ID.
      *
@@ -430,6 +439,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.
      *
@@ -463,6 +473,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Get a list of all the site's code deployments. You can use the query params to filter your results.
      *
@@ -496,6 +507,7 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the function's deployment to use your new deployment ID.
      *
@@ -549,6 +561,7 @@ export class Sites {
             onProgress
         );
     }
+
     /**
      * Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.
      *
@@ -582,10 +595,11 @@ export class Sites {
             payload
         );
     }
+
     /**
      * Create a deployment based on a template.
-
-Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/sites#listTemplates) to find the template details.
+     * 
+     * Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/sites#listTemplates) to find the template details.
      *
      * @param {string} siteId
      * @param {string} repository
@@ -642,10 +656,11 @@ Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/s
             payload
         );
     }
+
     /**
      * Create a deployment when a site is connected to VCS.
-
-This endpoint lets you create deployment from a branch, commit, or a tag.
+     * 
+     * This endpoint lets you create deployment from a branch, commit, or a tag.
      *
      * @param {string} siteId
      * @param {VCSDeploymentType} type
@@ -688,6 +703,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a site deployment by its unique ID.
      *
@@ -717,6 +733,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Delete a site deployment by its unique ID.
      *
@@ -747,6 +764,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
      *
@@ -781,6 +799,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
         
         return uri.toString();
     }
+
     /**
      * Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.
      *
@@ -811,6 +830,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a list of all site logs. You can use the query params to filter your results.
      *
@@ -840,6 +860,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a site request log by its unique ID.
      *
@@ -869,6 +890,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Delete a site log by its unique ID.
      *
@@ -899,6 +921,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get usage metrics and statistics for a for a specific site. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
      *
@@ -928,6 +951,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a list of all variables of a specific site.
      *
@@ -953,6 +977,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.
      *
@@ -997,6 +1022,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a variable by its unique ID.
      *
@@ -1026,6 +1052,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Update variable by its unique ID.
      *
@@ -1071,6 +1098,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Delete a variable by its unique ID.
      *