@appwrite.io/console 2.3.0 → 3.0.0

package/src/models.ts

@@ -594,6 +594,20 @@ export namespace Models {
         rules: ProxyRule[];
     }
 
+    /**
+     * Schedules List
+     */
+    export type ScheduleList = {
+        /**
+         * Total number of schedules that matched your query.
+         */
+        total: number;
+        /**
+         * List of schedules.
+         */
+        schedules: Schedule[];
+    }
+
     /**
      * Locale codes list
      */
@@ -811,7 +825,7 @@ export namespace Models {
         /**
          * Collection attributes.
          */
-        attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
+        attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeVarchar | Models.AttributeText | Models.AttributeMediumtext | Models.AttributeLongtext | Models.AttributeString)[];
         /**
          * Collection indexes.
          */
@@ -837,7 +851,7 @@ export namespace Models {
         /**
          * List of attributes.
          */
-        attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
+        attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeVarchar | Models.AttributeText | Models.AttributeMediumtext | Models.AttributeLongtext | Models.AttributeString)[];
     }
 
     /**
@@ -1498,6 +1512,10 @@ export namespace Models {
          * Default value for attribute when not provided. Cannot be set when attribute is required.
          */
         default?: string;
+        /**
+         * Defines whether this attribute is encrypted or not.
+         */
+        encrypt?: boolean;
     }
 
     /**
@@ -1540,6 +1558,10 @@ export namespace Models {
          * Default value for attribute when not provided. Cannot be set when attribute is required.
          */
         default?: string;
+        /**
+         * Defines whether this attribute is encrypted or not.
+         */
+        encrypt?: boolean;
     }
 
     /**
@@ -1582,6 +1604,10 @@ export namespace Models {
          * Default value for attribute when not provided. Cannot be set when attribute is required.
          */
         default?: string;
+        /**
+         * Defines whether this attribute is encrypted or not.
+         */
+        encrypt?: boolean;
     }
 
     /**
@@ -1624,6 +1650,10 @@ export namespace Models {
          * Default value for attribute when not provided. Cannot be set when attribute is required.
          */
         default?: string;
+        /**
+         * Defines whether this attribute is encrypted or not.
+         */
+        encrypt?: boolean;
     }
 
     /**
@@ -2352,6 +2382,10 @@ export namespace Models {
          * Default value for column when not provided. Cannot be set when column is required.
          */
         default?: string;
+        /**
+         * Defines whether this column is encrypted or not.
+         */
+        encrypt?: boolean;
     }
 
     /**
@@ -2394,6 +2428,10 @@ export namespace Models {
          * Default value for column when not provided. Cannot be set when column is required.
          */
         default?: string;
+        /**
+         * Defines whether this column is encrypted or not.
+         */
+        encrypt?: boolean;
     }
 
     /**
@@ -2436,6 +2474,10 @@ export namespace Models {
          * Default value for column when not provided. Cannot be set when column is required.
          */
         default?: string;
+        /**
+         * Defines whether this column is encrypted or not.
+         */
+        encrypt?: boolean;
     }
 
     /**
@@ -2478,6 +2520,10 @@ export namespace Models {
          * Default value for column when not provided. Cannot be set when column is required.
          */
         default?: string;
+        /**
+         * Defines whether this column is encrypted or not.
+         */
+        encrypt?: boolean;
     }
 
     /**
@@ -4611,6 +4657,10 @@ export namespace Models {
          * Labels for the project.
          */
         labels: string[];
+        /**
+         * Project status
+         */
+        status: string;
         /**
          * Email/Password auth method status
          */
