@appwrite.io/console 18.3.0-rc.2 → 18.4.0-rc.1

package/dist/iife/sdk.js

@@ -4467,7 +4467,7 @@
                 'x-sdk-name': 'Console',
                 'x-sdk-platform': 'console',
                 'x-sdk-language': 'web',
-                'x-sdk-version': '18.3.0-rc.2',
+                'x-sdk-version': '18.4.0-rc.1',
                 'X-Appwrite-Response-Format': '2.3.0',
             };
             this.realtime = {
@@ -19226,6 +19226,7 @@
                     buildSpecification: rest[18],
                     runtimeSpecification: rest[19],
                     deploymentRetention: rest[20],
+                    interval: rest[21],
                 };
             }
             const functionId = params.functionId;
@@ -19250,6 +19251,7 @@
             const buildSpecification = params.buildSpecification;
             const runtimeSpecification = params.runtimeSpecification;
             const deploymentRetention = params.deploymentRetention;
+            const interval = params.interval;
             if (typeof functionId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "functionId"');
             }
@@ -19327,6 +19329,9 @@
             if (typeof deploymentRetention !== 'undefined') {
                 apiPayload['deploymentRetention'] = deploymentRetention;
             }
+            if (typeof interval !== 'undefined') {
+                apiPayload['interval'] = interval;
+            }
             const uri = new URL(this.client.config.endpoint + apiPath);
             const apiHeaders = {
                 'X-Appwrite-Project': this.client.config.project,
@@ -19524,6 +19529,7 @@
                     buildSpecification: rest[18],
                     runtimeSpecification: rest[19],
                     deploymentRetention: rest[20],
+                    interval: rest[21],
                 };
             }
             const functionId = params.functionId;
@@ -19548,6 +19554,7 @@
             const buildSpecification = params.buildSpecification;
             const runtimeSpecification = params.runtimeSpecification;
             const deploymentRetention = params.deploymentRetention;
+            const interval = params.interval;
             if (typeof functionId === 'undefined' || functionId === '') {
                 throw new AppwriteException('Missing required parameter: "functionId"');
             }
@@ -19619,6 +19626,9 @@
             if (typeof deploymentRetention !== 'undefined') {
                 apiPayload['deploymentRetention'] = deploymentRetention;
             }
+            if (typeof interval !== 'undefined') {
+                apiPayload['interval'] = interval;
+            }
             const uri = new URL(this.client.config.endpoint + apiPath);
             const apiHeaders = {
                 'X-Appwrite-Project': this.client.config.project,
@@ -37399,6 +37409,7 @@
                     schedule: rest[2],
                     active: rest[3],
                     data: rest[4],
+                    interval: rest[5],
                 };
             }
             const projectId = params.projectId;
@@ -37407,6 +37418,7 @@
             const schedule = params.schedule;
             const active = params.active;
             const data = params.data;
+            const interval = params.interval;
             if (typeof projectId === 'undefined' || projectId === '') {
                 throw new AppwriteException('Missing required parameter: "projectId"');
             }
@@ -37416,9 +37428,6 @@
             if (typeof resourceId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "resourceId"');
             }
