@appwrite.io/console 2.3.1 → 3.0.0

package/types/services/projects.d.ts

@@ -6,6 +6,7 @@ import { AuthMethod } from '../enums/auth-method';
 import { Scopes } from '../enums/scopes';
 import { OAuthProvider } from '../enums/o-auth-provider';
 import { PlatformType } from '../enums/platform-type';
+import { ResourceType } from '../enums/resource-type';
 import { ApiService } from '../enums/api-service';
 import { SMTPSecure } from '../enums/smtp-secure';
 import { EmailTemplateType } from '../enums/email-template-type';
@@ -991,6 +992,87 @@ export declare class Projects {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     deletePlatform(projectId: string, platformId: string): Promise<{}>;
+    /**
+     * Get a list of all the project's schedules. You can use the query params to filter your results.
+     *
+     * @param {string} params.projectId - Project unique ID.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: resourceType, resourceId, projectId, schedule, active, region
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ScheduleList>}
+     */
+    listSchedules(params: {
+        projectId: string;
+        queries?: string[];
+        total?: boolean;
+    }): Promise<Models.ScheduleList>;
+    /**
+     * Get a list of all the project's schedules. You can use the query params to filter your results.
+     *
+     * @param {string} projectId - Project unique ID.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: resourceType, resourceId, projectId, schedule, active, region
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ScheduleList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listSchedules(projectId: string, queries?: string[], total?: boolean): Promise<Models.ScheduleList>;
+    /**
+     * Create a new schedule for a resource.
+     *
+     * @param {string} params.projectId - Project unique ID.
+     * @param {ResourceType} 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 {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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Schedule>}
+     */
+    createSchedule(params: {
+        projectId: string;
+        resourceType: ResourceType;
+        resourceId: string;
+        schedule: string;
+        active?: boolean;
+        data?: object;
+    }): Promise<Models.Schedule>;
+    /**
+     * Create a new schedule for a resource.
+     *
+     * @param {string} projectId - Project unique ID.
+     * @param {ResourceType} 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 {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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Schedule>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createSchedule(projectId: string, resourceType: ResourceType, resourceId: string, schedule: string, active?: boolean, data?: object): Promise<Models.Schedule>;
+    /**
+     * Get a schedule by its unique ID.
+     *
+     * @param {string} params.projectId - Project unique ID.
+     * @param {string} params.scheduleId - Schedule ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Schedule>}
+     */
+    getSchedule(params: {
+        projectId: string;
+        scheduleId: string;
+    }): Promise<Models.Schedule>;
+    /**
+     * Get a schedule by its unique ID.
+     *
+     * @param {string} projectId - Project unique ID.
+     * @param {string} scheduleId - Schedule ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Schedule>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getSchedule(projectId: string, scheduleId: string): Promise<Models.Schedule>;
     /**
      * Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
      *