@appwrite.io/console 2.1.1 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/README.md +1 -1
- package/dist/cjs/sdk.js +99 -7
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +100 -8
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +99 -7
- package/docs/examples/domains/list-suggestions.md +18 -0
- package/docs/examples/health/get-queue-audits.md +13 -0
- package/docs/examples/organizations/create.md +2 -2
- package/docs/examples/organizations/estimation-create-organization.md +2 -2
- package/docs/examples/organizations/estimation-update-plan.md +2 -2
- package/docs/examples/organizations/update-plan.md +2 -2
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/enums/billing-plan.ts +17 -0
- package/src/enums/filter-type.ts +4 -0
- package/src/enums/name.ts +1 -0
- package/src/enums/o-auth-provider.ts +0 -2
- package/src/index.ts +2 -0
- package/src/models.ts +437 -375
- package/src/services/account.ts +20 -20
- package/src/services/avatars.ts +117 -117
- package/src/services/backups.ts +18 -18
- package/src/services/console.ts +24 -24
- package/src/services/databases.ts +89 -89
- package/src/services/domains.ts +295 -204
- package/src/services/functions.ts +30 -30
- package/src/services/health.ts +201 -152
- package/src/services/messaging.ts +54 -54
- package/src/services/migrations.ts +36 -36
- package/src/services/organizations.ts +67 -66
- package/src/services/projects.ts +81 -81
- package/src/services/sites.ts +30 -30
- package/src/services/storage.ts +45 -45
- package/src/services/tables-db.ts +89 -89
- package/src/services/users.ts +39 -39
- package/types/enums/billing-plan.d.ts +17 -0
- package/types/enums/filter-type.d.ts +4 -0
- package/types/enums/name.d.ts +1 -0
- package/types/enums/o-auth-provider.d.ts +0 -2
- package/types/index.d.ts +2 -0
- package/types/models.d.ts +434 -375
- package/types/services/account.d.ts +11 -11
- package/types/services/avatars.d.ts +82 -82
- package/types/services/backups.d.ts +8 -8
- package/types/services/console.d.ts +14 -14
- package/types/services/databases.d.ts +50 -50
- package/types/services/domains.d.ts +139 -104
- package/types/services/functions.d.ts +15 -15
- package/types/services/health.d.ts +95 -78
- package/types/services/messaging.d.ts +24 -24
- package/types/services/migrations.d.ts +16 -16
- package/types/services/organizations.d.ts +37 -36
- package/types/services/projects.d.ts +36 -36
- package/types/services/sites.d.ts +15 -15
- package/types/services/storage.d.ts +30 -30
- package/types/services/tables-db.d.ts +50 -50
- package/types/services/users.d.ts +24 -24
|
@@ -365,7 +365,7 @@ export class Messaging {
|
|
|
365
365
|
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
366
366
|
* @param {string} params.color - Color for push notification. Available only for Android Platform.
|
|
367
367
|
* @param {string} params.tag - Tag for push notification. Available only for Android Platform.
|
|
368
|
-
* @param {number
|
|
368
|
+
* @param {number} params.badge - Badge for push notification. Available only for iOS Platform.
|
|
369
369
|
* @param {boolean} params.draft - Is message a draft
|
|
370
370
|
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
371
371
|
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
@@ -374,7 +374,7 @@ export class Messaging {
|
|
|
374
374
|
* @throws {AppwriteException}
|
|
375
375
|
* @returns {Promise<Models.Message>}
|
|
376
376
|
*/
|
|
377
|
-
createPush(params: { messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
377
|
+
createPush(params: { messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority }): Promise<Models.Message>;
|
|
378
378
|
/**
|
|
379
379
|
* Create a new push notification.
|
|
380
380
|
*
|
|
@@ -391,7 +391,7 @@ export class Messaging {
|
|
|
391
391
|
* @param {string} sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
392
392
|
* @param {string} color - Color for push notification. Available only for Android Platform.
|
|
393
393
|
* @param {string} tag - Tag for push notification. Available only for Android Platform.
|
|
394
|
-
* @param {number
|
|
394
|
+
* @param {number} badge - Badge for push notification. Available only for iOS Platform.
|
|
395
395
|
* @param {boolean} draft - Is message a draft
|
|
396
396
|
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
397
397
|
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
@@ -401,15 +401,15 @@ export class Messaging {
|
|
|
401
401
|
* @returns {Promise<Models.Message>}
|
|
402
402
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
403
403
|
*/
|
|
404
|
-
createPush(messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
404
|
+
createPush(messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message>;
|
|
405
405
|
createPush(
|
|
406
|
-
paramsOrFirst: { messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
407
|
-
...rest: [(string)?, (string)?, (string[])?, (string[])?, (string[])?, (object)?, (string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number
|
|
406
|
+
paramsOrFirst: { messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority } | string,
|
|
407
|
+
...rest: [(string)?, (string)?, (string[])?, (string[])?, (string[])?, (object)?, (string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number)?, (boolean)?, (string)?, (boolean)?, (boolean)?, (MessagePriority)?]
|
|
408
408
|
): Promise<Models.Message> {
|
|
409
|
-
let params: { messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
409
|
+
let params: { messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority };
|
|
410
410
|
|
|
411
411
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
412
|
-
params = (paramsOrFirst || {}) as { messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
412
|
+
params = (paramsOrFirst || {}) as { messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority };
|
|
413
413
|
} else {
|
|
414
414
|
params = {
|
|
415
415
|
messageId: paramsOrFirst as string,
|
|
@@ -425,7 +425,7 @@ export class Messaging {
|
|
|
425
425
|
sound: rest[9] as string,
|
|
426
426
|
color: rest[10] as string,
|
|
427
427
|
tag: rest[11] as string,
|
|
428
|
-
badge: rest[12] as number
|
|
428
|
+
badge: rest[12] as number,
|
|
429
429
|
draft: rest[13] as boolean,
|
|
430
430
|
scheduledAt: rest[14] as string,
|
|
431
431
|
contentAvailable: rest[15] as boolean,
|
|
@@ -548,7 +548,7 @@ export class Messaging {
|
|
|
548
548
|
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
549
549
|
* @param {string} params.color - Color for push notification. Available only for Android platforms.
|
|
550
550
|
* @param {string} params.tag - Tag for push notification. Available only for Android platforms.
|
|
551
|
-
* @param {number
|
|
551
|
+
* @param {number} params.badge - Badge for push notification. Available only for iOS platforms.
|
|
552
552
|
* @param {boolean} params.draft - Is message a draft
|
|
553
553
|
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
554
554
|
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
@@ -557,7 +557,7 @@ export class Messaging {
|
|
|
557
557
|
* @throws {AppwriteException}
|
|
558
558
|
* @returns {Promise<Models.Message>}
|
|
559
559
|
*/
|
|
560
|
-
updatePush(params: { messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
560
|
+
updatePush(params: { messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority }): Promise<Models.Message>;
|
|
561
561
|
/**
|
|
562
562
|
* Update a push notification by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
563
563
|
*
|
|
@@ -575,7 +575,7 @@ export class Messaging {
|
|
|
575
575
|
* @param {string} sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
576
576
|
* @param {string} color - Color for push notification. Available only for Android platforms.
|
|
577
577
|
* @param {string} tag - Tag for push notification. Available only for Android platforms.
|
|
578
|
-
* @param {number
|
|
578
|
+
* @param {number} badge - Badge for push notification. Available only for iOS platforms.
|
|
579
579
|
* @param {boolean} draft - Is message a draft
|
|
580
580
|
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
581
581
|
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
@@ -585,15 +585,15 @@ export class Messaging {
|
|
|
585
585
|
* @returns {Promise<Models.Message>}
|
|
586
586
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
587
587
|
*/
|
|
588
|
-
updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
588
|
+
updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message>;
|
|
589
589
|
updatePush(
|
|
590
|
-
paramsOrFirst: { messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
591
|
-
...rest: [(string[])?, (string[])?, (string[])?, (string)?, (string)?, (object)?, (string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number
|
|
590
|
+
paramsOrFirst: { messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority } | string,
|
|
591
|
+
...rest: [(string[])?, (string[])?, (string[])?, (string)?, (string)?, (object)?, (string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number)?, (boolean)?, (string)?, (boolean)?, (boolean)?, (MessagePriority)?]
|
|
592
592
|
): Promise<Models.Message> {
|
|
593
|
-
let params: { messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
593
|
+
let params: { messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority };
|
|
594
594
|
|
|
595
595
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
596
|
-
params = (paramsOrFirst || {}) as { messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number
|
|
596
|
+
params = (paramsOrFirst || {}) as { messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority };
|
|
597
597
|
} else {
|
|
598
598
|
params = {
|
|
599
599
|
messageId: paramsOrFirst as string,
|
|
@@ -609,7 +609,7 @@ export class Messaging {
|
|
|
609
609
|
sound: rest[9] as string,
|
|
610
610
|
color: rest[10] as string,
|
|
611
611
|
tag: rest[11] as string,
|
|
612
|
-
badge: rest[12] as number
|
|
612
|
+
badge: rest[12] as number,
|
|
613
613
|
draft: rest[13] as boolean,
|
|
614
614
|
scheduledAt: rest[14] as string,
|
|
615
615
|
contentAvailable: rest[15] as boolean,
|
|
@@ -2991,7 +2991,7 @@ export class Messaging {
|
|
|
2991
2991
|
* @param {string} params.providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2992
2992
|
* @param {string} params.name - Provider name.
|
|
2993
2993
|
* @param {string} params.host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
2994
|
-
* @param {number
|
|
2994
|
+
* @param {number} params.port - The default SMTP server port.
|
|
2995
2995
|
* @param {string} params.username - Authentication username.
|
|
2996
2996
|
* @param {string} params.password - Authentication password.
|
|
2997
2997
|
* @param {SmtpEncryption} params.encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
@@ -3006,14 +3006,14 @@ export class Messaging {
|
|
|
3006
3006
|
* @returns {Promise<Models.Provider>}
|
|
3007
3007
|
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.createSMTPProvider` instead.
|
|
3008
3008
|
*/
|
|
3009
|
-
createSmtpProvider(params: { providerId: string, name: string, host: string, port?: number
|
|
3009
|
+
createSmtpProvider(params: { providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean }): Promise<Models.Provider>;
|
|
3010
3010
|
/**
|
|
3011
3011
|
* Create a new SMTP provider.
|
|
3012
3012
|
*
|
|
3013
3013
|
* @param {string} providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
3014
3014
|
* @param {string} name - Provider name.
|
|
3015
3015
|
* @param {string} host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
3016
|
-
* @param {number
|
|
3016
|
+
* @param {number} port - The default SMTP server port.
|
|
3017
3017
|
* @param {string} username - Authentication username.
|
|
3018
3018
|
* @param {string} password - Authentication password.
|
|
3019
3019
|
* @param {SmtpEncryption} encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
@@ -3028,21 +3028,21 @@ export class Messaging {
|
|
|
3028
3028
|
* @returns {Promise<Models.Provider>}
|
|
3029
3029
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
3030
3030
|
*/
|
|
3031
|
-
createSmtpProvider(providerId: string, name: string, host: string, port?: number
|
|
3031
|
+
createSmtpProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
3032
3032
|
createSmtpProvider(
|
|
3033
|
-
paramsOrFirst: { providerId: string, name: string, host: string, port?: number
|
|
3034
|
-
...rest: [(string)?, (string)?, (number
|
|
3033
|
+
paramsOrFirst: { providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean } | string,
|
|
3034
|
+
...rest: [(string)?, (string)?, (number)?, (string)?, (string)?, (SmtpEncryption)?, (boolean)?, (string)?, (string)?, (string)?, (string)?, (string)?, (boolean)?]
|
|
3035
3035
|
): Promise<Models.Provider> {
|
|
3036
|
-
let params: { providerId: string, name: string, host: string, port?: number
|
|
3036
|
+
let params: { providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean };
|
|
3037
3037
|
|
|
3038
3038
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
3039
|
-
params = (paramsOrFirst || {}) as { providerId: string, name: string, host: string, port?: number
|
|
3039
|
+
params = (paramsOrFirst || {}) as { providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean };
|
|
3040
3040
|
} else {
|
|
3041
3041
|
params = {
|
|
3042
3042
|
providerId: paramsOrFirst as string,
|
|
3043
3043
|
name: rest[0] as string,
|
|
3044
3044
|
host: rest[1] as string,
|
|
3045
|
-
port: rest[2] as number
|
|
3045
|
+
port: rest[2] as number,
|
|
3046
3046
|
username: rest[3] as string,
|
|
3047
3047
|
password: rest[4] as string,
|
|
3048
3048
|
encryption: rest[5] as SmtpEncryption,
|
|
@@ -3145,7 +3145,7 @@ export class Messaging {
|
|
|
3145
3145
|
* @param {string} params.providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
3146
3146
|
* @param {string} params.name - Provider name.
|
|
3147
3147
|
* @param {string} params.host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
3148
|
-
* @param {number
|
|
3148
|
+
* @param {number} params.port - The default SMTP server port.
|
|
3149
3149
|
* @param {string} params.username - Authentication username.
|
|
3150
3150
|
* @param {string} params.password - Authentication password.
|
|
3151
3151
|
* @param {SmtpEncryption} params.encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
@@ -3159,14 +3159,14 @@ export class Messaging {
|
|
|
3159
3159
|
* @throws {AppwriteException}
|
|
3160
3160
|
* @returns {Promise<Models.Provider>}
|
|
3161
3161
|
*/
|
|
3162
|
-
createSMTPProvider(params: { providerId: string, name: string, host: string, port?: number
|
|
3162
|
+
createSMTPProvider(params: { providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean }): Promise<Models.Provider>;
|
|
3163
3163
|
/**
|
|
3164
3164
|
* Create a new SMTP provider.
|
|
3165
3165
|
*
|
|
3166
3166
|
* @param {string} providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
3167
3167
|
* @param {string} name - Provider name.
|
|
3168
3168
|
* @param {string} host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
3169
|
-
* @param {number
|
|
3169
|
+
* @param {number} port - The default SMTP server port.
|
|
3170
3170
|
* @param {string} username - Authentication username.
|
|
3171
3171
|
* @param {string} password - Authentication password.
|
|
3172
3172
|
* @param {SmtpEncryption} encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
@@ -3181,21 +3181,21 @@ export class Messaging {
|
|
|
3181
3181
|
* @returns {Promise<Models.Provider>}
|
|
3182
3182
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
3183
3183
|
*/
|
|
3184
|
-
createSMTPProvider(providerId: string, name: string, host: string, port?: number
|
|
3184
|
+
createSMTPProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
3185
3185
|
createSMTPProvider(
|
|
3186
|
-
paramsOrFirst: { providerId: string, name: string, host: string, port?: number
|
|
3187
|
-
...rest: [(string)?, (string)?, (number
|
|
3186
|
+
paramsOrFirst: { providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean } | string,
|
|
3187
|
+
...rest: [(string)?, (string)?, (number)?, (string)?, (string)?, (SmtpEncryption)?, (boolean)?, (string)?, (string)?, (string)?, (string)?, (string)?, (boolean)?]
|
|
3188
3188
|
): Promise<Models.Provider> {
|
|
3189
|
-
let params: { providerId: string, name: string, host: string, port?: number
|
|
3189
|
+
let params: { providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean };
|
|
3190
3190
|
|
|
3191
3191
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
3192
|
-
params = (paramsOrFirst || {}) as { providerId: string, name: string, host: string, port?: number
|
|
3192
|
+
params = (paramsOrFirst || {}) as { providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean };
|
|
3193
3193
|
} else {
|
|
3194
3194
|
params = {
|
|
3195
3195
|
providerId: paramsOrFirst as string,
|
|
3196
3196
|
name: rest[0] as string,
|
|
3197
3197
|
host: rest[1] as string,
|
|
3198
|
-
port: rest[2] as number
|
|
3198
|
+
port: rest[2] as number,
|
|
3199
3199
|
username: rest[3] as string,
|
|
3200
3200
|
password: rest[4] as string,
|
|
3201
3201
|
encryption: rest[5] as SmtpEncryption,
|
|
@@ -3298,7 +3298,7 @@ export class Messaging {
|
|
|
3298
3298
|
* @param {string} params.providerId - Provider ID.
|
|
3299
3299
|
* @param {string} params.name - Provider name.
|
|
3300
3300
|
* @param {string} params.host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
3301
|
-
* @param {number
|
|
3301
|
+
* @param {number} params.port - SMTP port.
|
|
3302
3302
|
* @param {string} params.username - Authentication username.
|
|
3303
3303
|
* @param {string} params.password - Authentication password.
|
|
3304
3304
|
* @param {SmtpEncryption} params.encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
@@ -3313,14 +3313,14 @@ export class Messaging {
|
|
|
3313
3313
|
* @returns {Promise<Models.Provider>}
|
|
3314
3314
|
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.updateSMTPProvider` instead.
|
|
3315
3315
|
*/
|
|
3316
|
-
updateSmtpProvider(params: { providerId: string, name?: string, host?: string, port?: number
|
|
3316
|
+
updateSmtpProvider(params: { providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean }): Promise<Models.Provider>;
|
|
3317
3317
|
/**
|
|
3318
3318
|
* Update a SMTP provider by its unique ID.
|
|
3319
3319
|
*
|
|
3320
3320
|
* @param {string} providerId - Provider ID.
|
|
3321
3321
|
* @param {string} name - Provider name.
|
|
3322
3322
|
* @param {string} host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
3323
|
-
* @param {number
|
|
3323
|
+
* @param {number} port - SMTP port.
|
|
3324
3324
|
* @param {string} username - Authentication username.
|
|
3325
3325
|
* @param {string} password - Authentication password.
|
|
3326
3326
|
* @param {SmtpEncryption} encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
@@ -3335,21 +3335,21 @@ export class Messaging {
|
|
|
3335
3335
|
* @returns {Promise<Models.Provider>}
|
|
3336
3336
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
3337
3337
|
*/
|
|
3338
|
-
updateSmtpProvider(providerId: string, name?: string, host?: string, port?: number
|
|
3338
|
+
updateSmtpProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
3339
3339
|
updateSmtpProvider(
|
|
3340
|
-
paramsOrFirst: { providerId: string, name?: string, host?: string, port?: number
|
|
3341
|
-
...rest: [(string)?, (string)?, (number
|
|
3340
|
+
paramsOrFirst: { providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean } | string,
|
|
3341
|
+
...rest: [(string)?, (string)?, (number)?, (string)?, (string)?, (SmtpEncryption)?, (boolean)?, (string)?, (string)?, (string)?, (string)?, (string)?, (boolean)?]
|
|
3342
3342
|
): Promise<Models.Provider> {
|
|
3343
|
-
let params: { providerId: string, name?: string, host?: string, port?: number
|
|
3343
|
+
let params: { providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean };
|
|
3344
3344
|
|
|
3345
3345
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
3346
|
-
params = (paramsOrFirst || {}) as { providerId: string, name?: string, host?: string, port?: number
|
|
3346
|
+
params = (paramsOrFirst || {}) as { providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean };
|
|
3347
3347
|
} else {
|
|
3348
3348
|
params = {
|
|
3349
3349
|
providerId: paramsOrFirst as string,
|
|
3350
3350
|
name: rest[0] as string,
|
|
3351
3351
|
host: rest[1] as string,
|
|
3352
|
-
port: rest[2] as number
|
|
3352
|
+
port: rest[2] as number,
|
|
3353
3353
|
username: rest[3] as string,
|
|
3354
3354
|
password: rest[4] as string,
|
|
3355
3355
|
encryption: rest[5] as SmtpEncryption,
|
|
@@ -3443,7 +3443,7 @@ export class Messaging {
|
|
|
3443
3443
|
* @param {string} params.providerId - Provider ID.
|
|
3444
3444
|
* @param {string} params.name - Provider name.
|
|
3445
3445
|
* @param {string} params.host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
3446
|
-
* @param {number
|
|
3446
|
+
* @param {number} params.port - SMTP port.
|
|
3447
3447
|
* @param {string} params.username - Authentication username.
|
|
3448
3448
|
* @param {string} params.password - Authentication password.
|
|
3449
3449
|
* @param {SmtpEncryption} params.encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
@@ -3457,14 +3457,14 @@ export class Messaging {
|
|
|
3457
3457
|
* @throws {AppwriteException}
|
|
3458
3458
|
* @returns {Promise<Models.Provider>}
|
|
3459
3459
|
*/
|
|
3460
|
-
updateSMTPProvider(params: { providerId: string, name?: string, host?: string, port?: number
|
|
3460
|
+
updateSMTPProvider(params: { providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean }): Promise<Models.Provider>;
|
|
3461
3461
|
/**
|
|
3462
3462
|
* Update a SMTP provider by its unique ID.
|
|
3463
3463
|
*
|
|
3464
3464
|
* @param {string} providerId - Provider ID.
|
|
3465
3465
|
* @param {string} name - Provider name.
|
|
3466
3466
|
* @param {string} host - SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.
|
|
3467
|
-
* @param {number
|
|
3467
|
+
* @param {number} port - SMTP port.
|
|
3468
3468
|
* @param {string} username - Authentication username.
|
|
3469
3469
|
* @param {string} password - Authentication password.
|
|
3470
3470
|
* @param {SmtpEncryption} encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
@@ -3479,21 +3479,21 @@ export class Messaging {
|
|
|
3479
3479
|
* @returns {Promise<Models.Provider>}
|
|
3480
3480
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
3481
3481
|
*/
|
|
3482
|
-
updateSMTPProvider(providerId: string, name?: string, host?: string, port?: number
|
|
3482
|
+
updateSMTPProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
3483
3483
|
updateSMTPProvider(
|
|
3484
|
-
paramsOrFirst: { providerId: string, name?: string, host?: string, port?: number
|
|
3485
|
-
...rest: [(string)?, (string)?, (number
|
|
3484
|
+
paramsOrFirst: { providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean } | string,
|
|
3485
|
+
...rest: [(string)?, (string)?, (number)?, (string)?, (string)?, (SmtpEncryption)?, (boolean)?, (string)?, (string)?, (string)?, (string)?, (string)?, (boolean)?]
|
|
3486
3486
|
): Promise<Models.Provider> {
|
|
3487
|
-
let params: { providerId: string, name?: string, host?: string, port?: number
|
|
3487
|
+
let params: { providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean };
|
|
3488
3488
|
|
|
3489
3489
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
3490
|
-
params = (paramsOrFirst || {}) as { providerId: string, name?: string, host?: string, port?: number
|
|
3490
|
+
params = (paramsOrFirst || {}) as { providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean };
|
|
3491
3491
|
} else {
|
|
3492
3492
|
params = {
|
|
3493
3493
|
providerId: paramsOrFirst as string,
|
|
3494
3494
|
name: rest[0] as string,
|
|
3495
3495
|
host: rest[1] as string,
|
|
3496
|
-
port: rest[2] as number
|
|
3496
|
+
port: rest[2] as number,
|
|
3497
3497
|
username: rest[3] as string,
|
|
3498
3498
|
password: rest[4] as string,
|
|
3499
3499
|
encryption: rest[5] as SmtpEncryption,
|
|
@@ -586,11 +586,11 @@ export class Migrations {
|
|
|
586
586
|
* @param {string} params.database - Source's Database Name
|
|
587
587
|
* @param {string} params.username - Source's Database Username
|
|
588
588
|
* @param {string} params.password - Source's Database Password
|
|
589
|
-
* @param {number
|
|
589
|
+
* @param {number} params.port - Source's Database Port
|
|
590
590
|
* @throws {AppwriteException}
|
|
591
591
|
* @returns {Promise<Models.Migration>}
|
|
592
592
|
*/
|
|
593
|
-
createNHostMigration(params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
593
|
+
createNHostMigration(params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number }): Promise<Models.Migration>;
|
|
594
594
|
/**
|
|
595
595
|
* Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
|
|
596
596
|
*
|
|
@@ -601,20 +601,20 @@ export class Migrations {
|
|
|
601
601
|
* @param {string} database - Source's Database Name
|
|
602
602
|
* @param {string} username - Source's Database Username
|
|
603
603
|
* @param {string} password - Source's Database Password
|
|
604
|
-
* @param {number
|
|
604
|
+
* @param {number} port - Source's Database Port
|
|
605
605
|
* @throws {AppwriteException}
|
|
606
606
|
* @returns {Promise<Models.Migration>}
|
|
607
607
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
608
608
|
*/
|
|
609
|
-
createNHostMigration(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
609
|
+
createNHostMigration(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.Migration>;
|
|
610
610
|
createNHostMigration(
|
|
611
|
-
paramsOrFirst: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
612
|
-
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number
|
|
611
|
+
paramsOrFirst: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number } | string[],
|
|
612
|
+
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
|
|
613
613
|
): Promise<Models.Migration> {
|
|
614
|
-
let params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
614
|
+
let params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
|
|
615
615
|
|
|
616
616
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
617
|
-
params = (paramsOrFirst || {}) as { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
617
|
+
params = (paramsOrFirst || {}) as { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
|
|
618
618
|
} else {
|
|
619
619
|
params = {
|
|
620
620
|
resources: paramsOrFirst as string[],
|
|
@@ -624,7 +624,7 @@ export class Migrations {
|
|
|
624
624
|
database: rest[3] as string,
|
|
625
625
|
username: rest[4] as string,
|
|
626
626
|
password: rest[5] as string,
|
|
627
|
-
port: rest[6] as number
|
|
627
|
+
port: rest[6] as number
|
|
628
628
|
};
|
|
629
629
|
}
|
|
630
630
|
|
|
@@ -709,11 +709,11 @@ export class Migrations {
|
|
|
709
709
|
* @param {string} params.database - Source's Database Name.
|
|
710
710
|
* @param {string} params.username - Source's Database Username.
|
|
711
711
|
* @param {string} params.password - Source's Database Password.
|
|
712
|
-
* @param {number
|
|
712
|
+
* @param {number} params.port - Source's Database Port.
|
|
713
713
|
* @throws {AppwriteException}
|
|
714
714
|
* @returns {Promise<Models.MigrationReport>}
|
|
715
715
|
*/
|
|
716
|
-
getNHostReport(params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
716
|
+
getNHostReport(params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number }): Promise<Models.MigrationReport>;
|
|
717
717
|
/**
|
|
718
718
|
* Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
719
719
|
*
|
|
@@ -724,20 +724,20 @@ export class Migrations {
|
|
|
724
724
|
* @param {string} database - Source's Database Name.
|
|
725
725
|
* @param {string} username - Source's Database Username.
|
|
726
726
|
* @param {string} password - Source's Database Password.
|
|
727
|
-
* @param {number
|
|
727
|
+
* @param {number} port - Source's Database Port.
|
|
728
728
|
* @throws {AppwriteException}
|
|
729
729
|
* @returns {Promise<Models.MigrationReport>}
|
|
730
730
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
731
731
|
*/
|
|
732
|
-
getNHostReport(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
732
|
+
getNHostReport(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
|
|
733
733
|
getNHostReport(
|
|
734
|
-
paramsOrFirst: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
735
|
-
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number
|
|
734
|
+
paramsOrFirst: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number } | string[],
|
|
735
|
+
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
|
|
736
736
|
): Promise<Models.MigrationReport> {
|
|
737
|
-
let params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
737
|
+
let params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
|
|
738
738
|
|
|
739
739
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
740
|
-
params = (paramsOrFirst || {}) as { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number
|
|
740
|
+
params = (paramsOrFirst || {}) as { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
|
|
741
741
|
} else {
|
|
742
742
|
params = {
|
|
743
743
|
resources: paramsOrFirst as string[],
|
|
@@ -747,7 +747,7 @@ export class Migrations {
|
|
|
747
747
|
database: rest[3] as string,
|
|
748
748
|
username: rest[4] as string,
|
|
749
749
|
password: rest[5] as string,
|
|
750
|
-
port: rest[6] as number
|
|
750
|
+
port: rest[6] as number
|
|
751
751
|
};
|
|
752
752
|
}
|
|
753
753
|
|
|
@@ -830,11 +830,11 @@ export class Migrations {
|
|
|
830
830
|
* @param {string} params.databaseHost - Source's Database Host
|
|
831
831
|
* @param {string} params.username - Source's Database Username
|
|
832
832
|
* @param {string} params.password - Source's Database Password
|
|
833
|
-
* @param {number
|
|
833
|
+
* @param {number} params.port - Source's Database Port
|
|
834
834
|
* @throws {AppwriteException}
|
|
835
835
|
* @returns {Promise<Models.Migration>}
|
|
836
836
|
*/
|
|
837
|
-
createSupabaseMigration(params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
837
|
+
createSupabaseMigration(params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number }): Promise<Models.Migration>;
|
|
838
838
|
/**
|
|
839
839
|
* Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
|
|
840
840
|
*
|
|
@@ -844,20 +844,20 @@ export class Migrations {
|
|
|
844
844
|
* @param {string} databaseHost - Source's Database Host
|
|
845
845
|
* @param {string} username - Source's Database Username
|
|
846
846
|
* @param {string} password - Source's Database Password
|
|
847
|
-
* @param {number
|
|
847
|
+
* @param {number} port - Source's Database Port
|
|
848
848
|
* @throws {AppwriteException}
|
|
849
849
|
* @returns {Promise<Models.Migration>}
|
|
850
850
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
851
851
|
*/
|
|
852
|
-
createSupabaseMigration(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
852
|
+
createSupabaseMigration(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.Migration>;
|
|
853
853
|
createSupabaseMigration(
|
|
854
|
-
paramsOrFirst: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
855
|
-
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (number
|
|
854
|
+
paramsOrFirst: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number } | string[],
|
|
855
|
+
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
|
|
856
856
|
): Promise<Models.Migration> {
|
|
857
|
-
let params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
857
|
+
let params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
|
|
858
858
|
|
|
859
859
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
860
|
-
params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
860
|
+
params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
|
|
861
861
|
} else {
|
|
862
862
|
params = {
|
|
863
863
|
resources: paramsOrFirst as string[],
|
|
@@ -866,7 +866,7 @@ export class Migrations {
|
|
|
866
866
|
databaseHost: rest[2] as string,
|
|
867
867
|
username: rest[3] as string,
|
|
868
868
|
password: rest[4] as string,
|
|
869
|
-
port: rest[5] as number
|
|
869
|
+
port: rest[5] as number
|
|
870
870
|
};
|
|
871
871
|
}
|
|
872
872
|
|
|
@@ -943,11 +943,11 @@ export class Migrations {
|
|
|
943
943
|
* @param {string} params.databaseHost - Source's Database Host.
|
|
944
944
|
* @param {string} params.username - Source's Database Username.
|
|
945
945
|
* @param {string} params.password - Source's Database Password.
|
|
946
|
-
* @param {number
|
|
946
|
+
* @param {number} params.port - Source's Database Port.
|
|
947
947
|
* @throws {AppwriteException}
|
|
948
948
|
* @returns {Promise<Models.MigrationReport>}
|
|
949
949
|
*/
|
|
950
|
-
getSupabaseReport(params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
950
|
+
getSupabaseReport(params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number }): Promise<Models.MigrationReport>;
|
|
951
951
|
/**
|
|
952
952
|
* Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
|
953
953
|
*
|
|
@@ -957,20 +957,20 @@ export class Migrations {
|
|
|
957
957
|
* @param {string} databaseHost - Source's Database Host.
|
|
958
958
|
* @param {string} username - Source's Database Username.
|
|
959
959
|
* @param {string} password - Source's Database Password.
|
|
960
|
-
* @param {number
|
|
960
|
+
* @param {number} port - Source's Database Port.
|
|
961
961
|
* @throws {AppwriteException}
|
|
962
962
|
* @returns {Promise<Models.MigrationReport>}
|
|
963
963
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
964
964
|
*/
|
|
965
|
-
getSupabaseReport(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
965
|
+
getSupabaseReport(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
|
|
966
966
|
getSupabaseReport(
|
|
967
|
-
paramsOrFirst: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
968
|
-
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (number
|
|
967
|
+
paramsOrFirst: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number } | string[],
|
|
968
|
+
...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
|
|
969
969
|
): Promise<Models.MigrationReport> {
|
|
970
|
-
let params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
970
|
+
let params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
|
|
971
971
|
|
|
972
972
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
973
|
-
params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number
|
|
973
|
+
params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
|
|
974
974
|
} else {
|
|
975
975
|
params = {
|
|
976
976
|
resources: paramsOrFirst as string[],
|
|
@@ -979,7 +979,7 @@ export class Migrations {
|
|
|
979
979
|
databaseHost: rest[2] as string,
|
|
980
980
|
username: rest[3] as string,
|
|
981
981
|
password: rest[4] as string,
|
|
982
|
-
port: rest[5] as number
|
|
982
|
+
port: rest[5] as number
|
|
983
983
|
};
|
|
984
984
|
}
|
|
985
985
|
|