-            if (typeof schedule === 'undefined') {
-                throw new AppwriteException('Missing required parameter: "schedule"');
-            }
             const apiPath = '/projects/{projectId}/schedules'.replace('{projectId}', encodeURIComponent(String(projectId)));
             const apiPayload = {};
             if (typeof resourceType !== 'undefined') {
@@ -37436,6 +37445,9 @@
             if (typeof data !== 'undefined') {
                 apiPayload['data'] = data;
             }
+            if (typeof interval !== 'undefined') {
+                apiPayload['interval'] = interval;
+            }
             const uri = new URL(this.client.config.endpoint + apiPath);
             const apiHeaders = {
                 'X-Appwrite-Project': this.client.config.project,

package/package.json

@@ -2,7 +2,7 @@
     "name": "@appwrite.io/console",
     "homepage": "https://appwrite.io/support",
     "description": "Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
-    "version": "18.3.0-rc.2",
+    "version": "18.4.0-rc.1",
     "license": "BSD-3-Clause",
     "main": "dist/cjs/sdk.js",
     "exports": {

package/types/models.d.ts

@@ -4380,6 +4380,10 @@ export declare namespace Models {
          * Function execution schedule in CRON format.
          */
         schedule: string;
+        /**
+         * Minutes between scheduled executions. 0 when the function has no interval.
+         */
+        interval?: number;
         /**
          * Function execution timeout in seconds.
          */
@@ -7581,6 +7585,10 @@ export declare namespace Models {
          * The CRON schedule expression.
          */
         schedule: string;
+        /**
+         * Minutes between runs. 0 when the schedule has no interval.
+         */
+        interval?: number;
         /**
          * Schedule data used to store resource-specific context needed for execution.
          */
@@ -10062,6 +10070,10 @@ export declare namespace Models {
          * Maximum function and site deployment size in MB
          */
         buildSize: number;
+        /**
+         * Shortest function schedule interval allowed, in minutes. 0 allows every interval.
+         */
+        functionsIntervalMinimum: number;
         /**
          * Does the plan support encrypted string attributes or not.
          */

package/types/services/functions.d.ts

@@ -43,7 +43,7 @@ export declare class Functions {
      * @param {Runtime} params.runtime - Execution runtime.
      * @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
      * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
-     * @param {string} params.schedule - Schedule CRON syntax.
+     * @param {string} params.schedule - Schedule CRON syntax. Cannot be combined with interval.
      * @param {number} params.timeout - Function maximum execution time in seconds.
      * @param {boolean} params.enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
      * @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
@@ -60,6 +60,7 @@ export declare class Functions {
      * @param {string} params.buildSpecification - Build specification for the function deployments.
      * @param {string} params.runtimeSpecification - Runtime specification for the function executions.
      * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+     * @param {number} params.interval - Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      */
@@ -86,6 +87,7 @@ export declare class Functions {
         buildSpecification?: string;
         runtimeSpecification?: string;
         deploymentRetention?: number;
+        interval?: number;
     }): Promise<Models.Function>;
     /**
      * Create a new function. You can pass a list of [permissions](https://appwrite.io/docs/permissions) to allow different project users or team with access to execute the function using the client API.
@@ -95,7 +97,7 @@ export declare class Functions {
      * @param {Runtime} runtime - Execution runtime.
      * @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
      * @param {string[]} events - Events list. Maximum of 100 events are allowed.
-     * @param {string} schedule - Schedule CRON syntax.
+     * @param {string} schedule - Schedule CRON syntax. Cannot be combined with interval.
      * @param {number} timeout - Function maximum execution time in seconds.
      * @param {boolean} enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
      * @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
@@ -112,11 +114,12 @@ export declare class Functions {
      * @param {string} buildSpecification - Build specification for the function deployments.
      * @param {string} runtimeSpecification - Runtime specification for the function executions.
      * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+     * @param {number} interval - Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
+    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number, interval?: number): Promise<Models.Function>;
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *
@@ -235,7 +238,7 @@ export declare class Functions {
      * @param {Runtime} params.runtime - Execution runtime.
      * @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
      * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
-     * @param {string} params.schedule - Schedule CRON syntax.
+     * @param {string} params.schedule - Schedule CRON syntax. Cannot be combined with interval.
      * @param {number} params.timeout - Maximum execution time in seconds.
      * @param {boolean} params.enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
      * @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
@@ -252,6 +255,7 @@ export declare class Functions {
      * @param {string} params.buildSpecification - Build specification for the function deployments.
      * @param {string} params.runtimeSpecification - Runtime specification for the function executions.
      * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+     * @param {number} params.interval - Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule. When omitted, the current interval is kept unless schedule is set.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      */
@@ -278,6 +282,7 @@ export declare class Functions {
         buildSpecification?: string;
         runtimeSpecification?: string;
         deploymentRetention?: number;
+        interval?: number;
     }): Promise<Models.Function>;
     /**
      * Update function by its unique ID.
@@ -287,7 +292,7 @@ export declare class Functions {
      * @param {Runtime} runtime - Execution runtime.
      * @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
      * @param {string[]} events - Events list. Maximum of 100 events are allowed.
-     * @param {string} schedule - Schedule CRON syntax.
+     * @param {string} schedule - Schedule CRON syntax. Cannot be combined with interval.
      * @param {number} timeout - Maximum execution time in seconds.
      * @param {boolean} enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
      * @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
@@ -304,11 +309,12 @@ export declare class Functions {
      * @param {string} buildSpecification - Build specification for the function deployments.
      * @param {string} runtimeSpecification - Runtime specification for the function executions.
      * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+     * @param {number} interval - Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule. When omitted, the current interval is kept unless schedule is set.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
+    update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number, interval?: number): Promise<Models.Function>;
     /**
      * Delete a function by its unique ID.
      *

package/types/services/projects.d.ts

@@ -195,9 +195,10 @@ export declare class Projects {
      * @param {string} params.projectId - Project unique ID.
      * @param {ScheduleResourceType} params.resourceType - The resource type for the schedule. Possible values: function, execution, message, backup.
      * @param {string} params.resourceId - The resource ID to associate with this schedule.
-     * @param {string} params.schedule - Schedule CRON expression.
+     * @param {string} params.schedule - Schedule CRON expression. Cannot be combined with interval.
      * @param {boolean} params.active - Whether the schedule is active.
      * @param {object} params.data - Schedule data as a JSON string. Used to store resource-specific context needed for execution.
+     * @param {number} params.interval - Minutes between runs, for function schedules only. Use 0 to disable. Cannot be combined with schedule.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Schedule>}
      */
@@ -205,9 +206,10 @@ export declare class Projects {
         projectId: string;
         resourceType: ScheduleResourceType;
         resourceId: string;
-        schedule: string;
+        schedule?: string;
         active?: boolean;
         data?: object;
+        interval?: number;
     }): Promise<Models.Schedule>;
     /**
      * Create a new schedule for a resource.
@@ -215,14 +217,15 @@ export declare class Projects {
      * @param {string} projectId - Project unique ID.
      * @param {ScheduleResourceType} resourceType - The resource type for the schedule. Possible values: function, execution, message, backup.
      * @param {string} resourceId - The resource ID to associate with this schedule.
-     * @param {string} schedule - Schedule CRON expression.
+     * @param {string} schedule - Schedule CRON expression. Cannot be combined with interval.
      * @param {boolean} active - Whether the schedule is active.
      * @param {object} data - Schedule data as a JSON string. Used to store resource-specific context needed for execution.
+     * @param {number} interval - Minutes between runs, for function schedules only. Use 0 to disable. Cannot be combined with schedule.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Schedule>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createSchedule(projectId: string, resourceType: ScheduleResourceType, resourceId: string, schedule: string, active?: boolean, data?: object): Promise<Models.Schedule>;
+    createSchedule(projectId: string, resourceType: ScheduleResourceType, resourceId: string, schedule?: string, active?: boolean, data?: object, interval?: number): Promise<Models.Schedule>;
     /**
      * Get a schedule by its unique ID.
      *