@appwrite.io/console 2.3.1 → 3.0.0

package/docs/examples/projects/create-schedule.md

@@ -0,0 +1,20 @@
+```javascript
+import { Client, Projects, ResourceType } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const projects = new Projects(client);
+
+const result = await projects.createSchedule({
+    projectId: '<PROJECT_ID>',
+    resourceType: ResourceType.Function,
+    resourceId: '<RESOURCE_ID>',
+    schedule: '',
+    active: false, // optional
+    data: {} // optional
+});
+
+console.log(result);
+```

package/docs/examples/projects/get-schedule.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, Projects } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const projects = new Projects(client);
+
+const result = await projects.getSchedule({
+    projectId: '<PROJECT_ID>',
+    scheduleId: '<SCHEDULE_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/projects/list-schedules.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, Projects } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const projects = new Projects(client);
+
+const result = await projects.listSchedules({
+    projectId: '<PROJECT_ID>',
+    queries: [], // optional
+    total: false // optional
+});
+
+console.log(result);
+```

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": "2.3.1",
+  "version": "3.0.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
@@ -25,8 +25,7 @@
     "build:libs": "rollup -c"
   },
   "dependencies": {
-    "json-bigint": "1.0.0",
-    "bignumber.js": "9.0.0"
+    "json-bigint": "1.0.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "22.0.0",

package/src/channel.ts

@@ -78,6 +78,10 @@ export class Channel<T> {
     return this.resolve("create");
   }
 
+  upsert(this: Channel<Document | Row>): Channel<Resolved> {
+    return this.resolve("upsert");
+  }
+
   update(this: Channel<Actionable>): Channel<Resolved> {
     return this.resolve("update");
   }

package/src/client.ts

@@ -2,15 +2,23 @@ import { Models } from './models';
 import { Channel, ActionableChannel, ResolvedChannel } from './channel';
 import { Query } from './query';
 import JSONbigModule from 'json-bigint';
-import BigNumber from 'bignumber.js';
 const JSONbigParser = JSONbigModule({ storeAsString: false });
 const JSONbigSerializer = JSONbigModule({ useNativeBigInt: true });
 
 const MAX_SAFE = BigInt(Number.MAX_SAFE_INTEGER);
 const MIN_SAFE = BigInt(Number.MIN_SAFE_INTEGER);
 
+function isBigNumber(value: any): boolean {
+    return value !== null
+        && typeof value === 'object'
+        && value._isBigNumber === true
+        && typeof value.isInteger === 'function'
+        && typeof value.toFixed === 'function'
+        && typeof value.toNumber === 'function';
+}
+
 function reviver(_key: string, value: any): any {
-    if (BigNumber.isBigNumber(value)) {
+    if (isBigNumber(value)) {
         if (value.isInteger()) {
             const str = value.toFixed();
             const bi = BigInt(str);
@@ -387,7 +395,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '2.3.1',
+        'x-sdk-version': '3.0.0',
         'X-Appwrite-Response-Format': '1.8.0',
     };
 

package/src/enums/build-runtime.ts

@@ -6,24 +6,35 @@ export enum BuildRuntime {
     Node200 = 'node-20.0',
     Node210 = 'node-21.0',
     Node22 = 'node-22',
+    Node23 = 'node-23',
+    Node24 = 'node-24',
+    Node25 = 'node-25',
     Php80 = 'php-8.0',
     Php81 = 'php-8.1',
     Php82 = 'php-8.2',
     Php83 = 'php-8.3',
+    Php84 = 'php-8.4',
     Ruby30 = 'ruby-3.0',
     Ruby31 = 'ruby-3.1',
     Ruby32 = 'ruby-3.2',
     Ruby33 = 'ruby-3.3',
+    Ruby34 = 'ruby-3.4',
+    Ruby40 = 'ruby-4.0',
     Python38 = 'python-3.8',
     Python39 = 'python-3.9',
     Python310 = 'python-3.10',
     Python311 = 'python-3.11',
     Python312 = 'python-3.12',
+    Python313 = 'python-3.13',
+    Python314 = 'python-3.14',
     Pythonml311 = 'python-ml-3.11',
     Pythonml312 = 'python-ml-3.12',
+    Pythonml313 = 'python-ml-3.13',
     Deno140 = 'deno-1.40',
     Deno146 = 'deno-1.46',
     Deno20 = 'deno-2.0',
+    Deno25 = 'deno-2.5',
+    Deno26 = 'deno-2.6',
     Dart215 = 'dart-2.15',
     Dart216 = 'dart-2.16',
     Dart217 = 'dart-2.17',
@@ -39,25 +50,34 @@ export enum BuildRuntime {
     Dotnet60 = 'dotnet-6.0',
     Dotnet70 = 'dotnet-7.0',
     Dotnet80 = 'dotnet-8.0',
+    Dotnet10 = 'dotnet-10',
     Java80 = 'java-8.0',
     Java110 = 'java-11.0',
     Java170 = 'java-17.0',
     Java180 = 'java-18.0',
     Java210 = 'java-21.0',
     Java22 = 'java-22',
+    Java25 = 'java-25',
     Swift55 = 'swift-5.5',
     Swift58 = 'swift-5.8',
     Swift59 = 'swift-5.9',
     Swift510 = 'swift-5.10',
+    Swift62 = 'swift-6.2',
     Kotlin16 = 'kotlin-1.6',
     Kotlin18 = 'kotlin-1.8',
     Kotlin19 = 'kotlin-1.9',
     Kotlin20 = 'kotlin-2.0',
+    Kotlin23 = 'kotlin-2.3',
     Cpp17 = 'cpp-17',
     Cpp20 = 'cpp-20',
     Bun10 = 'bun-1.0',
     Bun11 = 'bun-1.1',
+    Bun12 = 'bun-1.2',
+    Bun13 = 'bun-1.3',
     Go123 = 'go-1.23',
+    Go124 = 'go-1.24',
+    Go125 = 'go-1.25',
+    Go126 = 'go-1.26',
     Static1 = 'static-1',
     Flutter324 = 'flutter-3.24',
     Flutter327 = 'flutter-3.27',

package/src/enums/email-template-type.ts

@@ -1,9 +1,9 @@
 export enum EmailTemplateType {
     Verification = 'verification',
-    Magicsession = 'magicsession',
+    MagicSession = 'magicSession',
     Recovery = 'recovery',
     Invitation = 'invitation',
-    Mfachallenge = 'mfachallenge',
-    Sessionalert = 'sessionalert',
-    Otpsession = 'otpsession',
+    MfaChallenge = 'mfaChallenge',
+    SessionAlert = 'sessionAlert',
+    OtpSession = 'otpSession',
 }

package/src/enums/o-auth-provider.ts

@@ -38,6 +38,4 @@ export enum OAuthProvider {
     Yandex = 'yandex',
     Zoho = 'zoho',
     Zoom = 'zoom',
-    GithubImagine = 'githubImagine',
-    GoogleImagine = 'googleImagine',
 }

package/src/enums/resource-type.ts

@@ -0,0 +1,6 @@
+export enum ResourceType {
+    Function = 'function',
+    Execution = 'execution',
+    Message = 'message',
+    Backup = 'backup',
+}

package/src/enums/runtime.ts

@@ -6,24 +6,35 @@ export enum Runtime {
     Node200 = 'node-20.0',
     Node210 = 'node-21.0',
     Node22 = 'node-22',
+    Node23 = 'node-23',
+    Node24 = 'node-24',
+    Node25 = 'node-25',
     Php80 = 'php-8.0',
     Php81 = 'php-8.1',
     Php82 = 'php-8.2',
     Php83 = 'php-8.3',
+    Php84 = 'php-8.4',
     Ruby30 = 'ruby-3.0',
     Ruby31 = 'ruby-3.1',
     Ruby32 = 'ruby-3.2',
     Ruby33 = 'ruby-3.3',
+    Ruby34 = 'ruby-3.4',
+    Ruby40 = 'ruby-4.0',
     Python38 = 'python-3.8',
     Python39 = 'python-3.9',
     Python310 = 'python-3.10',
     Python311 = 'python-3.11',
     Python312 = 'python-3.12',
+    Python313 = 'python-3.13',
+    Python314 = 'python-3.14',
     Pythonml311 = 'python-ml-3.11',
     Pythonml312 = 'python-ml-3.12',
+    Pythonml313 = 'python-ml-3.13',
     Deno140 = 'deno-1.40',
     Deno146 = 'deno-1.46',
     Deno20 = 'deno-2.0',
+    Deno25 = 'deno-2.5',
+    Deno26 = 'deno-2.6',
     Dart215 = 'dart-2.15',
     Dart216 = 'dart-2.16',
     Dart217 = 'dart-2.17',
@@ -39,25 +50,34 @@ export enum Runtime {
     Dotnet60 = 'dotnet-6.0',
     Dotnet70 = 'dotnet-7.0',
     Dotnet80 = 'dotnet-8.0',
+    Dotnet10 = 'dotnet-10',
     Java80 = 'java-8.0',
     Java110 = 'java-11.0',
     Java170 = 'java-17.0',
     Java180 = 'java-18.0',
     Java210 = 'java-21.0',
     Java22 = 'java-22',
+    Java25 = 'java-25',
     Swift55 = 'swift-5.5',
     Swift58 = 'swift-5.8',
     Swift59 = 'swift-5.9',
     Swift510 = 'swift-5.10',
+    Swift62 = 'swift-6.2',
     Kotlin16 = 'kotlin-1.6',
     Kotlin18 = 'kotlin-1.8',
     Kotlin19 = 'kotlin-1.9',
     Kotlin20 = 'kotlin-2.0',
+    Kotlin23 = 'kotlin-2.3',
     Cpp17 = 'cpp-17',
     Cpp20 = 'cpp-20',
     Bun10 = 'bun-1.0',
     Bun11 = 'bun-1.1',
+    Bun12 = 'bun-1.2',
+    Bun13 = 'bun-1.3',
     Go123 = 'go-1.23',
+    Go124 = 'go-1.24',
+    Go125 = 'go-1.25',
+    Go126 = 'go-1.26',
     Static1 = 'static-1',
     Flutter324 = 'flutter-3.24',
     Flutter327 = 'flutter-3.27',

package/src/enums/runtimes.ts

@@ -6,24 +6,35 @@ export enum Runtimes {
     Node200 = 'node-20.0',
     Node210 = 'node-21.0',
     Node22 = 'node-22',
+    Node23 = 'node-23',
+    Node24 = 'node-24',
+    Node25 = 'node-25',
     Php80 = 'php-8.0',
     Php81 = 'php-8.1',
     Php82 = 'php-8.2',
     Php83 = 'php-8.3',
+    Php84 = 'php-8.4',
     Ruby30 = 'ruby-3.0',
     Ruby31 = 'ruby-3.1',
     Ruby32 = 'ruby-3.2',
     Ruby33 = 'ruby-3.3',
+    Ruby34 = 'ruby-3.4',
+    Ruby40 = 'ruby-4.0',
     Python38 = 'python-3.8',
     Python39 = 'python-3.9',
     Python310 = 'python-3.10',
     Python311 = 'python-3.11',
     Python312 = 'python-3.12',
+    Python313 = 'python-3.13',
+    Python314 = 'python-3.14',
     Pythonml311 = 'python-ml-3.11',
     Pythonml312 = 'python-ml-3.12',
+    Pythonml313 = 'python-ml-3.13',
     Deno140 = 'deno-1.40',
     Deno146 = 'deno-1.46',
     Deno20 = 'deno-2.0',
+    Deno25 = 'deno-2.5',
+    Deno26 = 'deno-2.6',
     Dart215 = 'dart-2.15',
     Dart216 = 'dart-2.16',
     Dart217 = 'dart-2.17',
@@ -39,25 +50,34 @@ export enum Runtimes {
     Dotnet60 = 'dotnet-6.0',
     Dotnet70 = 'dotnet-7.0',
     Dotnet80 = 'dotnet-8.0',
+    Dotnet10 = 'dotnet-10',
     Java80 = 'java-8.0',
     Java110 = 'java-11.0',
     Java170 = 'java-17.0',
     Java180 = 'java-18.0',
     Java210 = 'java-21.0',
     Java22 = 'java-22',
+    Java25 = 'java-25',
     Swift55 = 'swift-5.5',
     Swift58 = 'swift-5.8',
     Swift59 = 'swift-5.9',
     Swift510 = 'swift-5.10',
+    Swift62 = 'swift-6.2',
     Kotlin16 = 'kotlin-1.6',
     Kotlin18 = 'kotlin-1.8',
     Kotlin19 = 'kotlin-1.9',
     Kotlin20 = 'kotlin-2.0',
+    Kotlin23 = 'kotlin-2.3',
     Cpp17 = 'cpp-17',
     Cpp20 = 'cpp-20',
     Bun10 = 'bun-1.0',
     Bun11 = 'bun-1.1',
+    Bun12 = 'bun-1.2',
+    Bun13 = 'bun-1.3',
     Go123 = 'go-1.23',
+    Go124 = 'go-1.24',
+    Go125 = 'go-1.25',
+    Go126 = 'go-1.26',
     Static1 = 'static-1',
     Flutter324 = 'flutter-3.24',
     Flutter327 = 'flutter-3.27',

package/src/enums/scopes.ts

@@ -47,6 +47,8 @@ export enum Scopes {
     TargetsWrite = 'targets.write',
     RulesRead = 'rules.read',
     RulesWrite = 'rules.write',
+    SchedulesRead = 'schedules.read',
+    SchedulesWrite = 'schedules.write',
     MigrationsRead = 'migrations.read',
     MigrationsWrite = 'migrations.write',
     VcsRead = 'vcs.read',

package/src/enums/sms-template-type.ts

@@ -2,5 +2,5 @@ export enum SmsTemplateType {
     Verification = 'verification',
     Login = 'login',
     Invitation = 'invitation',
-    Mfachallenge = 'mfachallenge',
+    MfaChallenge = 'mfaChallenge',
 }

package/src/index.ts

@@ -33,6 +33,7 @@ export { Users } from './services/users';
 export { Vcs } from './services/vcs';
 export { Realtime } from './services/realtime';
 export type { Models, Payload, RealtimeResponseEvent, UploadProgress } from './client';
+export type { RealtimeSubscription } from './services/realtime';
 export type { QueryTypes, QueryTypesList } from './query';
 export { Permission } from './permission';
 export { Role } from './role';
@@ -76,6 +77,7 @@ export { Region } from './enums/region';
 export { Api } from './enums/api';
 export { AuthMethod } from './enums/auth-method';
 export { PlatformType } from './enums/platform-type';
+export { ResourceType } from './enums/resource-type';
 export { ApiService } from './enums/api-service';
 export { SMTPSecure } from './enums/smtp-secure';
 export { EmailTemplateType } from './enums/email-template-type';

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
      */
@@ -4643,6 +4657,10 @@ export namespace Models {
          * Labels for the project.
          */
         labels: string[];
+        /**
+         * Project status
+         */
+        status: string;
         /**
          * Email/Password auth method status
          */
@@ -4727,10 +4745,6 @@ export namespace Models {
          * Project region
          */
         region: string;
-        /**
-         * Project status
-         */
-        status: string;
         /**
          * Billing limits reached
          */
@@ -6221,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
      */

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.