@appwrite.io/console 1.6.0 → 1.7.0

package/src/services/project.ts

@@ -40,7 +40,6 @@ export class Project {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -62,7 +61,6 @@ export class Project {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -77,10 +75,11 @@ export class Project {
      *
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    createVariable(key: string, value: string): Promise<Models.Variable> {
+    createVariable(key: string, value: string, secret?: boolean): Promise<Models.Variable> {
         if (typeof key === 'undefined') {
             throw new AppwriteException('Missing required parameter: "key"');
         }
@@ -95,6 +94,9 @@ export class Project {
         if (typeof value !== 'undefined') {
             payload['value'] = value;
         }
+        if (typeof secret !== 'undefined') {
+            payload['secret'] = secret;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
@@ -124,7 +126,6 @@ export class Project {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -140,10 +141,11 @@ export class Project {
      * @param {string} variableId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    updateVariable(variableId: string, key: string, value?: string): Promise<Models.Variable> {
+    updateVariable(variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable> {
         if (typeof variableId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "variableId"');
         }
@@ -158,6 +160,9 @@ export class Project {
         if (typeof value !== 'undefined') {
             payload['value'] = value;
         }
+        if (typeof secret !== 'undefined') {
+            payload['secret'] = secret;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {

package/src/services/projects.ts

@@ -40,7 +40,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -149,7 +148,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -675,6 +673,178 @@ 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.'
+     *
+     * @param {string} projectId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKeyList>}
+     */
+    listDevKeys(projectId: string, queries?: string[]): Promise<Models.DevKeyList> {
+        if (typeof projectId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "projectId"');
+        }
+        const apiPath = '/projects/{projectId}/dev-keys'.replace('{projectId}', projectId);
+        const payload: Payload = {};
+        if (typeof queries !== 'undefined') {
+            payload['queries'] = queries;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+        }
+
+        return this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            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.
+     *
+     * @param {string} projectId
+     * @param {string} name
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKey>}
+     */
+    createDevKey(projectId: string, name: string, expire: string): Promise<Models.DevKey> {
+        if (typeof projectId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "projectId"');
+        }
+        if (typeof name === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "name"');
+        }
+        if (typeof expire === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "expire"');
+        }
+        const apiPath = '/projects/{projectId}/dev-keys'.replace('{projectId}', projectId);
+        const payload: Payload = {};
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+        if (typeof expire !== 'undefined') {
+            payload['expire'] = expire;
+        }
+        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 project\&#039;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.
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKey>}
+     */
+    getDevKey(projectId: string, keyId: string): Promise<Models.DevKey> {
+        if (typeof projectId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "projectId"');
+        }
+        if (typeof keyId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "keyId"');
+        }
+        const apiPath = '/projects/{projectId}/dev-keys/{keyId}'.replace('{projectId}', projectId).replace('{keyId}', keyId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+        }
+
+        return this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+    /**
+     * Update a project\&#039;s dev key by its unique ID. Use this endpoint to update a project\&#039;s dev key name or expiration time.&#039;
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @param {string} name
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKey>}
+     */
+    updateDevKey(projectId: string, keyId: string, name: string, expire: string): Promise<Models.DevKey> {
+        if (typeof projectId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "projectId"');
+        }
+        if (typeof keyId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "keyId"');
+        }
+        if (typeof name === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "name"');
+        }
+        if (typeof expire === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "expire"');
+        }
+        const apiPath = '/projects/{projectId}/dev-keys/{keyId}'.replace('{projectId}', projectId).replace('{keyId}', keyId);
+        const payload: Payload = {};
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+        if (typeof expire !== 'undefined') {
+            payload['expire'] = expire;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'put',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+    /**
+     * Delete a project\&#039;s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteDevKey(projectId: string, keyId: string): Promise<{}> {
+        if (typeof projectId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "projectId"');
+        }
+        if (typeof keyId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "keyId"');
+        }
+        const apiPath = '/projects/{projectId}/dev-keys/{keyId}'.replace('{projectId}', projectId).replace('{keyId}', keyId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'delete',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. 
      *
@@ -728,7 +898,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -802,7 +971,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -951,7 +1119,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -1033,7 +1200,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -1391,7 +1557,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -1519,7 +1684,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -1620,7 +1784,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -1716,7 +1879,6 @@ export class Projects {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(

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;
@@ -30,7 +30,6 @@ export class Proxy {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -41,31 +40,143 @@ export class Proxy {
         );
     }
     /**
-     * Create a new proxy rule.
+     * Create a new proxy rule for serving Appwrite's API on custom domain.
      *
      * @param {string} domain
-     * @param {ResourceType} resourceType
-     * @param {string} resourceId
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      */
-    createRule(domain: string, resourceType: ResourceType, resourceId?: string): Promise<Models.ProxyRule> {
+    createAPIRule(domain: 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"');
+        const apiPath = '/proxy/rules/api';
+        const payload: Payload = {};
+        if (typeof domain !== 'undefined') {
+            payload['domain'] = domain;
         }
-        const apiPath = '/proxy/rules';
+        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 {string} functionId
+     * @param {string} branch
+     * @throws {AppwriteException}
+     * @returns {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 functionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "functionId"');
+        }
+        const apiPath = '/proxy/rules/function';
+        const payload: Payload = {};
+        if (typeof domain !== 'undefined') {
+            payload['domain'] = domain;
+        }
+        if (typeof functionId !== 'undefined') {
+            payload['functionId'] = functionId;
+        }
+        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
+        );
+    }
+    /**
+     * 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 this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+    /**
+     * 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 resourceType !== 'undefined') {
-            payload['resourceType'] = resourceType;
+        if (typeof siteId !== 'undefined') {
+            payload['siteId'] = siteId;
         }
-        if (typeof resourceId !== 'undefined') {
-            payload['resourceId'] = resourceId;
+        if (typeof branch !== 'undefined') {
+            payload['branch'] = branch;
         }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
@@ -96,7 +207,6 @@ export class Proxy {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(