@@ -4695,10 +4745,6 @@ export namespace Models {
          * Project region
          */
         region: string;
-        /**
-         * Project status
-         */
-        status: string;
         /**
          * Billing limits reached
          */
@@ -6189,6 +6235,56 @@ export namespace Models {
         renewAt: string;
     }
 
+    /**
+     * Schedule
+     */
+    export type Schedule = {
+        /**
+         * Schedule ID.
+         */
+        $id: string;
+        /**
+         * Schedule creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Schedule update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * The resource type associated with this schedule.
+         */
+        resourceType: string;
+        /**
+         * The resource ID associated with this schedule.
+         */
+        resourceId: string;
+        /**
+         * Change-tracking timestamp used by the scheduler to detect resource changes in ISO 8601 format.
+         */
+        resourceUpdatedAt: string;
+        /**
+         * The project ID associated with this schedule.
+         */
+        projectId: string;
+        /**
+         * The CRON schedule expression.
+         */
+        schedule: string;
+        /**
+         * Schedule data used to store resource-specific context needed for execution.
+         */
+        data: object;
+        /**
+         * Whether the schedule is active.
+         */
+        active: boolean;
+        /**
+         * The region where the schedule is deployed.
+         */
+        region: string;
+    }
+
     /**
      * SmsTemplate
      */
@@ -6727,6 +6823,140 @@ export namespace Models {
         version: string;
     }
 
+    /**
+     * ActivityEvent
+     */
+    export type ActivityEvent = {
+        /**
+         * Event ID.
+         */
+        $id: string;
+        /**
+         * User type.
+         */
+        userType: string;
+        /**
+         * User ID.
+         */
+        userId: string;
+        /**
+         * User Email.
+         */
+        userEmail: string;
+        /**
+         * User Name.
+         */
+        userName: string;
+        /**
+         * Resource parent.
+         */
+        resourceParent: string;
+        /**
+         * Resource type.
+         */
+        resourceType: string;
+        /**
+         * Resource ID.
+         */
+        resourceId: string;
+        /**
+         * Resource.
+         */
+        resource: string;
+        /**
+         * Event name.
+         */
+        event: string;
+        /**
+         * User agent.
+         */
+        userAgent: string;
+        /**
+         * IP address.
+         */
+        ip: string;
+        /**
+         * API mode when event triggered.
+         */
+        mode: string;
+        /**
+         * Location.
+         */
+        country: string;
+        /**
+         * Log creation date in ISO 8601 format.
+         */
+        time: string;
+        /**
+         * Project ID.
+         */
+        projectId: string;
+        /**
+         * Team ID.
+         */
+        teamId: string;
+        /**
+         * Hostname.
+         */
+        hostname: string;
+        /**
+         * Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
+         */
+        osCode: string;
+        /**
+         * Operating system name.
+         */
+        osName: string;
+        /**
+         * Operating system version.
+         */
+        osVersion: string;
+        /**
+         * Client type.
+         */
+        clientType: string;
+        /**
+         * Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
+         */
+        clientCode: string;
+        /**
+         * Client name.
+         */
+        clientName: string;
+        /**
+         * Client version.
+         */
+        clientVersion: string;
+        /**
+         * Client engine name.
+         */
+        clientEngine: string;
+        /**
+         * Client engine name.
+         */
+        clientEngineVersion: string;
+        /**
+         * Device name.
+         */
+        deviceName: string;
+        /**
+         * Device brand name.
+         */
+        deviceBrand: string;
+        /**
+         * Device model name.
+         */
+        deviceModel: string;
+        /**
+         * Country two-character ISO 3166-1 alpha code.
+         */
+        countryCode: string;
+        /**
+         * Country name.
+         */
+        countryName: string;
+    }
+
     /**
      * AdditionalResource
      */
@@ -8645,6 +8875,20 @@ export namespace Models {
         available: boolean;
     }
 
+    /**
+     * Activity event list
+     */
+    export type ActivityEventList = {
+        /**
+         * Total number of events that matched your query.
+         */
+        total: number;
+        /**
+         * List of events.
+         */
+        events: ActivityEvent[];
+    }
+
     /**
      * Aggregation team list
      */

package/src/services/account.ts

@@ -3042,7 +3042,7 @@ export class Account {
      * A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
      * 
      *
-     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom, githubImagine, googleImagine.
+     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} params.success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} params.failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -3058,7 +3058,7 @@ export class Account {
      * A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
      * 
      *
-     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom, githubImagine, googleImagine.
+     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -3795,7 +3795,7 @@ export class Account {
      * 
      * A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
      *
-     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom, githubImagine, googleImagine.
+     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} params.success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} params.failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -3810,7 +3810,7 @@ export class Account {
      * 
      * A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
      *
-     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom, githubImagine, googleImagine.
+     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.

package/src/services/activities.ts

@@ -0,0 +1,116 @@
+import { Service } from '../service';
+import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
+import type { Models } from '../models';
+
+
+export class Activities {
+    client: Client;
+
+    constructor(client: Client) {
+        this.client = client;
+    }
+
+    /**
+     * List all events for selected filters.
+     *
+     * @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as userId, teamId, etc.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ActivityEventList>}
+     */
+    listEvents(params?: { queries?: string }): Promise<Models.ActivityEventList>;
+    /**
+     * List all events for selected filters.
+     *
+     * @param {string} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as userId, teamId, etc.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ActivityEventList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listEvents(queries?: string): Promise<Models.ActivityEventList>;
+    listEvents(
+        paramsOrFirst?: { queries?: string } | string    
+    ): Promise<Models.ActivityEventList> {
+        let params: { queries?: string };
+        
+        if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { queries?: string };
+        } else {
+            params = {
+                queries: paramsOrFirst as string            
+            };
+        }
+        
+        const queries = params.queries;
+
+
+        const apiPath = '/activities/events';
+        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
+        );
+    }
+
+    /**
+     * Get event by ID.
+     * 
+     *
+     * @param {string} params.eventId - Event ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ActivityEvent>}
+     */
+    getEvent(params: { eventId: string }): Promise<Models.ActivityEvent>;
+    /**
+     * Get event by ID.
+     * 
+     *
+     * @param {string} eventId - Event ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ActivityEvent>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getEvent(eventId: string): Promise<Models.ActivityEvent>;
+    getEvent(
+        paramsOrFirst: { eventId: string } | string    
+    ): Promise<Models.ActivityEvent> {
+        let params: { eventId: string };
+        
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { eventId: string };
+        } else {
+            params = {
+                eventId: paramsOrFirst as string            
+            };
+        }
+        
+        const eventId = params.eventId;
+
+        if (typeof eventId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "eventId"');
+        }
+
+        const apiPath = '/activities/events/{eventId}'.replace('{eventId}', eventId);
+        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
+        );
+    }
+}