@appwrite.io/console 1.5.2 → 1.7.0

package/src/services/proxy.ts

@@ -1,7 +1,7 @@
 import { Service } from '../service';
 import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
 import type { Models } from '../models';
-import { ResourceType } from '../enums/resource-type';
+import { StatusCode } from '../enums/status-code';
 
 export class Proxy {
     client: Client;
@@ -11,8 +11,6 @@ export class Proxy {
     }
 
     /**
-     * List rules
-     *
      * Get a list of all the proxy rules. You can use the query params to filter your results.
      *
      * @param {string[]} queries
@@ -20,7 +18,7 @@ export class Proxy {
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRuleList>}
      */
-    async listRules(queries?: string[], search?: string): Promise<Models.ProxyRuleList> {
+    listRules(queries?: string[], search?: string): Promise<Models.ProxyRuleList> {
         const apiPath = '/proxy/rules';
         const payload: Payload = {};
         if (typeof queries !== 'undefined') {
@@ -32,13 +30,9 @@ export class Proxy {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'get',
             uri,
             apiHeaders,
@@ -46,33 +40,60 @@ export class Proxy {
         );
     }
     /**
-     * Create rule
+     * Create a new proxy rule for serving Appwrite&#039;s API on custom domain.
      *
-     * Create a new proxy rule.
+     * @param {string} domain
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ProxyRule>}
+     */
+    createAPIRule(domain: string): Promise<Models.ProxyRule> {
+        if (typeof domain === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "domain"');
+        }
+        const apiPath = '/proxy/rules/api';
+        const payload: Payload = {};
+        if (typeof domain !== 'undefined') {
+            payload['domain'] = domain;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+    /**
+     * Create a new proxy rule for executing Appwrite Function on custom domain.
      *
      * @param {string} domain
-     * @param {ResourceType} resourceType
-     * @param {string} resourceId
+     * @param {string} functionId
+     * @param {string} branch
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      */
-    async createRule(domain: string, resourceType: ResourceType, resourceId?: string): Promise<Models.ProxyRule> {
+    createFunctionRule(domain: string, functionId: string, branch?: string): Promise<Models.ProxyRule> {
         if (typeof domain === 'undefined') {
             throw new AppwriteException('Missing required parameter: "domain"');
         }
-        if (typeof resourceType === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "resourceType"');
+        if (typeof functionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "functionId"');
         }
-        const apiPath = '/proxy/rules';
+        const apiPath = '/proxy/rules/function';
         const payload: Payload = {};
         if (typeof domain !== 'undefined') {
             payload['domain'] = domain;
         }
-        if (typeof resourceType !== 'undefined') {
-            payload['resourceType'] = resourceType;
+        if (typeof functionId !== 'undefined') {
+            payload['functionId'] = functionId;
         }
-        if (typeof resourceId !== 'undefined') {
-            payload['resourceId'] = resourceId;
+        if (typeof branch !== 'undefined') {
+            payload['branch'] = branch;
         }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
@@ -80,10 +101,50 @@ export class Proxy {
             'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
+        return this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+    /**
+     * Create a new proxy rule for to redirect from custom domain to another domain.
+     *
+     * @param {string} domain
+     * @param {string} url
+     * @param {StatusCode} statusCode
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ProxyRule>}
+     */
+    createRedirectRule(domain: string, url: string, statusCode: StatusCode): Promise<Models.ProxyRule> {
+        if (typeof domain === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "domain"');
+        }
+        if (typeof url === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "url"');
+        }
+        if (typeof statusCode === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "statusCode"');
+        }
+        const apiPath = '/proxy/rules/redirect';
+        const payload: Payload = {};
+        if (typeof domain !== 'undefined') {
+            payload['domain'] = domain;
+        }
+        if (typeof url !== 'undefined') {
+            payload['url'] = url;
+        }
+        if (typeof statusCode !== 'undefined') {
+            payload['statusCode'] = statusCode;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
 
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
 
-        return await this.client.call(
+        return this.client.call(
             'post',
             uri,
             apiHeaders,
@@ -91,15 +152,53 @@ export class Proxy {
         );
     }
     /**
-     * Get rule
+     * Create a new proxy rule for serving Appwrite Site on custom domain.
      *
+     * @param {string} domain
+     * @param {string} siteId
+     * @param {string} branch
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ProxyRule>}
+     */
+    createSiteRule(domain: string, siteId: string, branch?: string): Promise<Models.ProxyRule> {
+        if (typeof domain === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "domain"');
+        }
+        if (typeof siteId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "siteId"');
+        }
+        const apiPath = '/proxy/rules/site';
+        const payload: Payload = {};
+        if (typeof domain !== 'undefined') {
+            payload['domain'] = domain;
+        }
+        if (typeof siteId !== 'undefined') {
+            payload['siteId'] = siteId;
+        }
+        if (typeof branch !== 'undefined') {
+            payload['branch'] = branch;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+    /**
      * Get a proxy rule by its unique ID.
      *
      * @param {string} ruleId
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      */
-    async getRule(ruleId: string): Promise<Models.ProxyRule> {
+    getRule(ruleId: string): Promise<Models.ProxyRule> {
         if (typeof ruleId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "ruleId"');
         }
@@ -108,13 +207,9 @@ export class Proxy {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'get',
             uri,
             apiHeaders,
@@ -122,15 +217,13 @@ export class Proxy {
         );
     }
     /**
-     * Delete rule
-     *
      * Delete a proxy rule by its unique ID.
      *
      * @param {string} ruleId
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
-    async deleteRule(ruleId: string): Promise<{}> {
+    deleteRule(ruleId: string): Promise<{}> {
         if (typeof ruleId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "ruleId"');
         }
@@ -142,10 +235,7 @@ export class Proxy {
             'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'delete',
             uri,
             apiHeaders,
@@ -153,15 +243,13 @@ export class Proxy {
         );
     }
     /**
-     * Update rule verification status
-     *
      * 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.
      *
      * @param {string} ruleId
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      */
-    async updateRuleVerification(ruleId: string): Promise<Models.ProxyRule> {
+    updateRuleVerification(ruleId: string): Promise<Models.ProxyRule> {
         if (typeof ruleId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "ruleId"');
         }
@@ -173,10 +261,7 @@ export class Proxy {
             'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'patch',
             uri,
             apiHeaders,