node-appwrite 17.1.0 → 18.0.0
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/README.md +67 -2
- package/dist/client.js +3 -3
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +3 -3
- package/dist/client.mjs.map +1 -1
- package/dist/enums/{v-c-s-deployment-type.js → vcs-deployment-type.js} +1 -1
- package/dist/enums/vcs-deployment-type.js.map +1 -0
- package/dist/enums/{v-c-s-deployment-type.mjs → vcs-deployment-type.mjs} +2 -2
- package/dist/enums/vcs-deployment-type.mjs.map +1 -0
- package/dist/index.d.mts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +7 -2
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2 -1
- package/dist/index.mjs.map +1 -1
- package/dist/models.d.mts +829 -145
- package/dist/models.d.ts +829 -145
- package/dist/query.d.mts +70 -0
- package/dist/query.d.ts +70 -0
- package/dist/query.js +70 -0
- package/dist/query.js.map +1 -1
- package/dist/query.mjs +70 -0
- package/dist/query.mjs.map +1 -1
- package/dist/services/account.d.mts +656 -101
- package/dist/services/account.d.ts +656 -101
- package/dist/services/account.js +592 -292
- package/dist/services/account.js.map +1 -1
- package/dist/services/account.mjs +592 -292
- package/dist/services/account.mjs.map +1 -1
- package/dist/services/avatars.d.mts +176 -45
- package/dist/services/avatars.d.ts +176 -45
- package/dist/services/avatars.js +104 -93
- package/dist/services/avatars.js.map +1 -1
- package/dist/services/avatars.mjs +104 -93
- package/dist/services/avatars.mjs.map +1 -1
- package/dist/services/databases.d.mts +1274 -271
- package/dist/services/databases.d.ts +1274 -271
- package/dist/services/databases.js +939 -584
- package/dist/services/databases.js.map +1 -1
- package/dist/services/databases.mjs +939 -584
- package/dist/services/databases.mjs.map +1 -1
- package/dist/services/functions.d.mts +537 -114
- package/dist/services/functions.d.ts +537 -114
- package/dist/services/functions.js +393 -276
- package/dist/services/functions.js.map +1 -1
- package/dist/services/functions.mjs +393 -276
- package/dist/services/functions.mjs.map +1 -1
- package/dist/services/graphql.d.mts +24 -2
- package/dist/services/graphql.d.ts +24 -2
- package/dist/services/graphql.js +20 -16
- package/dist/services/graphql.js.map +1 -1
- package/dist/services/graphql.mjs +20 -16
- package/dist/services/graphql.mjs.map +1 -1
- package/dist/services/health.d.mts +176 -17
- package/dist/services/health.d.ts +176 -17
- package/dist/services/health.js +144 -115
- package/dist/services/health.js.map +1 -1
- package/dist/services/health.mjs +144 -115
- package/dist/services/health.mjs.map +1 -1
- package/dist/services/locale.d.mts +2 -2
- package/dist/services/locale.d.ts +2 -2
- package/dist/services/locale.js +7 -7
- package/dist/services/locale.js.map +1 -1
- package/dist/services/locale.mjs +7 -7
- package/dist/services/locale.mjs.map +1 -1
- package/dist/services/messaging.d.mts +1552 -270
- package/dist/services/messaging.d.ts +1552 -270
- package/dist/services/messaging.js +1417 -592
- package/dist/services/messaging.js.map +1 -1
- package/dist/services/messaging.mjs +1417 -592
- package/dist/services/messaging.mjs.map +1 -1
- package/dist/services/sites.d.mts +499 -103
- package/dist/services/sites.d.ts +499 -103
- package/dist/services/sites.js +371 -258
- package/dist/services/sites.js.map +1 -1
- package/dist/services/sites.mjs +371 -258
- package/dist/services/sites.mjs.map +1 -1
- package/dist/services/storage.d.mts +311 -68
- package/dist/services/storage.d.ts +311 -68
- package/dist/services/storage.js +225 -158
- package/dist/services/storage.js.map +1 -1
- package/dist/services/storage.mjs +225 -158
- package/dist/services/storage.mjs.map +1 -1
- package/dist/services/tables-db.d.mts +1549 -0
- package/dist/services/tables-db.d.ts +1549 -0
- package/dist/services/tables-db.js +2374 -0
- package/dist/services/tables-db.js.map +1 -0
- package/dist/services/tables-db.mjs +2373 -0
- package/dist/services/tables-db.mjs.map +1 -0
- package/dist/services/teams.d.mts +249 -55
- package/dist/services/teams.d.ts +249 -55
- package/dist/services/teams.js +170 -135
- package/dist/services/teams.js.map +1 -1
- package/dist/services/teams.mjs +170 -135
- package/dist/services/teams.mjs.map +1 -1
- package/dist/services/tokens.d.mts +76 -11
- package/dist/services/tokens.d.ts +76 -11
- package/dist/services/tokens.js +60 -45
- package/dist/services/tokens.js.map +1 -1
- package/dist/services/tokens.mjs +60 -45
- package/dist/services/tokens.mjs.map +1 -1
- package/dist/services/users.d.mts +867 -140
- package/dist/services/users.d.ts +867 -140
- package/dist/services/users.js +719 -408
- package/dist/services/users.js.map +1 -1
- package/dist/services/users.mjs +719 -408
- package/dist/services/users.mjs.map +1 -1
- package/package.json +1 -1
- package/dist/enums/v-c-s-deployment-type.js.map +0 -1
- package/dist/enums/v-c-s-deployment-type.mjs.map +0 -1
- /package/dist/enums/{v-c-s-deployment-type.d.mts → vcs-deployment-type.d.mts} +0 -0
- /package/dist/enums/{v-c-s-deployment-type.d.ts → vcs-deployment-type.d.ts} +0 -0
|
@@ -10,593 +10,1875 @@ declare class Messaging {
|
|
|
10
10
|
/**
|
|
11
11
|
* Get a list of all messages from the current Appwrite project.
|
|
12
12
|
*
|
|
13
|
-
* @param {string[]} queries
|
|
14
|
-
* @param {string} search
|
|
13
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType
|
|
14
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
15
15
|
* @throws {AppwriteException}
|
|
16
16
|
* @returns {Promise<Models.MessageList>}
|
|
17
17
|
*/
|
|
18
|
+
listMessages(params?: {
|
|
19
|
+
queries?: string[];
|
|
20
|
+
search?: string;
|
|
21
|
+
}): Promise<Models.MessageList>;
|
|
22
|
+
/**
|
|
23
|
+
* Get a list of all messages from the current Appwrite project.
|
|
24
|
+
*
|
|
25
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType
|
|
26
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
27
|
+
* @throws {AppwriteException}
|
|
28
|
+
* @returns {Promise<Models.MessageList>}
|
|
29
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
30
|
+
*/
|
|
18
31
|
listMessages(queries?: string[], search?: string): Promise<Models.MessageList>;
|
|
19
32
|
/**
|
|
20
33
|
* Create a new email message.
|
|
21
34
|
*
|
|
22
|
-
* @param {string} messageId
|
|
23
|
-
* @param {string} subject
|
|
24
|
-
* @param {string} content
|
|
25
|
-
* @param {string[]} topics
|
|
26
|
-
* @param {string[]} users
|
|
27
|
-
* @param {string[]} targets
|
|
28
|
-
* @param {string[]} cc
|
|
29
|
-
* @param {string[]} bcc
|
|
30
|
-
* @param {string[]} attachments
|
|
31
|
-
* @param {boolean} draft
|
|
32
|
-
* @param {boolean} html
|
|
33
|
-
* @param {string} scheduledAt
|
|
35
|
+
* @param {string} params.messageId - Message 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.
|
|
36
|
+
* @param {string} params.subject - Email Subject.
|
|
37
|
+
* @param {string} params.content - Email Content.
|
|
38
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
39
|
+
* @param {string[]} params.users - List of User IDs.
|
|
40
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
41
|
+
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
42
|
+
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
43
|
+
* @param {string[]} params.attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
44
|
+
* @param {boolean} params.draft - Is message a draft
|
|
45
|
+
* @param {boolean} params.html - Is content of type HTML
|
|
46
|
+
* @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.
|
|
34
47
|
* @throws {AppwriteException}
|
|
35
48
|
* @returns {Promise<Models.Message>}
|
|
36
49
|
*/
|
|
50
|
+
createEmail(params: {
|
|
51
|
+
messageId: string;
|
|
52
|
+
subject: string;
|
|
53
|
+
content: string;
|
|
54
|
+
topics?: string[];
|
|
55
|
+
users?: string[];
|
|
56
|
+
targets?: string[];
|
|
57
|
+
cc?: string[];
|
|
58
|
+
bcc?: string[];
|
|
59
|
+
attachments?: string[];
|
|
60
|
+
draft?: boolean;
|
|
61
|
+
html?: boolean;
|
|
62
|
+
scheduledAt?: string;
|
|
63
|
+
}): Promise<Models.Message>;
|
|
64
|
+
/**
|
|
65
|
+
* Create a new email message.
|
|
66
|
+
*
|
|
67
|
+
* @param {string} messageId - Message 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.
|
|
68
|
+
* @param {string} subject - Email Subject.
|
|
69
|
+
* @param {string} content - Email Content.
|
|
70
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
71
|
+
* @param {string[]} users - List of User IDs.
|
|
72
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
73
|
+
* @param {string[]} cc - Array of target IDs to be added as CC.
|
|
74
|
+
* @param {string[]} bcc - Array of target IDs to be added as BCC.
|
|
75
|
+
* @param {string[]} attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
76
|
+
* @param {boolean} draft - Is message a draft
|
|
77
|
+
* @param {boolean} html - Is content of type HTML
|
|
78
|
+
* @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.
|
|
79
|
+
* @throws {AppwriteException}
|
|
80
|
+
* @returns {Promise<Models.Message>}
|
|
81
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
82
|
+
*/
|
|
37
83
|
createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], attachments?: string[], draft?: boolean, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
38
84
|
/**
|
|
39
85
|
* Update an email message 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.
|
|
40
|
-
|
|
41
86
|
*
|
|
42
|
-
*
|
|
43
|
-
* @param {string
|
|
44
|
-
* @param {string[]}
|
|
45
|
-
* @param {string[]}
|
|
46
|
-
* @param {string}
|
|
47
|
-
* @param {string}
|
|
48
|
-
* @param {
|
|
49
|
-
* @param {boolean}
|
|
50
|
-
* @param {
|
|
51
|
-
* @param {string[]}
|
|
52
|
-
* @param {string}
|
|
53
|
-
* @param {string[]
|
|
87
|
+
*
|
|
88
|
+
* @param {string} params.messageId - Message ID.
|
|
89
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
90
|
+
* @param {string[]} params.users - List of User IDs.
|
|
91
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
92
|
+
* @param {string} params.subject - Email Subject.
|
|
93
|
+
* @param {string} params.content - Email Content.
|
|
94
|
+
* @param {boolean} params.draft - Is message a draft
|
|
95
|
+
* @param {boolean} params.html - Is content of type HTML
|
|
96
|
+
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
97
|
+
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
98
|
+
* @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.
|
|
99
|
+
* @param {string[]} params.attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
100
|
+
* @throws {AppwriteException}
|
|
101
|
+
* @returns {Promise<Models.Message>}
|
|
102
|
+
*/
|
|
103
|
+
updateEmail(params: {
|
|
104
|
+
messageId: string;
|
|
105
|
+
topics?: string[];
|
|
106
|
+
users?: string[];
|
|
107
|
+
targets?: string[];
|
|
108
|
+
subject?: string;
|
|
109
|
+
content?: string;
|
|
110
|
+
draft?: boolean;
|
|
111
|
+
html?: boolean;
|
|
112
|
+
cc?: string[];
|
|
113
|
+
bcc?: string[];
|
|
114
|
+
scheduledAt?: string;
|
|
115
|
+
attachments?: string[];
|
|
116
|
+
}): Promise<Models.Message>;
|
|
117
|
+
/**
|
|
118
|
+
* Update an email message 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.
|
|
119
|
+
*
|
|
120
|
+
*
|
|
121
|
+
* @param {string} messageId - Message ID.
|
|
122
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
123
|
+
* @param {string[]} users - List of User IDs.
|
|
124
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
125
|
+
* @param {string} subject - Email Subject.
|
|
126
|
+
* @param {string} content - Email Content.
|
|
127
|
+
* @param {boolean} draft - Is message a draft
|
|
128
|
+
* @param {boolean} html - Is content of type HTML
|
|
129
|
+
* @param {string[]} cc - Array of target IDs to be added as CC.
|
|
130
|
+
* @param {string[]} bcc - Array of target IDs to be added as BCC.
|
|
131
|
+
* @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.
|
|
132
|
+
* @param {string[]} attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
54
133
|
* @throws {AppwriteException}
|
|
55
134
|
* @returns {Promise<Models.Message>}
|
|
135
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
56
136
|
*/
|
|
57
137
|
updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, draft?: boolean, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string, attachments?: string[]): Promise<Models.Message>;
|
|
58
138
|
/**
|
|
59
139
|
* Create a new push notification.
|
|
60
140
|
*
|
|
61
|
-
* @param {string} messageId
|
|
62
|
-
* @param {string} title
|
|
63
|
-
* @param {string} body
|
|
64
|
-
* @param {string[]} topics
|
|
65
|
-
* @param {string[]} users
|
|
66
|
-
* @param {string[]} targets
|
|
67
|
-
* @param {object} data
|
|
68
|
-
* @param {string} action
|
|
69
|
-
* @param {string} image
|
|
70
|
-
* @param {string} icon
|
|
71
|
-
* @param {string} sound
|
|
72
|
-
* @param {string} color
|
|
73
|
-
* @param {string} tag
|
|
74
|
-
* @param {number} badge
|
|
75
|
-
* @param {boolean} draft
|
|
76
|
-
* @param {string} scheduledAt
|
|
77
|
-
* @param {boolean} contentAvailable
|
|
78
|
-
* @param {boolean} critical
|
|
79
|
-
* @param {MessagePriority} priority
|
|
141
|
+
* @param {string} params.messageId - Message 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.
|
|
142
|
+
* @param {string} params.title - Title for push notification.
|
|
143
|
+
* @param {string} params.body - Body for push notification.
|
|
144
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
145
|
+
* @param {string[]} params.users - List of User IDs.
|
|
146
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
147
|
+
* @param {object} params.data - Additional key-value pair data for push notification.
|
|
148
|
+
* @param {string} params.action - Action for push notification.
|
|
149
|
+
* @param {string} params.image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
150
|
+
* @param {string} params.icon - Icon for push notification. Available only for Android and Web Platform.
|
|
151
|
+
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
152
|
+
* @param {string} params.color - Color for push notification. Available only for Android Platform.
|
|
153
|
+
* @param {string} params.tag - Tag for push notification. Available only for Android Platform.
|
|
154
|
+
* @param {number} params.badge - Badge for push notification. Available only for iOS Platform.
|
|
155
|
+
* @param {boolean} params.draft - Is message a draft
|
|
156
|
+
* @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.
|
|
157
|
+
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
158
|
+
* @param {boolean} params.critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
159
|
+
* @param {MessagePriority} params.priority - Set the notification priority. "normal" will consider device state and may not deliver notifications immediately. "high" will always attempt to immediately deliver the notification.
|
|
160
|
+
* @throws {AppwriteException}
|
|
161
|
+
* @returns {Promise<Models.Message>}
|
|
162
|
+
*/
|
|
163
|
+
createPush(params: {
|
|
164
|
+
messageId: string;
|
|
165
|
+
title?: string;
|
|
166
|
+
body?: string;
|
|
167
|
+
topics?: string[];
|
|
168
|
+
users?: string[];
|
|
169
|
+
targets?: string[];
|
|
170
|
+
data?: object;
|
|
171
|
+
action?: string;
|
|
172
|
+
image?: string;
|
|
173
|
+
icon?: string;
|
|
174
|
+
sound?: string;
|
|
175
|
+
color?: string;
|
|
176
|
+
tag?: string;
|
|
177
|
+
badge?: number;
|
|
178
|
+
draft?: boolean;
|
|
179
|
+
scheduledAt?: string;
|
|
180
|
+
contentAvailable?: boolean;
|
|
181
|
+
critical?: boolean;
|
|
182
|
+
priority?: MessagePriority;
|
|
183
|
+
}): Promise<Models.Message>;
|
|
184
|
+
/**
|
|
185
|
+
* Create a new push notification.
|
|
186
|
+
*
|
|
187
|
+
* @param {string} messageId - Message 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.
|
|
188
|
+
* @param {string} title - Title for push notification.
|
|
189
|
+
* @param {string} body - Body for push notification.
|
|
190
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
191
|
+
* @param {string[]} users - List of User IDs.
|
|
192
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
193
|
+
* @param {object} data - Additional key-value pair data for push notification.
|
|
194
|
+
* @param {string} action - Action for push notification.
|
|
195
|
+
* @param {string} image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
196
|
+
* @param {string} icon - Icon for push notification. Available only for Android and Web Platform.
|
|
197
|
+
* @param {string} sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
198
|
+
* @param {string} color - Color for push notification. Available only for Android Platform.
|
|
199
|
+
* @param {string} tag - Tag for push notification. Available only for Android Platform.
|
|
200
|
+
* @param {number} badge - Badge for push notification. Available only for iOS Platform.
|
|
201
|
+
* @param {boolean} draft - Is message a draft
|
|
202
|
+
* @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.
|
|
203
|
+
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
204
|
+
* @param {boolean} critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
205
|
+
* @param {MessagePriority} priority - Set the notification priority. "normal" will consider device state and may not deliver notifications immediately. "high" will always attempt to immediately deliver the notification.
|
|
80
206
|
* @throws {AppwriteException}
|
|
81
207
|
* @returns {Promise<Models.Message>}
|
|
208
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
82
209
|
*/
|
|
83
210
|
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>;
|
|
84
211
|
/**
|
|
85
212
|
* 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.
|
|
86
|
-
|
|
87
213
|
*
|
|
88
|
-
*
|
|
89
|
-
* @param {string
|
|
90
|
-
* @param {string[]}
|
|
91
|
-
* @param {string[]}
|
|
92
|
-
* @param {string}
|
|
93
|
-
* @param {string}
|
|
94
|
-
* @param {
|
|
95
|
-
* @param {
|
|
96
|
-
* @param {string}
|
|
97
|
-
* @param {string}
|
|
98
|
-
* @param {string}
|
|
99
|
-
* @param {string}
|
|
100
|
-
* @param {string}
|
|
101
|
-
* @param {
|
|
102
|
-
* @param {
|
|
103
|
-
* @param {
|
|
104
|
-
* @param {
|
|
105
|
-
* @param {boolean}
|
|
106
|
-
* @param {
|
|
214
|
+
*
|
|
215
|
+
* @param {string} params.messageId - Message ID.
|
|
216
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
217
|
+
* @param {string[]} params.users - List of User IDs.
|
|
218
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
219
|
+
* @param {string} params.title - Title for push notification.
|
|
220
|
+
* @param {string} params.body - Body for push notification.
|
|
221
|
+
* @param {object} params.data - Additional Data for push notification.
|
|
222
|
+
* @param {string} params.action - Action for push notification.
|
|
223
|
+
* @param {string} params.image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
224
|
+
* @param {string} params.icon - Icon for push notification. Available only for Android and Web platforms.
|
|
225
|
+
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
226
|
+
* @param {string} params.color - Color for push notification. Available only for Android platforms.
|
|
227
|
+
* @param {string} params.tag - Tag for push notification. Available only for Android platforms.
|
|
228
|
+
* @param {number} params.badge - Badge for push notification. Available only for iOS platforms.
|
|
229
|
+
* @param {boolean} params.draft - Is message a draft
|
|
230
|
+
* @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.
|
|
231
|
+
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
232
|
+
* @param {boolean} params.critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
233
|
+
* @param {MessagePriority} params.priority - Set the notification priority. "normal" will consider device battery state and may send notifications later. "high" will always attempt to immediately deliver the notification.
|
|
107
234
|
* @throws {AppwriteException}
|
|
108
235
|
* @returns {Promise<Models.Message>}
|
|
109
236
|
*/
|
|
237
|
+
updatePush(params: {
|
|
238
|
+
messageId: string;
|
|
239
|
+
topics?: string[];
|
|
240
|
+
users?: string[];
|
|
241
|
+
targets?: string[];
|
|
242
|
+
title?: string;
|
|
243
|
+
body?: string;
|
|
244
|
+
data?: object;
|
|
245
|
+
action?: string;
|
|
246
|
+
image?: string;
|
|
247
|
+
icon?: string;
|
|
248
|
+
sound?: string;
|
|
249
|
+
color?: string;
|
|
250
|
+
tag?: string;
|
|
251
|
+
badge?: number;
|
|
252
|
+
draft?: boolean;
|
|
253
|
+
scheduledAt?: string;
|
|
254
|
+
contentAvailable?: boolean;
|
|
255
|
+
critical?: boolean;
|
|
256
|
+
priority?: MessagePriority;
|
|
257
|
+
}): Promise<Models.Message>;
|
|
258
|
+
/**
|
|
259
|
+
* 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.
|
|
260
|
+
*
|
|
261
|
+
*
|
|
262
|
+
* @param {string} messageId - Message ID.
|
|
263
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
264
|
+
* @param {string[]} users - List of User IDs.
|
|
265
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
266
|
+
* @param {string} title - Title for push notification.
|
|
267
|
+
* @param {string} body - Body for push notification.
|
|
268
|
+
* @param {object} data - Additional Data for push notification.
|
|
269
|
+
* @param {string} action - Action for push notification.
|
|
270
|
+
* @param {string} image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
271
|
+
* @param {string} icon - Icon for push notification. Available only for Android and Web platforms.
|
|
272
|
+
* @param {string} sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
273
|
+
* @param {string} color - Color for push notification. Available only for Android platforms.
|
|
274
|
+
* @param {string} tag - Tag for push notification. Available only for Android platforms.
|
|
275
|
+
* @param {number} badge - Badge for push notification. Available only for iOS platforms.
|
|
276
|
+
* @param {boolean} draft - Is message a draft
|
|
277
|
+
* @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.
|
|
278
|
+
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
279
|
+
* @param {boolean} critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
280
|
+
* @param {MessagePriority} priority - Set the notification priority. "normal" will consider device battery state and may send notifications later. "high" will always attempt to immediately deliver the notification.
|
|
281
|
+
* @throws {AppwriteException}
|
|
282
|
+
* @returns {Promise<Models.Message>}
|
|
283
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
284
|
+
*/
|
|
110
285
|
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>;
|
|
111
286
|
/**
|
|
112
287
|
* Create a new SMS message.
|
|
113
288
|
*
|
|
114
|
-
* @param {string} messageId
|
|
115
|
-
* @param {string} content
|
|
116
|
-
* @param {string[]} topics
|
|
117
|
-
* @param {string[]} users
|
|
118
|
-
* @param {string[]} targets
|
|
119
|
-
* @param {boolean} draft
|
|
120
|
-
* @param {string} scheduledAt
|
|
289
|
+
* @param {string} params.messageId - Message 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.
|
|
290
|
+
* @param {string} params.content - SMS Content.
|
|
291
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
292
|
+
* @param {string[]} params.users - List of User IDs.
|
|
293
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
294
|
+
* @param {boolean} params.draft - Is message a draft
|
|
295
|
+
* @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.
|
|
121
296
|
* @throws {AppwriteException}
|
|
122
297
|
* @returns {Promise<Models.Message>}
|
|
298
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.createSMS` instead.
|
|
299
|
+
*/
|
|
300
|
+
createSms(params: {
|
|
301
|
+
messageId: string;
|
|
302
|
+
content: string;
|
|
303
|
+
topics?: string[];
|
|
304
|
+
users?: string[];
|
|
305
|
+
targets?: string[];
|
|
306
|
+
draft?: boolean;
|
|
307
|
+
scheduledAt?: string;
|
|
308
|
+
}): Promise<Models.Message>;
|
|
309
|
+
/**
|
|
310
|
+
* Create a new SMS message.
|
|
311
|
+
*
|
|
312
|
+
* @param {string} messageId - Message 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.
|
|
313
|
+
* @param {string} content - SMS Content.
|
|
314
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
315
|
+
* @param {string[]} users - List of User IDs.
|
|
316
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
317
|
+
* @param {boolean} draft - Is message a draft
|
|
318
|
+
* @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.
|
|
319
|
+
* @throws {AppwriteException}
|
|
320
|
+
* @returns {Promise<Models.Message>}
|
|
321
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
123
322
|
*/
|
|
124
323
|
createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
324
|
+
/**
|
|
325
|
+
* Create a new SMS message.
|
|
326
|
+
*
|
|
327
|
+
* @param {string} params.messageId - Message 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.
|
|
328
|
+
* @param {string} params.content - SMS Content.
|
|
329
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
330
|
+
* @param {string[]} params.users - List of User IDs.
|
|
331
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
332
|
+
* @param {boolean} params.draft - Is message a draft
|
|
333
|
+
* @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.
|
|
334
|
+
* @throws {AppwriteException}
|
|
335
|
+
* @returns {Promise<Models.Message>}
|
|
336
|
+
*/
|
|
337
|
+
createSMS(params: {
|
|
338
|
+
messageId: string;
|
|
339
|
+
content: string;
|
|
340
|
+
topics?: string[];
|
|
341
|
+
users?: string[];
|
|
342
|
+
targets?: string[];
|
|
343
|
+
draft?: boolean;
|
|
344
|
+
scheduledAt?: string;
|
|
345
|
+
}): Promise<Models.Message>;
|
|
346
|
+
/**
|
|
347
|
+
* Create a new SMS message.
|
|
348
|
+
*
|
|
349
|
+
* @param {string} messageId - Message 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.
|
|
350
|
+
* @param {string} content - SMS Content.
|
|
351
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
352
|
+
* @param {string[]} users - List of User IDs.
|
|
353
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
354
|
+
* @param {boolean} draft - Is message a draft
|
|
355
|
+
* @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.
|
|
356
|
+
* @throws {AppwriteException}
|
|
357
|
+
* @returns {Promise<Models.Message>}
|
|
358
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
359
|
+
*/
|
|
360
|
+
createSMS(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
125
361
|
/**
|
|
126
362
|
* Update an SMS message 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.
|
|
127
|
-
|
|
128
363
|
*
|
|
129
|
-
*
|
|
130
|
-
* @param {string
|
|
131
|
-
* @param {string[]}
|
|
132
|
-
* @param {string[]}
|
|
133
|
-
* @param {string}
|
|
134
|
-
* @param {
|
|
135
|
-
* @param {
|
|
364
|
+
*
|
|
365
|
+
* @param {string} params.messageId - Message ID.
|
|
366
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
367
|
+
* @param {string[]} params.users - List of User IDs.
|
|
368
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
369
|
+
* @param {string} params.content - Email Content.
|
|
370
|
+
* @param {boolean} params.draft - Is message a draft
|
|
371
|
+
* @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.
|
|
372
|
+
* @throws {AppwriteException}
|
|
373
|
+
* @returns {Promise<Models.Message>}
|
|
374
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.updateSMS` instead.
|
|
375
|
+
*/
|
|
376
|
+
updateSms(params: {
|
|
377
|
+
messageId: string;
|
|
378
|
+
topics?: string[];
|
|
379
|
+
users?: string[];
|
|
380
|
+
targets?: string[];
|
|
381
|
+
content?: string;
|
|
382
|
+
draft?: boolean;
|
|
383
|
+
scheduledAt?: string;
|
|
384
|
+
}): Promise<Models.Message>;
|
|
385
|
+
/**
|
|
386
|
+
* Update an SMS message 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.
|
|
387
|
+
*
|
|
388
|
+
*
|
|
389
|
+
* @param {string} messageId - Message ID.
|
|
390
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
391
|
+
* @param {string[]} users - List of User IDs.
|
|
392
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
393
|
+
* @param {string} content - Email Content.
|
|
394
|
+
* @param {boolean} draft - Is message a draft
|
|
395
|
+
* @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.
|
|
136
396
|
* @throws {AppwriteException}
|
|
137
397
|
* @returns {Promise<Models.Message>}
|
|
398
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
138
399
|
*/
|
|
139
400
|
updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
401
|
+
/**
|
|
402
|
+
* Update an SMS message 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.
|
|
403
|
+
*
|
|
404
|
+
*
|
|
405
|
+
* @param {string} params.messageId - Message ID.
|
|
406
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
407
|
+
* @param {string[]} params.users - List of User IDs.
|
|
408
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
409
|
+
* @param {string} params.content - Email Content.
|
|
410
|
+
* @param {boolean} params.draft - Is message a draft
|
|
411
|
+
* @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.
|
|
412
|
+
* @throws {AppwriteException}
|
|
413
|
+
* @returns {Promise<Models.Message>}
|
|
414
|
+
*/
|
|
415
|
+
updateSMS(params: {
|
|
416
|
+
messageId: string;
|
|
417
|
+
topics?: string[];
|
|
418
|
+
users?: string[];
|
|
419
|
+
targets?: string[];
|
|
420
|
+
content?: string;
|
|
421
|
+
draft?: boolean;
|
|
422
|
+
scheduledAt?: string;
|
|
423
|
+
}): Promise<Models.Message>;
|
|
424
|
+
/**
|
|
425
|
+
* Update an SMS message 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.
|
|
426
|
+
*
|
|
427
|
+
*
|
|
428
|
+
* @param {string} messageId - Message ID.
|
|
429
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
430
|
+
* @param {string[]} users - List of User IDs.
|
|
431
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
432
|
+
* @param {string} content - Email Content.
|
|
433
|
+
* @param {boolean} draft - Is message a draft
|
|
434
|
+
* @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.
|
|
435
|
+
* @throws {AppwriteException}
|
|
436
|
+
* @returns {Promise<Models.Message>}
|
|
437
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
438
|
+
*/
|
|
439
|
+
updateSMS(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
140
440
|
/**
|
|
141
441
|
* Get a message by its unique ID.
|
|
142
|
-
|
|
143
442
|
*
|
|
144
|
-
*
|
|
443
|
+
*
|
|
444
|
+
* @param {string} params.messageId - Message ID.
|
|
145
445
|
* @throws {AppwriteException}
|
|
146
446
|
* @returns {Promise<Models.Message>}
|
|
147
447
|
*/
|
|
448
|
+
getMessage(params: {
|
|
449
|
+
messageId: string;
|
|
450
|
+
}): Promise<Models.Message>;
|
|
451
|
+
/**
|
|
452
|
+
* Get a message by its unique ID.
|
|
453
|
+
*
|
|
454
|
+
*
|
|
455
|
+
* @param {string} messageId - Message ID.
|
|
456
|
+
* @throws {AppwriteException}
|
|
457
|
+
* @returns {Promise<Models.Message>}
|
|
458
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
459
|
+
*/
|
|
148
460
|
getMessage(messageId: string): Promise<Models.Message>;
|
|
149
461
|
/**
|
|
150
462
|
* Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.
|
|
151
463
|
*
|
|
152
|
-
* @param {string} messageId
|
|
464
|
+
* @param {string} params.messageId - Message ID.
|
|
153
465
|
* @throws {AppwriteException}
|
|
154
466
|
* @returns {Promise<{}>}
|
|
155
467
|
*/
|
|
468
|
+
delete(params: {
|
|
469
|
+
messageId: string;
|
|
470
|
+
}): Promise<{}>;
|
|
471
|
+
/**
|
|
472
|
+
* Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.
|
|
473
|
+
*
|
|
474
|
+
* @param {string} messageId - Message ID.
|
|
475
|
+
* @throws {AppwriteException}
|
|
476
|
+
* @returns {Promise<{}>}
|
|
477
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
478
|
+
*/
|
|
156
479
|
delete(messageId: string): Promise<{}>;
|
|
157
480
|
/**
|
|
158
481
|
* Get the message activity logs listed by its unique ID.
|
|
159
482
|
*
|
|
160
|
-
* @param {string} messageId
|
|
161
|
-
* @param {string[]} queries
|
|
483
|
+
* @param {string} params.messageId - Message ID.
|
|
484
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
485
|
+
* @throws {AppwriteException}
|
|
486
|
+
* @returns {Promise<Models.LogList>}
|
|
487
|
+
*/
|
|
488
|
+
listMessageLogs(params: {
|
|
489
|
+
messageId: string;
|
|
490
|
+
queries?: string[];
|
|
491
|
+
}): Promise<Models.LogList>;
|
|
492
|
+
/**
|
|
493
|
+
* Get the message activity logs listed by its unique ID.
|
|
494
|
+
*
|
|
495
|
+
* @param {string} messageId - Message ID.
|
|
496
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
162
497
|
* @throws {AppwriteException}
|
|
163
498
|
* @returns {Promise<Models.LogList>}
|
|
499
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
164
500
|
*/
|
|
165
501
|
listMessageLogs(messageId: string, queries?: string[]): Promise<Models.LogList>;
|
|
166
502
|
/**
|
|
167
503
|
* Get a list of the targets associated with a message.
|
|
168
504
|
*
|
|
169
|
-
* @param {string} messageId
|
|
170
|
-
* @param {string[]} queries
|
|
505
|
+
* @param {string} params.messageId - Message ID.
|
|
506
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType
|
|
171
507
|
* @throws {AppwriteException}
|
|
172
508
|
* @returns {Promise<Models.TargetList>}
|
|
173
509
|
*/
|
|
510
|
+
listTargets(params: {
|
|
511
|
+
messageId: string;
|
|
512
|
+
queries?: string[];
|
|
513
|
+
}): Promise<Models.TargetList>;
|
|
514
|
+
/**
|
|
515
|
+
* Get a list of the targets associated with a message.
|
|
516
|
+
*
|
|
517
|
+
* @param {string} messageId - Message ID.
|
|
518
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType
|
|
519
|
+
* @throws {AppwriteException}
|
|
520
|
+
* @returns {Promise<Models.TargetList>}
|
|
521
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
522
|
+
*/
|
|
174
523
|
listTargets(messageId: string, queries?: string[]): Promise<Models.TargetList>;
|
|
175
524
|
/**
|
|
176
525
|
* Get a list of all providers from the current Appwrite project.
|
|
177
526
|
*
|
|
178
|
-
* @param {string[]} queries
|
|
179
|
-
* @param {string} search
|
|
527
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled
|
|
528
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
180
529
|
* @throws {AppwriteException}
|
|
181
530
|
* @returns {Promise<Models.ProviderList>}
|
|
182
531
|
*/
|
|
532
|
+
listProviders(params?: {
|
|
533
|
+
queries?: string[];
|
|
534
|
+
search?: string;
|
|
535
|
+
}): Promise<Models.ProviderList>;
|
|
536
|
+
/**
|
|
537
|
+
* Get a list of all providers from the current Appwrite project.
|
|
538
|
+
*
|
|
539
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled
|
|
540
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
541
|
+
* @throws {AppwriteException}
|
|
542
|
+
* @returns {Promise<Models.ProviderList>}
|
|
543
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
544
|
+
*/
|
|
183
545
|
listProviders(queries?: string[], search?: string): Promise<Models.ProviderList>;
|
|
184
546
|
/**
|
|
185
547
|
* Create a new Apple Push Notification service provider.
|
|
186
548
|
*
|
|
187
|
-
* @param {string} providerId
|
|
188
|
-
* @param {string} name
|
|
189
|
-
* @param {string} authKey
|
|
190
|
-
* @param {string} authKeyId
|
|
191
|
-
* @param {string} teamId
|
|
192
|
-
* @param {string} bundleId
|
|
193
|
-
* @param {boolean} sandbox
|
|
194
|
-
* @param {boolean} enabled
|
|
549
|
+
* @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.
|
|
550
|
+
* @param {string} params.name - Provider name.
|
|
551
|
+
* @param {string} params.authKey - APNS authentication key.
|
|
552
|
+
* @param {string} params.authKeyId - APNS authentication key ID.
|
|
553
|
+
* @param {string} params.teamId - APNS team ID.
|
|
554
|
+
* @param {string} params.bundleId - APNS bundle ID.
|
|
555
|
+
* @param {boolean} params.sandbox - Use APNS sandbox environment.
|
|
556
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
195
557
|
* @throws {AppwriteException}
|
|
196
558
|
* @returns {Promise<Models.Provider>}
|
|
559
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.createAPNSProvider` instead.
|
|
560
|
+
*/
|
|
561
|
+
createApnsProvider(params: {
|
|
562
|
+
providerId: string;
|
|
563
|
+
name: string;
|
|
564
|
+
authKey?: string;
|
|
565
|
+
authKeyId?: string;
|
|
566
|
+
teamId?: string;
|
|
567
|
+
bundleId?: string;
|
|
568
|
+
sandbox?: boolean;
|
|
569
|
+
enabled?: boolean;
|
|
570
|
+
}): Promise<Models.Provider>;
|
|
571
|
+
/**
|
|
572
|
+
* Create a new Apple Push Notification service provider.
|
|
573
|
+
*
|
|
574
|
+
* @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.
|
|
575
|
+
* @param {string} name - Provider name.
|
|
576
|
+
* @param {string} authKey - APNS authentication key.
|
|
577
|
+
* @param {string} authKeyId - APNS authentication key ID.
|
|
578
|
+
* @param {string} teamId - APNS team ID.
|
|
579
|
+
* @param {string} bundleId - APNS bundle ID.
|
|
580
|
+
* @param {boolean} sandbox - Use APNS sandbox environment.
|
|
581
|
+
* @param {boolean} enabled - Set as enabled.
|
|
582
|
+
* @throws {AppwriteException}
|
|
583
|
+
* @returns {Promise<Models.Provider>}
|
|
584
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
197
585
|
*/
|
|
198
586
|
createApnsProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean, enabled?: boolean): Promise<Models.Provider>;
|
|
587
|
+
/**
|
|
588
|
+
* Create a new Apple Push Notification service provider.
|
|
589
|
+
*
|
|
590
|
+
* @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.
|
|
591
|
+
* @param {string} params.name - Provider name.
|
|
592
|
+
* @param {string} params.authKey - APNS authentication key.
|
|
593
|
+
* @param {string} params.authKeyId - APNS authentication key ID.
|
|
594
|
+
* @param {string} params.teamId - APNS team ID.
|
|
595
|
+
* @param {string} params.bundleId - APNS bundle ID.
|
|
596
|
+
* @param {boolean} params.sandbox - Use APNS sandbox environment.
|
|
597
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
598
|
+
* @throws {AppwriteException}
|
|
599
|
+
* @returns {Promise<Models.Provider>}
|
|
600
|
+
*/
|
|
601
|
+
createAPNSProvider(params: {
|
|
602
|
+
providerId: string;
|
|
603
|
+
name: string;
|
|
604
|
+
authKey?: string;
|
|
605
|
+
authKeyId?: string;
|
|
606
|
+
teamId?: string;
|
|
607
|
+
bundleId?: string;
|
|
608
|
+
sandbox?: boolean;
|
|
609
|
+
enabled?: boolean;
|
|
610
|
+
}): Promise<Models.Provider>;
|
|
611
|
+
/**
|
|
612
|
+
* Create a new Apple Push Notification service provider.
|
|
613
|
+
*
|
|
614
|
+
* @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.
|
|
615
|
+
* @param {string} name - Provider name.
|
|
616
|
+
* @param {string} authKey - APNS authentication key.
|
|
617
|
+
* @param {string} authKeyId - APNS authentication key ID.
|
|
618
|
+
* @param {string} teamId - APNS team ID.
|
|
619
|
+
* @param {string} bundleId - APNS bundle ID.
|
|
620
|
+
* @param {boolean} sandbox - Use APNS sandbox environment.
|
|
621
|
+
* @param {boolean} enabled - Set as enabled.
|
|
622
|
+
* @throws {AppwriteException}
|
|
623
|
+
* @returns {Promise<Models.Provider>}
|
|
624
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
625
|
+
*/
|
|
626
|
+
createAPNSProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean, enabled?: boolean): Promise<Models.Provider>;
|
|
199
627
|
/**
|
|
200
628
|
* Update a Apple Push Notification service provider by its unique ID.
|
|
201
629
|
*
|
|
202
|
-
* @param {string} providerId
|
|
203
|
-
* @param {string} name
|
|
204
|
-
* @param {boolean} enabled
|
|
205
|
-
* @param {string} authKey
|
|
206
|
-
* @param {string} authKeyId
|
|
207
|
-
* @param {string} teamId
|
|
208
|
-
* @param {string} bundleId
|
|
209
|
-
* @param {boolean} sandbox
|
|
630
|
+
* @param {string} params.providerId - Provider ID.
|
|
631
|
+
* @param {string} params.name - Provider name.
|
|
632
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
633
|
+
* @param {string} params.authKey - APNS authentication key.
|
|
634
|
+
* @param {string} params.authKeyId - APNS authentication key ID.
|
|
635
|
+
* @param {string} params.teamId - APNS team ID.
|
|
636
|
+
* @param {string} params.bundleId - APNS bundle ID.
|
|
637
|
+
* @param {boolean} params.sandbox - Use APNS sandbox environment.
|
|
210
638
|
* @throws {AppwriteException}
|
|
211
639
|
* @returns {Promise<Models.Provider>}
|
|
640
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.updateAPNSProvider` instead.
|
|
641
|
+
*/
|
|
642
|
+
updateApnsProvider(params: {
|
|
643
|
+
providerId: string;
|
|
644
|
+
name?: string;
|
|
645
|
+
enabled?: boolean;
|
|
646
|
+
authKey?: string;
|
|
647
|
+
authKeyId?: string;
|
|
648
|
+
teamId?: string;
|
|
649
|
+
bundleId?: string;
|
|
650
|
+
sandbox?: boolean;
|
|
651
|
+
}): Promise<Models.Provider>;
|
|
652
|
+
/**
|
|
653
|
+
* Update a Apple Push Notification service provider by its unique ID.
|
|
654
|
+
*
|
|
655
|
+
* @param {string} providerId - Provider ID.
|
|
656
|
+
* @param {string} name - Provider name.
|
|
657
|
+
* @param {boolean} enabled - Set as enabled.
|
|
658
|
+
* @param {string} authKey - APNS authentication key.
|
|
659
|
+
* @param {string} authKeyId - APNS authentication key ID.
|
|
660
|
+
* @param {string} teamId - APNS team ID.
|
|
661
|
+
* @param {string} bundleId - APNS bundle ID.
|
|
662
|
+
* @param {boolean} sandbox - Use APNS sandbox environment.
|
|
663
|
+
* @throws {AppwriteException}
|
|
664
|
+
* @returns {Promise<Models.Provider>}
|
|
665
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
212
666
|
*/
|
|
213
667
|
updateApnsProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean): Promise<Models.Provider>;
|
|
668
|
+
/**
|
|
669
|
+
* Update a Apple Push Notification service provider by its unique ID.
|
|
670
|
+
*
|
|
671
|
+
* @param {string} params.providerId - Provider ID.
|
|
672
|
+
* @param {string} params.name - Provider name.
|
|
673
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
674
|
+
* @param {string} params.authKey - APNS authentication key.
|
|
675
|
+
* @param {string} params.authKeyId - APNS authentication key ID.
|
|
676
|
+
* @param {string} params.teamId - APNS team ID.
|
|
677
|
+
* @param {string} params.bundleId - APNS bundle ID.
|
|
678
|
+
* @param {boolean} params.sandbox - Use APNS sandbox environment.
|
|
679
|
+
* @throws {AppwriteException}
|
|
680
|
+
* @returns {Promise<Models.Provider>}
|
|
681
|
+
*/
|
|
682
|
+
updateAPNSProvider(params: {
|
|
683
|
+
providerId: string;
|
|
684
|
+
name?: string;
|
|
685
|
+
enabled?: boolean;
|
|
686
|
+
authKey?: string;
|
|
687
|
+
authKeyId?: string;
|
|
688
|
+
teamId?: string;
|
|
689
|
+
bundleId?: string;
|
|
690
|
+
sandbox?: boolean;
|
|
691
|
+
}): Promise<Models.Provider>;
|
|
692
|
+
/**
|
|
693
|
+
* Update a Apple Push Notification service provider by its unique ID.
|
|
694
|
+
*
|
|
695
|
+
* @param {string} providerId - Provider ID.
|
|
696
|
+
* @param {string} name - Provider name.
|
|
697
|
+
* @param {boolean} enabled - Set as enabled.
|
|
698
|
+
* @param {string} authKey - APNS authentication key.
|
|
699
|
+
* @param {string} authKeyId - APNS authentication key ID.
|
|
700
|
+
* @param {string} teamId - APNS team ID.
|
|
701
|
+
* @param {string} bundleId - APNS bundle ID.
|
|
702
|
+
* @param {boolean} sandbox - Use APNS sandbox environment.
|
|
703
|
+
* @throws {AppwriteException}
|
|
704
|
+
* @returns {Promise<Models.Provider>}
|
|
705
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
706
|
+
*/
|
|
707
|
+
updateAPNSProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean): Promise<Models.Provider>;
|
|
214
708
|
/**
|
|
215
709
|
* Create a new Firebase Cloud Messaging provider.
|
|
216
710
|
*
|
|
217
|
-
* @param {string} providerId
|
|
218
|
-
* @param {string} name
|
|
219
|
-
* @param {object} serviceAccountJSON
|
|
220
|
-
* @param {boolean} enabled
|
|
711
|
+
* @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.
|
|
712
|
+
* @param {string} params.name - Provider name.
|
|
713
|
+
* @param {object} params.serviceAccountJSON - FCM service account JSON.
|
|
714
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
221
715
|
* @throws {AppwriteException}
|
|
222
716
|
* @returns {Promise<Models.Provider>}
|
|
717
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.createFCMProvider` instead.
|
|
718
|
+
*/
|
|
719
|
+
createFcmProvider(params: {
|
|
720
|
+
providerId: string;
|
|
721
|
+
name: string;
|
|
722
|
+
serviceAccountJSON?: object;
|
|
723
|
+
enabled?: boolean;
|
|
724
|
+
}): Promise<Models.Provider>;
|
|
725
|
+
/**
|
|
726
|
+
* Create a new Firebase Cloud Messaging provider.
|
|
727
|
+
*
|
|
728
|
+
* @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.
|
|
729
|
+
* @param {string} name - Provider name.
|
|
730
|
+
* @param {object} serviceAccountJSON - FCM service account JSON.
|
|
731
|
+
* @param {boolean} enabled - Set as enabled.
|
|
732
|
+
* @throws {AppwriteException}
|
|
733
|
+
* @returns {Promise<Models.Provider>}
|
|
734
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
223
735
|
*/
|
|
224
736
|
createFcmProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
|
|
737
|
+
/**
|
|
738
|
+
* Create a new Firebase Cloud Messaging provider.
|
|
739
|
+
*
|
|
740
|
+
* @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.
|
|
741
|
+
* @param {string} params.name - Provider name.
|
|
742
|
+
* @param {object} params.serviceAccountJSON - FCM service account JSON.
|
|
743
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
744
|
+
* @throws {AppwriteException}
|
|
745
|
+
* @returns {Promise<Models.Provider>}
|
|
746
|
+
*/
|
|
747
|
+
createFCMProvider(params: {
|
|
748
|
+
providerId: string;
|
|
749
|
+
name: string;
|
|
750
|
+
serviceAccountJSON?: object;
|
|
751
|
+
enabled?: boolean;
|
|
752
|
+
}): Promise<Models.Provider>;
|
|
753
|
+
/**
|
|
754
|
+
* Create a new Firebase Cloud Messaging provider.
|
|
755
|
+
*
|
|
756
|
+
* @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.
|
|
757
|
+
* @param {string} name - Provider name.
|
|
758
|
+
* @param {object} serviceAccountJSON - FCM service account JSON.
|
|
759
|
+
* @param {boolean} enabled - Set as enabled.
|
|
760
|
+
* @throws {AppwriteException}
|
|
761
|
+
* @returns {Promise<Models.Provider>}
|
|
762
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
763
|
+
*/
|
|
764
|
+
createFCMProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
|
|
765
|
+
/**
|
|
766
|
+
* Update a Firebase Cloud Messaging provider by its unique ID.
|
|
767
|
+
*
|
|
768
|
+
* @param {string} params.providerId - Provider ID.
|
|
769
|
+
* @param {string} params.name - Provider name.
|
|
770
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
771
|
+
* @param {object} params.serviceAccountJSON - FCM service account JSON.
|
|
772
|
+
* @throws {AppwriteException}
|
|
773
|
+
* @returns {Promise<Models.Provider>}
|
|
774
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.updateFCMProvider` instead.
|
|
775
|
+
*/
|
|
776
|
+
updateFcmProvider(params: {
|
|
777
|
+
providerId: string;
|
|
778
|
+
name?: string;
|
|
779
|
+
enabled?: boolean;
|
|
780
|
+
serviceAccountJSON?: object;
|
|
781
|
+
}): Promise<Models.Provider>;
|
|
225
782
|
/**
|
|
226
783
|
* Update a Firebase Cloud Messaging provider by its unique ID.
|
|
227
784
|
*
|
|
228
|
-
* @param {string} providerId
|
|
229
|
-
* @param {string} name
|
|
230
|
-
* @param {boolean} enabled
|
|
231
|
-
* @param {object} serviceAccountJSON
|
|
785
|
+
* @param {string} providerId - Provider ID.
|
|
786
|
+
* @param {string} name - Provider name.
|
|
787
|
+
* @param {boolean} enabled - Set as enabled.
|
|
788
|
+
* @param {object} serviceAccountJSON - FCM service account JSON.
|
|
232
789
|
* @throws {AppwriteException}
|
|
233
790
|
* @returns {Promise<Models.Provider>}
|
|
791
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
234
792
|
*/
|
|
235
793
|
updateFcmProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
|
|
794
|
+
/**
|
|
795
|
+
* Update a Firebase Cloud Messaging provider by its unique ID.
|
|
796
|
+
*
|
|
797
|
+
* @param {string} params.providerId - Provider ID.
|
|
798
|
+
* @param {string} params.name - Provider name.
|
|
799
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
800
|
+
* @param {object} params.serviceAccountJSON - FCM service account JSON.
|
|
801
|
+
* @throws {AppwriteException}
|
|
802
|
+
* @returns {Promise<Models.Provider>}
|
|
803
|
+
*/
|
|
804
|
+
updateFCMProvider(params: {
|
|
805
|
+
providerId: string;
|
|
806
|
+
name?: string;
|
|
807
|
+
enabled?: boolean;
|
|
808
|
+
serviceAccountJSON?: object;
|
|
809
|
+
}): Promise<Models.Provider>;
|
|
810
|
+
/**
|
|
811
|
+
* Update a Firebase Cloud Messaging provider by its unique ID.
|
|
812
|
+
*
|
|
813
|
+
* @param {string} providerId - Provider ID.
|
|
814
|
+
* @param {string} name - Provider name.
|
|
815
|
+
* @param {boolean} enabled - Set as enabled.
|
|
816
|
+
* @param {object} serviceAccountJSON - FCM service account JSON.
|
|
817
|
+
* @throws {AppwriteException}
|
|
818
|
+
* @returns {Promise<Models.Provider>}
|
|
819
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
820
|
+
*/
|
|
821
|
+
updateFCMProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
|
|
822
|
+
/**
|
|
823
|
+
* Create a new Mailgun provider.
|
|
824
|
+
*
|
|
825
|
+
* @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.
|
|
826
|
+
* @param {string} params.name - Provider name.
|
|
827
|
+
* @param {string} params.apiKey - Mailgun API Key.
|
|
828
|
+
* @param {string} params.domain - Mailgun Domain.
|
|
829
|
+
* @param {boolean} params.isEuRegion - Set as EU region.
|
|
830
|
+
* @param {string} params.fromName - Sender Name.
|
|
831
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
832
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.
|
|
833
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.
|
|
834
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
835
|
+
* @throws {AppwriteException}
|
|
836
|
+
* @returns {Promise<Models.Provider>}
|
|
837
|
+
*/
|
|
838
|
+
createMailgunProvider(params: {
|
|
839
|
+
providerId: string;
|
|
840
|
+
name: string;
|
|
841
|
+
apiKey?: string;
|
|
842
|
+
domain?: string;
|
|
843
|
+
isEuRegion?: boolean;
|
|
844
|
+
fromName?: string;
|
|
845
|
+
fromEmail?: string;
|
|
846
|
+
replyToName?: string;
|
|
847
|
+
replyToEmail?: string;
|
|
848
|
+
enabled?: boolean;
|
|
849
|
+
}): Promise<Models.Provider>;
|
|
236
850
|
/**
|
|
237
851
|
* Create a new Mailgun provider.
|
|
238
852
|
*
|
|
239
|
-
* @param {string} providerId
|
|
240
|
-
* @param {string} name
|
|
241
|
-
* @param {string} apiKey
|
|
242
|
-
* @param {string} domain
|
|
243
|
-
* @param {boolean} isEuRegion
|
|
244
|
-
* @param {string} fromName
|
|
245
|
-
* @param {string} fromEmail
|
|
246
|
-
* @param {string} replyToName
|
|
247
|
-
* @param {string} replyToEmail
|
|
248
|
-
* @param {boolean} enabled
|
|
853
|
+
* @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.
|
|
854
|
+
* @param {string} name - Provider name.
|
|
855
|
+
* @param {string} apiKey - Mailgun API Key.
|
|
856
|
+
* @param {string} domain - Mailgun Domain.
|
|
857
|
+
* @param {boolean} isEuRegion - Set as EU region.
|
|
858
|
+
* @param {string} fromName - Sender Name.
|
|
859
|
+
* @param {string} fromEmail - Sender email address.
|
|
860
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.
|
|
861
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.
|
|
862
|
+
* @param {boolean} enabled - Set as enabled.
|
|
249
863
|
* @throws {AppwriteException}
|
|
250
864
|
* @returns {Promise<Models.Provider>}
|
|
865
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
251
866
|
*/
|
|
252
867
|
createMailgunProvider(providerId: string, name: string, apiKey?: string, domain?: string, isEuRegion?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
253
868
|
/**
|
|
254
869
|
* Update a Mailgun provider by its unique ID.
|
|
255
870
|
*
|
|
256
|
-
* @param {string} providerId
|
|
257
|
-
* @param {string} name
|
|
258
|
-
* @param {string} apiKey
|
|
259
|
-
* @param {string} domain
|
|
260
|
-
* @param {boolean} isEuRegion
|
|
261
|
-
* @param {boolean} enabled
|
|
262
|
-
* @param {string} fromName
|
|
263
|
-
* @param {string} fromEmail
|
|
264
|
-
* @param {string} replyToName
|
|
265
|
-
* @param {string} replyToEmail
|
|
871
|
+
* @param {string} params.providerId - Provider ID.
|
|
872
|
+
* @param {string} params.name - Provider name.
|
|
873
|
+
* @param {string} params.apiKey - Mailgun API Key.
|
|
874
|
+
* @param {string} params.domain - Mailgun Domain.
|
|
875
|
+
* @param {boolean} params.isEuRegion - Set as EU region.
|
|
876
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
877
|
+
* @param {string} params.fromName - Sender Name.
|
|
878
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
879
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
880
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
881
|
+
* @throws {AppwriteException}
|
|
882
|
+
* @returns {Promise<Models.Provider>}
|
|
883
|
+
*/
|
|
884
|
+
updateMailgunProvider(params: {
|
|
885
|
+
providerId: string;
|
|
886
|
+
name?: string;
|
|
887
|
+
apiKey?: string;
|
|
888
|
+
domain?: string;
|
|
889
|
+
isEuRegion?: boolean;
|
|
890
|
+
enabled?: boolean;
|
|
891
|
+
fromName?: string;
|
|
892
|
+
fromEmail?: string;
|
|
893
|
+
replyToName?: string;
|
|
894
|
+
replyToEmail?: string;
|
|
895
|
+
}): Promise<Models.Provider>;
|
|
896
|
+
/**
|
|
897
|
+
* Update a Mailgun provider by its unique ID.
|
|
898
|
+
*
|
|
899
|
+
* @param {string} providerId - Provider ID.
|
|
900
|
+
* @param {string} name - Provider name.
|
|
901
|
+
* @param {string} apiKey - Mailgun API Key.
|
|
902
|
+
* @param {string} domain - Mailgun Domain.
|
|
903
|
+
* @param {boolean} isEuRegion - Set as EU region.
|
|
904
|
+
* @param {boolean} enabled - Set as enabled.
|
|
905
|
+
* @param {string} fromName - Sender Name.
|
|
906
|
+
* @param {string} fromEmail - Sender email address.
|
|
907
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
908
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
266
909
|
* @throws {AppwriteException}
|
|
267
910
|
* @returns {Promise<Models.Provider>}
|
|
911
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
268
912
|
*/
|
|
269
913
|
updateMailgunProvider(providerId: string, name?: string, apiKey?: string, domain?: string, isEuRegion?: boolean, enabled?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
|
|
270
914
|
/**
|
|
271
915
|
* Create a new MSG91 provider.
|
|
272
916
|
*
|
|
273
|
-
* @param {string} providerId
|
|
274
|
-
* @param {string} name
|
|
275
|
-
* @param {string} templateId
|
|
276
|
-
* @param {string} senderId
|
|
277
|
-
* @param {string} authKey
|
|
278
|
-
* @param {boolean} enabled
|
|
917
|
+
* @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.
|
|
918
|
+
* @param {string} params.name - Provider name.
|
|
919
|
+
* @param {string} params.templateId - Msg91 template ID
|
|
920
|
+
* @param {string} params.senderId - Msg91 sender ID.
|
|
921
|
+
* @param {string} params.authKey - Msg91 auth key.
|
|
922
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
923
|
+
* @throws {AppwriteException}
|
|
924
|
+
* @returns {Promise<Models.Provider>}
|
|
925
|
+
*/
|
|
926
|
+
createMsg91Provider(params: {
|
|
927
|
+
providerId: string;
|
|
928
|
+
name: string;
|
|
929
|
+
templateId?: string;
|
|
930
|
+
senderId?: string;
|
|
931
|
+
authKey?: string;
|
|
932
|
+
enabled?: boolean;
|
|
933
|
+
}): Promise<Models.Provider>;
|
|
934
|
+
/**
|
|
935
|
+
* Create a new MSG91 provider.
|
|
936
|
+
*
|
|
937
|
+
* @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.
|
|
938
|
+
* @param {string} name - Provider name.
|
|
939
|
+
* @param {string} templateId - Msg91 template ID
|
|
940
|
+
* @param {string} senderId - Msg91 sender ID.
|
|
941
|
+
* @param {string} authKey - Msg91 auth key.
|
|
942
|
+
* @param {boolean} enabled - Set as enabled.
|
|
279
943
|
* @throws {AppwriteException}
|
|
280
944
|
* @returns {Promise<Models.Provider>}
|
|
945
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
281
946
|
*/
|
|
282
947
|
createMsg91Provider(providerId: string, name: string, templateId?: string, senderId?: string, authKey?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
283
948
|
/**
|
|
284
949
|
* Update a MSG91 provider by its unique ID.
|
|
285
950
|
*
|
|
286
|
-
* @param {string} providerId
|
|
287
|
-
* @param {string} name
|
|
288
|
-
* @param {boolean} enabled
|
|
289
|
-
* @param {string} templateId
|
|
290
|
-
* @param {string} senderId
|
|
291
|
-
* @param {string} authKey
|
|
951
|
+
* @param {string} params.providerId - Provider ID.
|
|
952
|
+
* @param {string} params.name - Provider name.
|
|
953
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
954
|
+
* @param {string} params.templateId - Msg91 template ID.
|
|
955
|
+
* @param {string} params.senderId - Msg91 sender ID.
|
|
956
|
+
* @param {string} params.authKey - Msg91 auth key.
|
|
957
|
+
* @throws {AppwriteException}
|
|
958
|
+
* @returns {Promise<Models.Provider>}
|
|
959
|
+
*/
|
|
960
|
+
updateMsg91Provider(params: {
|
|
961
|
+
providerId: string;
|
|
962
|
+
name?: string;
|
|
963
|
+
enabled?: boolean;
|
|
964
|
+
templateId?: string;
|
|
965
|
+
senderId?: string;
|
|
966
|
+
authKey?: string;
|
|
967
|
+
}): Promise<Models.Provider>;
|
|
968
|
+
/**
|
|
969
|
+
* Update a MSG91 provider by its unique ID.
|
|
970
|
+
*
|
|
971
|
+
* @param {string} providerId - Provider ID.
|
|
972
|
+
* @param {string} name - Provider name.
|
|
973
|
+
* @param {boolean} enabled - Set as enabled.
|
|
974
|
+
* @param {string} templateId - Msg91 template ID.
|
|
975
|
+
* @param {string} senderId - Msg91 sender ID.
|
|
976
|
+
* @param {string} authKey - Msg91 auth key.
|
|
292
977
|
* @throws {AppwriteException}
|
|
293
978
|
* @returns {Promise<Models.Provider>}
|
|
979
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
294
980
|
*/
|
|
295
981
|
updateMsg91Provider(providerId: string, name?: string, enabled?: boolean, templateId?: string, senderId?: string, authKey?: string): Promise<Models.Provider>;
|
|
296
982
|
/**
|
|
297
983
|
* Create a new Sendgrid provider.
|
|
298
984
|
*
|
|
299
|
-
* @param {string} providerId
|
|
300
|
-
* @param {string} name
|
|
301
|
-
* @param {string} apiKey
|
|
302
|
-
* @param {string} fromName
|
|
303
|
-
* @param {string} fromEmail
|
|
304
|
-
* @param {string} replyToName
|
|
305
|
-
* @param {string} replyToEmail
|
|
306
|
-
* @param {boolean} enabled
|
|
985
|
+
* @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.
|
|
986
|
+
* @param {string} params.name - Provider name.
|
|
987
|
+
* @param {string} params.apiKey - Sendgrid API key.
|
|
988
|
+
* @param {string} params.fromName - Sender Name.
|
|
989
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
990
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
991
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
992
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
993
|
+
* @throws {AppwriteException}
|
|
994
|
+
* @returns {Promise<Models.Provider>}
|
|
995
|
+
*/
|
|
996
|
+
createSendgridProvider(params: {
|
|
997
|
+
providerId: string;
|
|
998
|
+
name: string;
|
|
999
|
+
apiKey?: string;
|
|
1000
|
+
fromName?: string;
|
|
1001
|
+
fromEmail?: string;
|
|
1002
|
+
replyToName?: string;
|
|
1003
|
+
replyToEmail?: string;
|
|
1004
|
+
enabled?: boolean;
|
|
1005
|
+
}): Promise<Models.Provider>;
|
|
1006
|
+
/**
|
|
1007
|
+
* Create a new Sendgrid provider.
|
|
1008
|
+
*
|
|
1009
|
+
* @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.
|
|
1010
|
+
* @param {string} name - Provider name.
|
|
1011
|
+
* @param {string} apiKey - Sendgrid API key.
|
|
1012
|
+
* @param {string} fromName - Sender Name.
|
|
1013
|
+
* @param {string} fromEmail - Sender email address.
|
|
1014
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1015
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1016
|
+
* @param {boolean} enabled - Set as enabled.
|
|
307
1017
|
* @throws {AppwriteException}
|
|
308
1018
|
* @returns {Promise<Models.Provider>}
|
|
1019
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
309
1020
|
*/
|
|
310
1021
|
createSendgridProvider(providerId: string, name: string, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
311
1022
|
/**
|
|
312
1023
|
* Update a Sendgrid provider by its unique ID.
|
|
313
1024
|
*
|
|
314
|
-
* @param {string} providerId
|
|
315
|
-
* @param {string} name
|
|
316
|
-
* @param {boolean} enabled
|
|
317
|
-
* @param {string} apiKey
|
|
318
|
-
* @param {string} fromName
|
|
319
|
-
* @param {string} fromEmail
|
|
320
|
-
* @param {string} replyToName
|
|
321
|
-
* @param {string} replyToEmail
|
|
1025
|
+
* @param {string} params.providerId - Provider ID.
|
|
1026
|
+
* @param {string} params.name - Provider name.
|
|
1027
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1028
|
+
* @param {string} params.apiKey - Sendgrid API key.
|
|
1029
|
+
* @param {string} params.fromName - Sender Name.
|
|
1030
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1031
|
+
* @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1032
|
+
* @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
322
1033
|
* @throws {AppwriteException}
|
|
323
1034
|
* @returns {Promise<Models.Provider>}
|
|
324
1035
|
*/
|
|
1036
|
+
updateSendgridProvider(params: {
|
|
1037
|
+
providerId: string;
|
|
1038
|
+
name?: string;
|
|
1039
|
+
enabled?: boolean;
|
|
1040
|
+
apiKey?: string;
|
|
1041
|
+
fromName?: string;
|
|
1042
|
+
fromEmail?: string;
|
|
1043
|
+
replyToName?: string;
|
|
1044
|
+
replyToEmail?: string;
|
|
1045
|
+
}): Promise<Models.Provider>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Update a Sendgrid provider by its unique ID.
|
|
1048
|
+
*
|
|
1049
|
+
* @param {string} providerId - Provider ID.
|
|
1050
|
+
* @param {string} name - Provider name.
|
|
1051
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1052
|
+
* @param {string} apiKey - Sendgrid API key.
|
|
1053
|
+
* @param {string} fromName - Sender Name.
|
|
1054
|
+
* @param {string} fromEmail - Sender email address.
|
|
1055
|
+
* @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1056
|
+
* @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1057
|
+
* @throws {AppwriteException}
|
|
1058
|
+
* @returns {Promise<Models.Provider>}
|
|
1059
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1060
|
+
*/
|
|
325
1061
|
updateSendgridProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
|
|
326
1062
|
/**
|
|
327
1063
|
* Create a new SMTP provider.
|
|
328
1064
|
*
|
|
329
|
-
* @param {string} providerId
|
|
330
|
-
* @param {string} name
|
|
331
|
-
* @param {string} host
|
|
332
|
-
* @param {number} port
|
|
333
|
-
* @param {string} username
|
|
334
|
-
* @param {string} password
|
|
335
|
-
* @param {SmtpEncryption} encryption
|
|
336
|
-
* @param {boolean} autoTLS
|
|
337
|
-
* @param {string} mailer
|
|
338
|
-
* @param {string} fromName
|
|
339
|
-
* @param {string} fromEmail
|
|
340
|
-
* @param {string} replyToName
|
|
341
|
-
* @param {string} replyToEmail
|
|
342
|
-
* @param {boolean} enabled
|
|
1065
|
+
* @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.
|
|
1066
|
+
* @param {string} params.name - Provider name.
|
|
1067
|
+
* @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.
|
|
1068
|
+
* @param {number} params.port - The default SMTP server port.
|
|
1069
|
+
* @param {string} params.username - Authentication username.
|
|
1070
|
+
* @param {string} params.password - Authentication password.
|
|
1071
|
+
* @param {SmtpEncryption} params.encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
1072
|
+
* @param {boolean} params.autoTLS - Enable SMTP AutoTLS feature.
|
|
1073
|
+
* @param {string} params.mailer - The value to use for the X-Mailer header.
|
|
1074
|
+
* @param {string} params.fromName - Sender Name.
|
|
1075
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1076
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1077
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1078
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1079
|
+
* @throws {AppwriteException}
|
|
1080
|
+
* @returns {Promise<Models.Provider>}
|
|
1081
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.createSMTPProvider` instead.
|
|
1082
|
+
*/
|
|
1083
|
+
createSmtpProvider(params: {
|
|
1084
|
+
providerId: string;
|
|
1085
|
+
name: string;
|
|
1086
|
+
host: string;
|
|
1087
|
+
port?: number;
|
|
1088
|
+
username?: string;
|
|
1089
|
+
password?: string;
|
|
1090
|
+
encryption?: SmtpEncryption;
|
|
1091
|
+
autoTLS?: boolean;
|
|
1092
|
+
mailer?: string;
|
|
1093
|
+
fromName?: string;
|
|
1094
|
+
fromEmail?: string;
|
|
1095
|
+
replyToName?: string;
|
|
1096
|
+
replyToEmail?: string;
|
|
1097
|
+
enabled?: boolean;
|
|
1098
|
+
}): Promise<Models.Provider>;
|
|
1099
|
+
/**
|
|
1100
|
+
* Create a new SMTP provider.
|
|
1101
|
+
*
|
|
1102
|
+
* @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.
|
|
1103
|
+
* @param {string} name - Provider name.
|
|
1104
|
+
* @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.
|
|
1105
|
+
* @param {number} port - The default SMTP server port.
|
|
1106
|
+
* @param {string} username - Authentication username.
|
|
1107
|
+
* @param {string} password - Authentication password.
|
|
1108
|
+
* @param {SmtpEncryption} encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
1109
|
+
* @param {boolean} autoTLS - Enable SMTP AutoTLS feature.
|
|
1110
|
+
* @param {string} mailer - The value to use for the X-Mailer header.
|
|
1111
|
+
* @param {string} fromName - Sender Name.
|
|
1112
|
+
* @param {string} fromEmail - Sender email address.
|
|
1113
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1114
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1115
|
+
* @param {boolean} enabled - Set as enabled.
|
|
343
1116
|
* @throws {AppwriteException}
|
|
344
1117
|
* @returns {Promise<Models.Provider>}
|
|
1118
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
345
1119
|
*/
|
|
346
1120
|
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>;
|
|
1121
|
+
/**
|
|
1122
|
+
* Create a new SMTP provider.
|
|
1123
|
+
*
|
|
1124
|
+
* @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.
|
|
1125
|
+
* @param {string} params.name - Provider name.
|
|
1126
|
+
* @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.
|
|
1127
|
+
* @param {number} params.port - The default SMTP server port.
|
|
1128
|
+
* @param {string} params.username - Authentication username.
|
|
1129
|
+
* @param {string} params.password - Authentication password.
|
|
1130
|
+
* @param {SmtpEncryption} params.encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
1131
|
+
* @param {boolean} params.autoTLS - Enable SMTP AutoTLS feature.
|
|
1132
|
+
* @param {string} params.mailer - The value to use for the X-Mailer header.
|
|
1133
|
+
* @param {string} params.fromName - Sender Name.
|
|
1134
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1135
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1136
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1137
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1138
|
+
* @throws {AppwriteException}
|
|
1139
|
+
* @returns {Promise<Models.Provider>}
|
|
1140
|
+
*/
|
|
1141
|
+
createSMTPProvider(params: {
|
|
1142
|
+
providerId: string;
|
|
1143
|
+
name: string;
|
|
1144
|
+
host: string;
|
|
1145
|
+
port?: number;
|
|
1146
|
+
username?: string;
|
|
1147
|
+
password?: string;
|
|
1148
|
+
encryption?: SmtpEncryption;
|
|
1149
|
+
autoTLS?: boolean;
|
|
1150
|
+
mailer?: string;
|
|
1151
|
+
fromName?: string;
|
|
1152
|
+
fromEmail?: string;
|
|
1153
|
+
replyToName?: string;
|
|
1154
|
+
replyToEmail?: string;
|
|
1155
|
+
enabled?: boolean;
|
|
1156
|
+
}): Promise<Models.Provider>;
|
|
1157
|
+
/**
|
|
1158
|
+
* Create a new SMTP provider.
|
|
1159
|
+
*
|
|
1160
|
+
* @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.
|
|
1161
|
+
* @param {string} name - Provider name.
|
|
1162
|
+
* @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.
|
|
1163
|
+
* @param {number} port - The default SMTP server port.
|
|
1164
|
+
* @param {string} username - Authentication username.
|
|
1165
|
+
* @param {string} password - Authentication password.
|
|
1166
|
+
* @param {SmtpEncryption} encryption - Encryption type. Can be omitted, 'ssl', or 'tls'
|
|
1167
|
+
* @param {boolean} autoTLS - Enable SMTP AutoTLS feature.
|
|
1168
|
+
* @param {string} mailer - The value to use for the X-Mailer header.
|
|
1169
|
+
* @param {string} fromName - Sender Name.
|
|
1170
|
+
* @param {string} fromEmail - Sender email address.
|
|
1171
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
1172
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
1173
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1174
|
+
* @throws {AppwriteException}
|
|
1175
|
+
* @returns {Promise<Models.Provider>}
|
|
1176
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1177
|
+
*/
|
|
1178
|
+
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>;
|
|
347
1179
|
/**
|
|
348
1180
|
* Update a SMTP provider by its unique ID.
|
|
349
1181
|
*
|
|
350
|
-
* @param {string} providerId
|
|
351
|
-
* @param {string} name
|
|
352
|
-
* @param {string} host
|
|
353
|
-
* @param {number} port
|
|
354
|
-
* @param {string} username
|
|
355
|
-
* @param {string} password
|
|
356
|
-
* @param {SmtpEncryption} encryption
|
|
357
|
-
* @param {boolean} autoTLS
|
|
358
|
-
* @param {string} mailer
|
|
359
|
-
* @param {string} fromName
|
|
360
|
-
* @param {string} fromEmail
|
|
361
|
-
* @param {string} replyToName
|
|
362
|
-
* @param {string} replyToEmail
|
|
363
|
-
* @param {boolean} enabled
|
|
1182
|
+
* @param {string} params.providerId - Provider ID.
|
|
1183
|
+
* @param {string} params.name - Provider name.
|
|
1184
|
+
* @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.
|
|
1185
|
+
* @param {number} params.port - SMTP port.
|
|
1186
|
+
* @param {string} params.username - Authentication username.
|
|
1187
|
+
* @param {string} params.password - Authentication password.
|
|
1188
|
+
* @param {SmtpEncryption} params.encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
1189
|
+
* @param {boolean} params.autoTLS - Enable SMTP AutoTLS feature.
|
|
1190
|
+
* @param {string} params.mailer - The value to use for the X-Mailer header.
|
|
1191
|
+
* @param {string} params.fromName - Sender Name.
|
|
1192
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1193
|
+
* @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1194
|
+
* @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1195
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
364
1196
|
* @throws {AppwriteException}
|
|
365
1197
|
* @returns {Promise<Models.Provider>}
|
|
1198
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `Messaging.updateSMTPProvider` instead.
|
|
1199
|
+
*/
|
|
1200
|
+
updateSmtpProvider(params: {
|
|
1201
|
+
providerId: string;
|
|
1202
|
+
name?: string;
|
|
1203
|
+
host?: string;
|
|
1204
|
+
port?: number;
|
|
1205
|
+
username?: string;
|
|
1206
|
+
password?: string;
|
|
1207
|
+
encryption?: SmtpEncryption;
|
|
1208
|
+
autoTLS?: boolean;
|
|
1209
|
+
mailer?: string;
|
|
1210
|
+
fromName?: string;
|
|
1211
|
+
fromEmail?: string;
|
|
1212
|
+
replyToName?: string;
|
|
1213
|
+
replyToEmail?: string;
|
|
1214
|
+
enabled?: boolean;
|
|
1215
|
+
}): Promise<Models.Provider>;
|
|
1216
|
+
/**
|
|
1217
|
+
* Update a SMTP provider by its unique ID.
|
|
1218
|
+
*
|
|
1219
|
+
* @param {string} providerId - Provider ID.
|
|
1220
|
+
* @param {string} name - Provider name.
|
|
1221
|
+
* @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.
|
|
1222
|
+
* @param {number} port - SMTP port.
|
|
1223
|
+
* @param {string} username - Authentication username.
|
|
1224
|
+
* @param {string} password - Authentication password.
|
|
1225
|
+
* @param {SmtpEncryption} encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
1226
|
+
* @param {boolean} autoTLS - Enable SMTP AutoTLS feature.
|
|
1227
|
+
* @param {string} mailer - The value to use for the X-Mailer header.
|
|
1228
|
+
* @param {string} fromName - Sender Name.
|
|
1229
|
+
* @param {string} fromEmail - Sender email address.
|
|
1230
|
+
* @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1231
|
+
* @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1232
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1233
|
+
* @throws {AppwriteException}
|
|
1234
|
+
* @returns {Promise<Models.Provider>}
|
|
1235
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
366
1236
|
*/
|
|
367
1237
|
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>;
|
|
1238
|
+
/**
|
|
1239
|
+
* Update a SMTP provider by its unique ID.
|
|
1240
|
+
*
|
|
1241
|
+
* @param {string} params.providerId - Provider ID.
|
|
1242
|
+
* @param {string} params.name - Provider name.
|
|
1243
|
+
* @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.
|
|
1244
|
+
* @param {number} params.port - SMTP port.
|
|
1245
|
+
* @param {string} params.username - Authentication username.
|
|
1246
|
+
* @param {string} params.password - Authentication password.
|
|
1247
|
+
* @param {SmtpEncryption} params.encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
1248
|
+
* @param {boolean} params.autoTLS - Enable SMTP AutoTLS feature.
|
|
1249
|
+
* @param {string} params.mailer - The value to use for the X-Mailer header.
|
|
1250
|
+
* @param {string} params.fromName - Sender Name.
|
|
1251
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
1252
|
+
* @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1253
|
+
* @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1254
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1255
|
+
* @throws {AppwriteException}
|
|
1256
|
+
* @returns {Promise<Models.Provider>}
|
|
1257
|
+
*/
|
|
1258
|
+
updateSMTPProvider(params: {
|
|
1259
|
+
providerId: string;
|
|
1260
|
+
name?: string;
|
|
1261
|
+
host?: string;
|
|
1262
|
+
port?: number;
|
|
1263
|
+
username?: string;
|
|
1264
|
+
password?: string;
|
|
1265
|
+
encryption?: SmtpEncryption;
|
|
1266
|
+
autoTLS?: boolean;
|
|
1267
|
+
mailer?: string;
|
|
1268
|
+
fromName?: string;
|
|
1269
|
+
fromEmail?: string;
|
|
1270
|
+
replyToName?: string;
|
|
1271
|
+
replyToEmail?: string;
|
|
1272
|
+
enabled?: boolean;
|
|
1273
|
+
}): Promise<Models.Provider>;
|
|
1274
|
+
/**
|
|
1275
|
+
* Update a SMTP provider by its unique ID.
|
|
1276
|
+
*
|
|
1277
|
+
* @param {string} providerId - Provider ID.
|
|
1278
|
+
* @param {string} name - Provider name.
|
|
1279
|
+
* @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.
|
|
1280
|
+
* @param {number} port - SMTP port.
|
|
1281
|
+
* @param {string} username - Authentication username.
|
|
1282
|
+
* @param {string} password - Authentication password.
|
|
1283
|
+
* @param {SmtpEncryption} encryption - Encryption type. Can be 'ssl' or 'tls'
|
|
1284
|
+
* @param {boolean} autoTLS - Enable SMTP AutoTLS feature.
|
|
1285
|
+
* @param {string} mailer - The value to use for the X-Mailer header.
|
|
1286
|
+
* @param {string} fromName - Sender Name.
|
|
1287
|
+
* @param {string} fromEmail - Sender email address.
|
|
1288
|
+
* @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
1289
|
+
* @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
1290
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1291
|
+
* @throws {AppwriteException}
|
|
1292
|
+
* @returns {Promise<Models.Provider>}
|
|
1293
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1294
|
+
*/
|
|
1295
|
+
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>;
|
|
368
1296
|
/**
|
|
369
1297
|
* Create a new Telesign provider.
|
|
370
1298
|
*
|
|
371
|
-
* @param {string} providerId
|
|
372
|
-
* @param {string} name
|
|
373
|
-
* @param {string} from
|
|
374
|
-
* @param {string} customerId
|
|
375
|
-
* @param {string} apiKey
|
|
376
|
-
* @param {boolean} enabled
|
|
1299
|
+
* @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.
|
|
1300
|
+
* @param {string} params.name - Provider name.
|
|
1301
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1302
|
+
* @param {string} params.customerId - Telesign customer ID.
|
|
1303
|
+
* @param {string} params.apiKey - Telesign API key.
|
|
1304
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
377
1305
|
* @throws {AppwriteException}
|
|
378
1306
|
* @returns {Promise<Models.Provider>}
|
|
379
1307
|
*/
|
|
1308
|
+
createTelesignProvider(params: {
|
|
1309
|
+
providerId: string;
|
|
1310
|
+
name: string;
|
|
1311
|
+
from?: string;
|
|
1312
|
+
customerId?: string;
|
|
1313
|
+
apiKey?: string;
|
|
1314
|
+
enabled?: boolean;
|
|
1315
|
+
}): Promise<Models.Provider>;
|
|
1316
|
+
/**
|
|
1317
|
+
* Create a new Telesign provider.
|
|
1318
|
+
*
|
|
1319
|
+
* @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.
|
|
1320
|
+
* @param {string} name - Provider name.
|
|
1321
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1322
|
+
* @param {string} customerId - Telesign customer ID.
|
|
1323
|
+
* @param {string} apiKey - Telesign API key.
|
|
1324
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1325
|
+
* @throws {AppwriteException}
|
|
1326
|
+
* @returns {Promise<Models.Provider>}
|
|
1327
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1328
|
+
*/
|
|
380
1329
|
createTelesignProvider(providerId: string, name: string, from?: string, customerId?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
381
1330
|
/**
|
|
382
1331
|
* Update a Telesign provider by its unique ID.
|
|
383
1332
|
*
|
|
384
|
-
* @param {string} providerId
|
|
385
|
-
* @param {string} name
|
|
386
|
-
* @param {boolean} enabled
|
|
387
|
-
* @param {string} customerId
|
|
388
|
-
* @param {string} apiKey
|
|
389
|
-
* @param {string} from
|
|
1333
|
+
* @param {string} params.providerId - Provider ID.
|
|
1334
|
+
* @param {string} params.name - Provider name.
|
|
1335
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1336
|
+
* @param {string} params.customerId - Telesign customer ID.
|
|
1337
|
+
* @param {string} params.apiKey - Telesign API key.
|
|
1338
|
+
* @param {string} params.from - Sender number.
|
|
390
1339
|
* @throws {AppwriteException}
|
|
391
1340
|
* @returns {Promise<Models.Provider>}
|
|
392
1341
|
*/
|
|
1342
|
+
updateTelesignProvider(params: {
|
|
1343
|
+
providerId: string;
|
|
1344
|
+
name?: string;
|
|
1345
|
+
enabled?: boolean;
|
|
1346
|
+
customerId?: string;
|
|
1347
|
+
apiKey?: string;
|
|
1348
|
+
from?: string;
|
|
1349
|
+
}): Promise<Models.Provider>;
|
|
1350
|
+
/**
|
|
1351
|
+
* Update a Telesign provider by its unique ID.
|
|
1352
|
+
*
|
|
1353
|
+
* @param {string} providerId - Provider ID.
|
|
1354
|
+
* @param {string} name - Provider name.
|
|
1355
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1356
|
+
* @param {string} customerId - Telesign customer ID.
|
|
1357
|
+
* @param {string} apiKey - Telesign API key.
|
|
1358
|
+
* @param {string} from - Sender number.
|
|
1359
|
+
* @throws {AppwriteException}
|
|
1360
|
+
* @returns {Promise<Models.Provider>}
|
|
1361
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1362
|
+
*/
|
|
393
1363
|
updateTelesignProvider(providerId: string, name?: string, enabled?: boolean, customerId?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
|
|
394
1364
|
/**
|
|
395
1365
|
* Create a new Textmagic provider.
|
|
396
1366
|
*
|
|
397
|
-
* @param {string} providerId
|
|
398
|
-
* @param {string} name
|
|
399
|
-
* @param {string} from
|
|
400
|
-
* @param {string} username
|
|
401
|
-
* @param {string} apiKey
|
|
402
|
-
* @param {boolean} enabled
|
|
1367
|
+
* @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.
|
|
1368
|
+
* @param {string} params.name - Provider name.
|
|
1369
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1370
|
+
* @param {string} params.username - Textmagic username.
|
|
1371
|
+
* @param {string} params.apiKey - Textmagic apiKey.
|
|
1372
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1373
|
+
* @throws {AppwriteException}
|
|
1374
|
+
* @returns {Promise<Models.Provider>}
|
|
1375
|
+
*/
|
|
1376
|
+
createTextmagicProvider(params: {
|
|
1377
|
+
providerId: string;
|
|
1378
|
+
name: string;
|
|
1379
|
+
from?: string;
|
|
1380
|
+
username?: string;
|
|
1381
|
+
apiKey?: string;
|
|
1382
|
+
enabled?: boolean;
|
|
1383
|
+
}): Promise<Models.Provider>;
|
|
1384
|
+
/**
|
|
1385
|
+
* Create a new Textmagic provider.
|
|
1386
|
+
*
|
|
1387
|
+
* @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.
|
|
1388
|
+
* @param {string} name - Provider name.
|
|
1389
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1390
|
+
* @param {string} username - Textmagic username.
|
|
1391
|
+
* @param {string} apiKey - Textmagic apiKey.
|
|
1392
|
+
* @param {boolean} enabled - Set as enabled.
|
|
403
1393
|
* @throws {AppwriteException}
|
|
404
1394
|
* @returns {Promise<Models.Provider>}
|
|
1395
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
405
1396
|
*/
|
|
406
1397
|
createTextmagicProvider(providerId: string, name: string, from?: string, username?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
407
1398
|
/**
|
|
408
1399
|
* Update a Textmagic provider by its unique ID.
|
|
409
1400
|
*
|
|
410
|
-
* @param {string} providerId
|
|
411
|
-
* @param {string} name
|
|
412
|
-
* @param {boolean} enabled
|
|
413
|
-
* @param {string} username
|
|
414
|
-
* @param {string} apiKey
|
|
415
|
-
* @param {string} from
|
|
1401
|
+
* @param {string} params.providerId - Provider ID.
|
|
1402
|
+
* @param {string} params.name - Provider name.
|
|
1403
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1404
|
+
* @param {string} params.username - Textmagic username.
|
|
1405
|
+
* @param {string} params.apiKey - Textmagic apiKey.
|
|
1406
|
+
* @param {string} params.from - Sender number.
|
|
1407
|
+
* @throws {AppwriteException}
|
|
1408
|
+
* @returns {Promise<Models.Provider>}
|
|
1409
|
+
*/
|
|
1410
|
+
updateTextmagicProvider(params: {
|
|
1411
|
+
providerId: string;
|
|
1412
|
+
name?: string;
|
|
1413
|
+
enabled?: boolean;
|
|
1414
|
+
username?: string;
|
|
1415
|
+
apiKey?: string;
|
|
1416
|
+
from?: string;
|
|
1417
|
+
}): Promise<Models.Provider>;
|
|
1418
|
+
/**
|
|
1419
|
+
* Update a Textmagic provider by its unique ID.
|
|
1420
|
+
*
|
|
1421
|
+
* @param {string} providerId - Provider ID.
|
|
1422
|
+
* @param {string} name - Provider name.
|
|
1423
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1424
|
+
* @param {string} username - Textmagic username.
|
|
1425
|
+
* @param {string} apiKey - Textmagic apiKey.
|
|
1426
|
+
* @param {string} from - Sender number.
|
|
416
1427
|
* @throws {AppwriteException}
|
|
417
1428
|
* @returns {Promise<Models.Provider>}
|
|
1429
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
418
1430
|
*/
|
|
419
1431
|
updateTextmagicProvider(providerId: string, name?: string, enabled?: boolean, username?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
|
|
420
1432
|
/**
|
|
421
1433
|
* Create a new Twilio provider.
|
|
422
1434
|
*
|
|
423
|
-
* @param {string} providerId
|
|
424
|
-
* @param {string} name
|
|
425
|
-
* @param {string} from
|
|
426
|
-
* @param {string} accountSid
|
|
427
|
-
* @param {string} authToken
|
|
428
|
-
* @param {boolean} enabled
|
|
1435
|
+
* @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.
|
|
1436
|
+
* @param {string} params.name - Provider name.
|
|
1437
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1438
|
+
* @param {string} params.accountSid - Twilio account secret ID.
|
|
1439
|
+
* @param {string} params.authToken - Twilio authentication token.
|
|
1440
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
429
1441
|
* @throws {AppwriteException}
|
|
430
1442
|
* @returns {Promise<Models.Provider>}
|
|
431
1443
|
*/
|
|
1444
|
+
createTwilioProvider(params: {
|
|
1445
|
+
providerId: string;
|
|
1446
|
+
name: string;
|
|
1447
|
+
from?: string;
|
|
1448
|
+
accountSid?: string;
|
|
1449
|
+
authToken?: string;
|
|
1450
|
+
enabled?: boolean;
|
|
1451
|
+
}): Promise<Models.Provider>;
|
|
1452
|
+
/**
|
|
1453
|
+
* Create a new Twilio provider.
|
|
1454
|
+
*
|
|
1455
|
+
* @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.
|
|
1456
|
+
* @param {string} name - Provider name.
|
|
1457
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1458
|
+
* @param {string} accountSid - Twilio account secret ID.
|
|
1459
|
+
* @param {string} authToken - Twilio authentication token.
|
|
1460
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1461
|
+
* @throws {AppwriteException}
|
|
1462
|
+
* @returns {Promise<Models.Provider>}
|
|
1463
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1464
|
+
*/
|
|
432
1465
|
createTwilioProvider(providerId: string, name: string, from?: string, accountSid?: string, authToken?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
433
1466
|
/**
|
|
434
1467
|
* Update a Twilio provider by its unique ID.
|
|
435
1468
|
*
|
|
436
|
-
* @param {string} providerId
|
|
437
|
-
* @param {string} name
|
|
438
|
-
* @param {boolean} enabled
|
|
439
|
-
* @param {string} accountSid
|
|
440
|
-
* @param {string} authToken
|
|
441
|
-
* @param {string} from
|
|
1469
|
+
* @param {string} params.providerId - Provider ID.
|
|
1470
|
+
* @param {string} params.name - Provider name.
|
|
1471
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1472
|
+
* @param {string} params.accountSid - Twilio account secret ID.
|
|
1473
|
+
* @param {string} params.authToken - Twilio authentication token.
|
|
1474
|
+
* @param {string} params.from - Sender number.
|
|
442
1475
|
* @throws {AppwriteException}
|
|
443
1476
|
* @returns {Promise<Models.Provider>}
|
|
444
1477
|
*/
|
|
1478
|
+
updateTwilioProvider(params: {
|
|
1479
|
+
providerId: string;
|
|
1480
|
+
name?: string;
|
|
1481
|
+
enabled?: boolean;
|
|
1482
|
+
accountSid?: string;
|
|
1483
|
+
authToken?: string;
|
|
1484
|
+
from?: string;
|
|
1485
|
+
}): Promise<Models.Provider>;
|
|
1486
|
+
/**
|
|
1487
|
+
* Update a Twilio provider by its unique ID.
|
|
1488
|
+
*
|
|
1489
|
+
* @param {string} providerId - Provider ID.
|
|
1490
|
+
* @param {string} name - Provider name.
|
|
1491
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1492
|
+
* @param {string} accountSid - Twilio account secret ID.
|
|
1493
|
+
* @param {string} authToken - Twilio authentication token.
|
|
1494
|
+
* @param {string} from - Sender number.
|
|
1495
|
+
* @throws {AppwriteException}
|
|
1496
|
+
* @returns {Promise<Models.Provider>}
|
|
1497
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1498
|
+
*/
|
|
445
1499
|
updateTwilioProvider(providerId: string, name?: string, enabled?: boolean, accountSid?: string, authToken?: string, from?: string): Promise<Models.Provider>;
|
|
446
1500
|
/**
|
|
447
1501
|
* Create a new Vonage provider.
|
|
448
1502
|
*
|
|
449
|
-
* @param {string} providerId
|
|
450
|
-
* @param {string} name
|
|
451
|
-
* @param {string} from
|
|
452
|
-
* @param {string} apiKey
|
|
453
|
-
* @param {string} apiSecret
|
|
454
|
-
* @param {boolean} enabled
|
|
1503
|
+
* @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.
|
|
1504
|
+
* @param {string} params.name - Provider name.
|
|
1505
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1506
|
+
* @param {string} params.apiKey - Vonage API key.
|
|
1507
|
+
* @param {string} params.apiSecret - Vonage API secret.
|
|
1508
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1509
|
+
* @throws {AppwriteException}
|
|
1510
|
+
* @returns {Promise<Models.Provider>}
|
|
1511
|
+
*/
|
|
1512
|
+
createVonageProvider(params: {
|
|
1513
|
+
providerId: string;
|
|
1514
|
+
name: string;
|
|
1515
|
+
from?: string;
|
|
1516
|
+
apiKey?: string;
|
|
1517
|
+
apiSecret?: string;
|
|
1518
|
+
enabled?: boolean;
|
|
1519
|
+
}): Promise<Models.Provider>;
|
|
1520
|
+
/**
|
|
1521
|
+
* Create a new Vonage provider.
|
|
1522
|
+
*
|
|
1523
|
+
* @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.
|
|
1524
|
+
* @param {string} name - Provider name.
|
|
1525
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1526
|
+
* @param {string} apiKey - Vonage API key.
|
|
1527
|
+
* @param {string} apiSecret - Vonage API secret.
|
|
1528
|
+
* @param {boolean} enabled - Set as enabled.
|
|
455
1529
|
* @throws {AppwriteException}
|
|
456
1530
|
* @returns {Promise<Models.Provider>}
|
|
1531
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
457
1532
|
*/
|
|
458
1533
|
createVonageProvider(providerId: string, name: string, from?: string, apiKey?: string, apiSecret?: string, enabled?: boolean): Promise<Models.Provider>;
|
|
459
1534
|
/**
|
|
460
1535
|
* Update a Vonage provider by its unique ID.
|
|
461
1536
|
*
|
|
462
|
-
* @param {string} providerId
|
|
463
|
-
* @param {string} name
|
|
464
|
-
* @param {boolean} enabled
|
|
465
|
-
* @param {string} apiKey
|
|
466
|
-
* @param {string} apiSecret
|
|
467
|
-
* @param {string} from
|
|
1537
|
+
* @param {string} params.providerId - Provider ID.
|
|
1538
|
+
* @param {string} params.name - Provider name.
|
|
1539
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
1540
|
+
* @param {string} params.apiKey - Vonage API key.
|
|
1541
|
+
* @param {string} params.apiSecret - Vonage API secret.
|
|
1542
|
+
* @param {string} params.from - Sender number.
|
|
468
1543
|
* @throws {AppwriteException}
|
|
469
1544
|
* @returns {Promise<Models.Provider>}
|
|
470
1545
|
*/
|
|
1546
|
+
updateVonageProvider(params: {
|
|
1547
|
+
providerId: string;
|
|
1548
|
+
name?: string;
|
|
1549
|
+
enabled?: boolean;
|
|
1550
|
+
apiKey?: string;
|
|
1551
|
+
apiSecret?: string;
|
|
1552
|
+
from?: string;
|
|
1553
|
+
}): Promise<Models.Provider>;
|
|
1554
|
+
/**
|
|
1555
|
+
* Update a Vonage provider by its unique ID.
|
|
1556
|
+
*
|
|
1557
|
+
* @param {string} providerId - Provider ID.
|
|
1558
|
+
* @param {string} name - Provider name.
|
|
1559
|
+
* @param {boolean} enabled - Set as enabled.
|
|
1560
|
+
* @param {string} apiKey - Vonage API key.
|
|
1561
|
+
* @param {string} apiSecret - Vonage API secret.
|
|
1562
|
+
* @param {string} from - Sender number.
|
|
1563
|
+
* @throws {AppwriteException}
|
|
1564
|
+
* @returns {Promise<Models.Provider>}
|
|
1565
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1566
|
+
*/
|
|
471
1567
|
updateVonageProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, apiSecret?: string, from?: string): Promise<Models.Provider>;
|
|
472
1568
|
/**
|
|
473
1569
|
* Get a provider by its unique ID.
|
|
474
|
-
|
|
475
1570
|
*
|
|
476
|
-
*
|
|
1571
|
+
*
|
|
1572
|
+
* @param {string} params.providerId - Provider ID.
|
|
477
1573
|
* @throws {AppwriteException}
|
|
478
1574
|
* @returns {Promise<Models.Provider>}
|
|
479
1575
|
*/
|
|
1576
|
+
getProvider(params: {
|
|
1577
|
+
providerId: string;
|
|
1578
|
+
}): Promise<Models.Provider>;
|
|
1579
|
+
/**
|
|
1580
|
+
* Get a provider by its unique ID.
|
|
1581
|
+
*
|
|
1582
|
+
*
|
|
1583
|
+
* @param {string} providerId - Provider ID.
|
|
1584
|
+
* @throws {AppwriteException}
|
|
1585
|
+
* @returns {Promise<Models.Provider>}
|
|
1586
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1587
|
+
*/
|
|
480
1588
|
getProvider(providerId: string): Promise<Models.Provider>;
|
|
481
1589
|
/**
|
|
482
1590
|
* Delete a provider by its unique ID.
|
|
483
1591
|
*
|
|
484
|
-
* @param {string} providerId
|
|
1592
|
+
* @param {string} params.providerId - Provider ID.
|
|
485
1593
|
* @throws {AppwriteException}
|
|
486
1594
|
* @returns {Promise<{}>}
|
|
487
1595
|
*/
|
|
1596
|
+
deleteProvider(params: {
|
|
1597
|
+
providerId: string;
|
|
1598
|
+
}): Promise<{}>;
|
|
1599
|
+
/**
|
|
1600
|
+
* Delete a provider by its unique ID.
|
|
1601
|
+
*
|
|
1602
|
+
* @param {string} providerId - Provider ID.
|
|
1603
|
+
* @throws {AppwriteException}
|
|
1604
|
+
* @returns {Promise<{}>}
|
|
1605
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1606
|
+
*/
|
|
488
1607
|
deleteProvider(providerId: string): Promise<{}>;
|
|
489
1608
|
/**
|
|
490
1609
|
* Get the provider activity logs listed by its unique ID.
|
|
491
1610
|
*
|
|
492
|
-
* @param {string} providerId
|
|
493
|
-
* @param {string[]} queries
|
|
1611
|
+
* @param {string} params.providerId - Provider ID.
|
|
1612
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1613
|
+
* @throws {AppwriteException}
|
|
1614
|
+
* @returns {Promise<Models.LogList>}
|
|
1615
|
+
*/
|
|
1616
|
+
listProviderLogs(params: {
|
|
1617
|
+
providerId: string;
|
|
1618
|
+
queries?: string[];
|
|
1619
|
+
}): Promise<Models.LogList>;
|
|
1620
|
+
/**
|
|
1621
|
+
* Get the provider activity logs listed by its unique ID.
|
|
1622
|
+
*
|
|
1623
|
+
* @param {string} providerId - Provider ID.
|
|
1624
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
494
1625
|
* @throws {AppwriteException}
|
|
495
1626
|
* @returns {Promise<Models.LogList>}
|
|
1627
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
496
1628
|
*/
|
|
497
1629
|
listProviderLogs(providerId: string, queries?: string[]): Promise<Models.LogList>;
|
|
498
1630
|
/**
|
|
499
1631
|
* Get the subscriber activity logs listed by its unique ID.
|
|
500
1632
|
*
|
|
501
|
-
* @param {string} subscriberId
|
|
502
|
-
* @param {string[]} queries
|
|
1633
|
+
* @param {string} params.subscriberId - Subscriber ID.
|
|
1634
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1635
|
+
* @throws {AppwriteException}
|
|
1636
|
+
* @returns {Promise<Models.LogList>}
|
|
1637
|
+
*/
|
|
1638
|
+
listSubscriberLogs(params: {
|
|
1639
|
+
subscriberId: string;
|
|
1640
|
+
queries?: string[];
|
|
1641
|
+
}): Promise<Models.LogList>;
|
|
1642
|
+
/**
|
|
1643
|
+
* Get the subscriber activity logs listed by its unique ID.
|
|
1644
|
+
*
|
|
1645
|
+
* @param {string} subscriberId - Subscriber ID.
|
|
1646
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
503
1647
|
* @throws {AppwriteException}
|
|
504
1648
|
* @returns {Promise<Models.LogList>}
|
|
1649
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
505
1650
|
*/
|
|
506
1651
|
listSubscriberLogs(subscriberId: string, queries?: string[]): Promise<Models.LogList>;
|
|
507
1652
|
/**
|
|
508
1653
|
* Get a list of all topics from the current Appwrite project.
|
|
509
1654
|
*
|
|
510
|
-
* @param {string[]} queries
|
|
511
|
-
* @param {string} search
|
|
1655
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, description, emailTotal, smsTotal, pushTotal
|
|
1656
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
512
1657
|
* @throws {AppwriteException}
|
|
513
1658
|
* @returns {Promise<Models.TopicList>}
|
|
514
1659
|
*/
|
|
1660
|
+
listTopics(params?: {
|
|
1661
|
+
queries?: string[];
|
|
1662
|
+
search?: string;
|
|
1663
|
+
}): Promise<Models.TopicList>;
|
|
1664
|
+
/**
|
|
1665
|
+
* Get a list of all topics from the current Appwrite project.
|
|
1666
|
+
*
|
|
1667
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, description, emailTotal, smsTotal, pushTotal
|
|
1668
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
1669
|
+
* @throws {AppwriteException}
|
|
1670
|
+
* @returns {Promise<Models.TopicList>}
|
|
1671
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1672
|
+
*/
|
|
515
1673
|
listTopics(queries?: string[], search?: string): Promise<Models.TopicList>;
|
|
516
1674
|
/**
|
|
517
1675
|
* Create a new topic.
|
|
518
1676
|
*
|
|
519
|
-
* @param {string} topicId
|
|
520
|
-
* @param {string} name
|
|
521
|
-
* @param {string[]} subscribe
|
|
1677
|
+
* @param {string} params.topicId - Topic ID. Choose a custom Topic ID or a new Topic ID.
|
|
1678
|
+
* @param {string} params.name - Topic Name.
|
|
1679
|
+
* @param {string[]} params.subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
522
1680
|
* @throws {AppwriteException}
|
|
523
1681
|
* @returns {Promise<Models.Topic>}
|
|
524
1682
|
*/
|
|
1683
|
+
createTopic(params: {
|
|
1684
|
+
topicId: string;
|
|
1685
|
+
name: string;
|
|
1686
|
+
subscribe?: string[];
|
|
1687
|
+
}): Promise<Models.Topic>;
|
|
1688
|
+
/**
|
|
1689
|
+
* Create a new topic.
|
|
1690
|
+
*
|
|
1691
|
+
* @param {string} topicId - Topic ID. Choose a custom Topic ID or a new Topic ID.
|
|
1692
|
+
* @param {string} name - Topic Name.
|
|
1693
|
+
* @param {string[]} subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
1694
|
+
* @throws {AppwriteException}
|
|
1695
|
+
* @returns {Promise<Models.Topic>}
|
|
1696
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1697
|
+
*/
|
|
525
1698
|
createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
|
|
526
1699
|
/**
|
|
527
1700
|
* Get a topic by its unique ID.
|
|
528
|
-
|
|
529
1701
|
*
|
|
530
|
-
*
|
|
1702
|
+
*
|
|
1703
|
+
* @param {string} params.topicId - Topic ID.
|
|
531
1704
|
* @throws {AppwriteException}
|
|
532
1705
|
* @returns {Promise<Models.Topic>}
|
|
533
1706
|
*/
|
|
1707
|
+
getTopic(params: {
|
|
1708
|
+
topicId: string;
|
|
1709
|
+
}): Promise<Models.Topic>;
|
|
1710
|
+
/**
|
|
1711
|
+
* Get a topic by its unique ID.
|
|
1712
|
+
*
|
|
1713
|
+
*
|
|
1714
|
+
* @param {string} topicId - Topic ID.
|
|
1715
|
+
* @throws {AppwriteException}
|
|
1716
|
+
* @returns {Promise<Models.Topic>}
|
|
1717
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1718
|
+
*/
|
|
534
1719
|
getTopic(topicId: string): Promise<Models.Topic>;
|
|
535
1720
|
/**
|
|
536
1721
|
* Update a topic by its unique ID.
|
|
537
|
-
|
|
538
1722
|
*
|
|
539
|
-
*
|
|
540
|
-
* @param {string}
|
|
541
|
-
* @param {string
|
|
1723
|
+
*
|
|
1724
|
+
* @param {string} params.topicId - Topic ID.
|
|
1725
|
+
* @param {string} params.name - Topic Name.
|
|
1726
|
+
* @param {string[]} params.subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
542
1727
|
* @throws {AppwriteException}
|
|
543
1728
|
* @returns {Promise<Models.Topic>}
|
|
544
1729
|
*/
|
|
1730
|
+
updateTopic(params: {
|
|
1731
|
+
topicId: string;
|
|
1732
|
+
name?: string;
|
|
1733
|
+
subscribe?: string[];
|
|
1734
|
+
}): Promise<Models.Topic>;
|
|
1735
|
+
/**
|
|
1736
|
+
* Update a topic by its unique ID.
|
|
1737
|
+
*
|
|
1738
|
+
*
|
|
1739
|
+
* @param {string} topicId - Topic ID.
|
|
1740
|
+
* @param {string} name - Topic Name.
|
|
1741
|
+
* @param {string[]} subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
1742
|
+
* @throws {AppwriteException}
|
|
1743
|
+
* @returns {Promise<Models.Topic>}
|
|
1744
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1745
|
+
*/
|
|
545
1746
|
updateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic>;
|
|
546
1747
|
/**
|
|
547
1748
|
* Delete a topic by its unique ID.
|
|
548
1749
|
*
|
|
549
|
-
* @param {string} topicId
|
|
1750
|
+
* @param {string} params.topicId - Topic ID.
|
|
550
1751
|
* @throws {AppwriteException}
|
|
551
1752
|
* @returns {Promise<{}>}
|
|
552
1753
|
*/
|
|
1754
|
+
deleteTopic(params: {
|
|
1755
|
+
topicId: string;
|
|
1756
|
+
}): Promise<{}>;
|
|
1757
|
+
/**
|
|
1758
|
+
* Delete a topic by its unique ID.
|
|
1759
|
+
*
|
|
1760
|
+
* @param {string} topicId - Topic ID.
|
|
1761
|
+
* @throws {AppwriteException}
|
|
1762
|
+
* @returns {Promise<{}>}
|
|
1763
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1764
|
+
*/
|
|
553
1765
|
deleteTopic(topicId: string): Promise<{}>;
|
|
554
1766
|
/**
|
|
555
1767
|
* Get the topic activity logs listed by its unique ID.
|
|
556
1768
|
*
|
|
557
|
-
* @param {string} topicId
|
|
558
|
-
* @param {string[]} queries
|
|
1769
|
+
* @param {string} params.topicId - Topic ID.
|
|
1770
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1771
|
+
* @throws {AppwriteException}
|
|
1772
|
+
* @returns {Promise<Models.LogList>}
|
|
1773
|
+
*/
|
|
1774
|
+
listTopicLogs(params: {
|
|
1775
|
+
topicId: string;
|
|
1776
|
+
queries?: string[];
|
|
1777
|
+
}): Promise<Models.LogList>;
|
|
1778
|
+
/**
|
|
1779
|
+
* Get the topic activity logs listed by its unique ID.
|
|
1780
|
+
*
|
|
1781
|
+
* @param {string} topicId - Topic ID.
|
|
1782
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
559
1783
|
* @throws {AppwriteException}
|
|
560
1784
|
* @returns {Promise<Models.LogList>}
|
|
1785
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
561
1786
|
*/
|
|
562
1787
|
listTopicLogs(topicId: string, queries?: string[]): Promise<Models.LogList>;
|
|
563
1788
|
/**
|
|
564
1789
|
* Get a list of all subscribers from the current Appwrite project.
|
|
565
1790
|
*
|
|
566
|
-
* @param {string} topicId
|
|
567
|
-
* @param {string[]} queries
|
|
568
|
-
* @param {string} search
|
|
1791
|
+
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1792
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled
|
|
1793
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
569
1794
|
* @throws {AppwriteException}
|
|
570
1795
|
* @returns {Promise<Models.SubscriberList>}
|
|
571
1796
|
*/
|
|
1797
|
+
listSubscribers(params: {
|
|
1798
|
+
topicId: string;
|
|
1799
|
+
queries?: string[];
|
|
1800
|
+
search?: string;
|
|
1801
|
+
}): Promise<Models.SubscriberList>;
|
|
1802
|
+
/**
|
|
1803
|
+
* Get a list of all subscribers from the current Appwrite project.
|
|
1804
|
+
*
|
|
1805
|
+
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1806
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled
|
|
1807
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
1808
|
+
* @throws {AppwriteException}
|
|
1809
|
+
* @returns {Promise<Models.SubscriberList>}
|
|
1810
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1811
|
+
*/
|
|
572
1812
|
listSubscribers(topicId: string, queries?: string[], search?: string): Promise<Models.SubscriberList>;
|
|
573
1813
|
/**
|
|
574
1814
|
* Create a new subscriber.
|
|
575
1815
|
*
|
|
576
|
-
* @param {string} topicId
|
|
577
|
-
* @param {string} subscriberId
|
|
578
|
-
* @param {string} targetId
|
|
1816
|
+
* @param {string} params.topicId - Topic ID. The topic ID to subscribe to.
|
|
1817
|
+
* @param {string} params.subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
|
|
1818
|
+
* @param {string} params.targetId - Target ID. The target ID to link to the specified Topic ID.
|
|
1819
|
+
* @throws {AppwriteException}
|
|
1820
|
+
* @returns {Promise<Models.Subscriber>}
|
|
1821
|
+
*/
|
|
1822
|
+
createSubscriber(params: {
|
|
1823
|
+
topicId: string;
|
|
1824
|
+
subscriberId: string;
|
|
1825
|
+
targetId: string;
|
|
1826
|
+
}): Promise<Models.Subscriber>;
|
|
1827
|
+
/**
|
|
1828
|
+
* Create a new subscriber.
|
|
1829
|
+
*
|
|
1830
|
+
* @param {string} topicId - Topic ID. The topic ID to subscribe to.
|
|
1831
|
+
* @param {string} subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
|
|
1832
|
+
* @param {string} targetId - Target ID. The target ID to link to the specified Topic ID.
|
|
579
1833
|
* @throws {AppwriteException}
|
|
580
1834
|
* @returns {Promise<Models.Subscriber>}
|
|
1835
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
581
1836
|
*/
|
|
582
1837
|
createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
|
|
583
1838
|
/**
|
|
584
1839
|
* Get a subscriber by its unique ID.
|
|
585
|
-
|
|
586
1840
|
*
|
|
587
|
-
*
|
|
588
|
-
* @param {string}
|
|
1841
|
+
*
|
|
1842
|
+
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1843
|
+
* @param {string} params.subscriberId - Subscriber ID.
|
|
1844
|
+
* @throws {AppwriteException}
|
|
1845
|
+
* @returns {Promise<Models.Subscriber>}
|
|
1846
|
+
*/
|
|
1847
|
+
getSubscriber(params: {
|
|
1848
|
+
topicId: string;
|
|
1849
|
+
subscriberId: string;
|
|
1850
|
+
}): Promise<Models.Subscriber>;
|
|
1851
|
+
/**
|
|
1852
|
+
* Get a subscriber by its unique ID.
|
|
1853
|
+
*
|
|
1854
|
+
*
|
|
1855
|
+
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1856
|
+
* @param {string} subscriberId - Subscriber ID.
|
|
589
1857
|
* @throws {AppwriteException}
|
|
590
1858
|
* @returns {Promise<Models.Subscriber>}
|
|
1859
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
591
1860
|
*/
|
|
592
1861
|
getSubscriber(topicId: string, subscriberId: string): Promise<Models.Subscriber>;
|
|
593
1862
|
/**
|
|
594
1863
|
* Delete a subscriber by its unique ID.
|
|
595
1864
|
*
|
|
596
|
-
* @param {string} topicId
|
|
597
|
-
* @param {string} subscriberId
|
|
1865
|
+
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1866
|
+
* @param {string} params.subscriberId - Subscriber ID.
|
|
1867
|
+
* @throws {AppwriteException}
|
|
1868
|
+
* @returns {Promise<{}>}
|
|
1869
|
+
*/
|
|
1870
|
+
deleteSubscriber(params: {
|
|
1871
|
+
topicId: string;
|
|
1872
|
+
subscriberId: string;
|
|
1873
|
+
}): Promise<{}>;
|
|
1874
|
+
/**
|
|
1875
|
+
* Delete a subscriber by its unique ID.
|
|
1876
|
+
*
|
|
1877
|
+
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1878
|
+
* @param {string} subscriberId - Subscriber ID.
|
|
598
1879
|
* @throws {AppwriteException}
|
|
599
1880
|
* @returns {Promise<{}>}
|
|
1881
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
600
1882
|
*/
|
|
601
1883
|
deleteSubscriber(topicId: string, subscriberId: string): Promise<{}>;
|
|
602
1884
|
}
|