@revenexx/sdk 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +148 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/sdk.js +16340 -0
- package/dist/cjs/sdk.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/sdk.js +16250 -0
- package/dist/esm/sdk.js.map +1 -0
- package/dist/iife/sdk.js +20101 -0
- package/package.json +56 -0
- package/src/channel.ts +158 -0
- package/src/client.ts +950 -0
- package/src/enums/adapter.ts +4 -0
- package/src/enums/attribute-boolean-status.ts +7 -0
- package/src/enums/attribute-datetime-status.ts +7 -0
- package/src/enums/attribute-email-status.ts +7 -0
- package/src/enums/attribute-enum-status.ts +7 -0
- package/src/enums/attribute-float-status.ts +7 -0
- package/src/enums/attribute-integer-status.ts +7 -0
- package/src/enums/attribute-ip-status.ts +7 -0
- package/src/enums/attribute-line-status.ts +7 -0
- package/src/enums/attribute-longtext-status.ts +7 -0
- package/src/enums/attribute-mediumtext-status.ts +7 -0
- package/src/enums/attribute-point-status.ts +7 -0
- package/src/enums/attribute-polygon-status.ts +7 -0
- package/src/enums/attribute-relationship-status.ts +7 -0
- package/src/enums/attribute-string-status.ts +7 -0
- package/src/enums/attribute-text-status.ts +7 -0
- package/src/enums/attribute-url-status.ts +7 -0
- package/src/enums/attribute-varchar-status.ts +7 -0
- package/src/enums/build-runtime.ts +73 -0
- package/src/enums/code.ts +16 -0
- package/src/enums/collection.ts +4 -0
- package/src/enums/column-boolean-status.ts +7 -0
- package/src/enums/column-datetime-status.ts +7 -0
- package/src/enums/column-email-status.ts +7 -0
- package/src/enums/column-enum-status.ts +7 -0
- package/src/enums/column-float-status.ts +7 -0
- package/src/enums/column-integer-status.ts +7 -0
- package/src/enums/column-ip-status.ts +7 -0
- package/src/enums/column-line-status.ts +7 -0
- package/src/enums/column-longtext-status.ts +7 -0
- package/src/enums/column-mediumtext-status.ts +7 -0
- package/src/enums/column-point-status.ts +7 -0
- package/src/enums/column-polygon-status.ts +7 -0
- package/src/enums/column-relationship-status.ts +7 -0
- package/src/enums/column-string-status.ts +7 -0
- package/src/enums/column-text-status.ts +7 -0
- package/src/enums/column-url-status.ts +7 -0
- package/src/enums/column-varchar-status.ts +7 -0
- package/src/enums/compression.ts +5 -0
- package/src/enums/database-type.ts +4 -0
- package/src/enums/deployment-status.ts +8 -0
- package/src/enums/execution-status.ts +7 -0
- package/src/enums/execution-trigger.ts +5 -0
- package/src/enums/framework.ts +17 -0
- package/src/enums/gravity.ts +11 -0
- package/src/enums/health-antivirus-status.ts +5 -0
- package/src/enums/health-status-status.ts +4 -0
- package/src/enums/index-status.ts +7 -0
- package/src/enums/message-status.ts +7 -0
- package/src/enums/method.ts +9 -0
- package/src/enums/output.ts +9 -0
- package/src/enums/permissions.ts +22 -0
- package/src/enums/priority.ts +4 -0
- package/src/enums/range.ts +5 -0
- package/src/enums/runtime.ts +73 -0
- package/src/enums/runtimes.ts +73 -0
- package/src/enums/scopes.ts +57 -0
- package/src/enums/theme.ts +4 -0
- package/src/enums/timezone.ts +421 -0
- package/src/enums/type.ts +5 -0
- package/src/enums/use-cases.ts +9 -0
- package/src/id.ts +47 -0
- package/src/index.ts +92 -0
- package/src/models.ts +6013 -0
- package/src/operator.ts +308 -0
- package/src/permission.ts +57 -0
- package/src/query.ts +576 -0
- package/src/role.ts +100 -0
- package/src/service.ts +30 -0
- package/src/services/apps.ts +2473 -0
- package/src/services/avatars.ts +744 -0
- package/src/services/carts.ts +1057 -0
- package/src/services/channels.ts +227 -0
- package/src/services/customers.ts +729 -0
- package/src/services/greetings.ts +294 -0
- package/src/services/locale.ts +198 -0
- package/src/services/markets.ts +796 -0
- package/src/services/messaging.ts +3463 -0
- package/src/services/products.ts +3100 -0
- package/src/services/realtime.ts +537 -0
- package/src/services/search.ts +346 -0
- package/src/services/sites.ts +1847 -0
- package/src/services/storage.ts +1076 -0
- package/src/services/tokens.ts +314 -0
- package/types/channel.d.ts +74 -0
- package/types/client.d.ts +211 -0
- package/types/enums/adapter.d.ts +4 -0
- package/types/enums/attribute-boolean-status.d.ts +7 -0
- package/types/enums/attribute-datetime-status.d.ts +7 -0
- package/types/enums/attribute-email-status.d.ts +7 -0
- package/types/enums/attribute-enum-status.d.ts +7 -0
- package/types/enums/attribute-float-status.d.ts +7 -0
- package/types/enums/attribute-integer-status.d.ts +7 -0
- package/types/enums/attribute-ip-status.d.ts +7 -0
- package/types/enums/attribute-line-status.d.ts +7 -0
- package/types/enums/attribute-longtext-status.d.ts +7 -0
- package/types/enums/attribute-mediumtext-status.d.ts +7 -0
- package/types/enums/attribute-point-status.d.ts +7 -0
- package/types/enums/attribute-polygon-status.d.ts +7 -0
- package/types/enums/attribute-relationship-status.d.ts +7 -0
- package/types/enums/attribute-string-status.d.ts +7 -0
- package/types/enums/attribute-text-status.d.ts +7 -0
- package/types/enums/attribute-url-status.d.ts +7 -0
- package/types/enums/attribute-varchar-status.d.ts +7 -0
- package/types/enums/build-runtime.d.ts +73 -0
- package/types/enums/code.d.ts +16 -0
- package/types/enums/collection.d.ts +4 -0
- package/types/enums/column-boolean-status.d.ts +7 -0
- package/types/enums/column-datetime-status.d.ts +7 -0
- package/types/enums/column-email-status.d.ts +7 -0
- package/types/enums/column-enum-status.d.ts +7 -0
- package/types/enums/column-float-status.d.ts +7 -0
- package/types/enums/column-integer-status.d.ts +7 -0
- package/types/enums/column-ip-status.d.ts +7 -0
- package/types/enums/column-line-status.d.ts +7 -0
- package/types/enums/column-longtext-status.d.ts +7 -0
- package/types/enums/column-mediumtext-status.d.ts +7 -0
- package/types/enums/column-point-status.d.ts +7 -0
- package/types/enums/column-polygon-status.d.ts +7 -0
- package/types/enums/column-relationship-status.d.ts +7 -0
- package/types/enums/column-string-status.d.ts +7 -0
- package/types/enums/column-text-status.d.ts +7 -0
- package/types/enums/column-url-status.d.ts +7 -0
- package/types/enums/column-varchar-status.d.ts +7 -0
- package/types/enums/compression.d.ts +5 -0
- package/types/enums/database-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +8 -0
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/framework.d.ts +17 -0
- package/types/enums/gravity.d.ts +11 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-status-status.d.ts +4 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/method.d.ts +9 -0
- package/types/enums/output.d.ts +9 -0
- package/types/enums/permissions.d.ts +22 -0
- package/types/enums/priority.d.ts +4 -0
- package/types/enums/range.d.ts +5 -0
- package/types/enums/runtime.d.ts +73 -0
- package/types/enums/runtimes.d.ts +73 -0
- package/types/enums/scopes.d.ts +57 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/type.d.ts +5 -0
- package/types/enums/use-cases.d.ts +9 -0
- package/types/id.d.ts +20 -0
- package/types/index.d.ts +92 -0
- package/types/models.d.ts +5830 -0
- package/types/operator.d.ts +180 -0
- package/types/permission.d.ts +43 -0
- package/types/query.d.ts +442 -0
- package/types/role.d.ts +70 -0
- package/types/service.d.ts +11 -0
- package/types/services/apps.d.ts +932 -0
- package/types/services/avatars.d.ts +318 -0
- package/types/services/carts.d.ts +352 -0
- package/types/services/channels.d.ts +75 -0
- package/types/services/customers.d.ts +231 -0
- package/types/services/greetings.d.ts +101 -0
- package/types/services/locale.d.ts +64 -0
- package/types/services/markets.d.ts +274 -0
- package/types/services/messaging.d.ts +1324 -0
- package/types/services/products.d.ts +1014 -0
- package/types/services/realtime.d.ts +134 -0
- package/types/services/search.d.ts +131 -0
- package/types/services/sites.d.ts +689 -0
- package/types/services/storage.d.ts +421 -0
- package/types/services/tokens.d.ts +119 -0
|
@@ -0,0 +1,1324 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
import { Priority } from '../enums/priority';
|
|
4
|
+
export declare class Messaging {
|
|
5
|
+
client: Client;
|
|
6
|
+
constructor(client: Client);
|
|
7
|
+
/**
|
|
8
|
+
* Get a list of all messages from the current Revenexx project.
|
|
9
|
+
*
|
|
10
|
+
* @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
|
|
11
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
12
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
13
|
+
* @throws {RevenexxException}
|
|
14
|
+
* @returns {Promise<Models.MessageList>}
|
|
15
|
+
*/
|
|
16
|
+
messagingListMessages(params?: {
|
|
17
|
+
queries?: string[];
|
|
18
|
+
search?: string;
|
|
19
|
+
total?: boolean;
|
|
20
|
+
}): Promise<Models.MessageList>;
|
|
21
|
+
/**
|
|
22
|
+
* Get a list of all messages from the current Revenexx project.
|
|
23
|
+
*
|
|
24
|
+
* @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
|
|
25
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
26
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
27
|
+
* @throws {RevenexxException}
|
|
28
|
+
* @returns {Promise<Models.MessageList>}
|
|
29
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
30
|
+
*/
|
|
31
|
+
messagingListMessages(queries?: string[], search?: string, total?: boolean): Promise<Models.MessageList>;
|
|
32
|
+
/**
|
|
33
|
+
* Create a new email message.
|
|
34
|
+
*
|
|
35
|
+
* @param {string} params.content - Email Content.
|
|
36
|
+
* @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.
|
|
37
|
+
* @param {string} params.subject - Email Subject.
|
|
38
|
+
* @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>.
|
|
39
|
+
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
40
|
+
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
41
|
+
* @param {boolean} params.draft - Is message a draft
|
|
42
|
+
* @param {boolean} params.html - Is content of type HTML
|
|
43
|
+
* @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.
|
|
44
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
45
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
46
|
+
* @param {string[]} params.users - List of User IDs.
|
|
47
|
+
* @throws {RevenexxException}
|
|
48
|
+
* @returns {Promise<Models.Message>}
|
|
49
|
+
*/
|
|
50
|
+
messagingCreateEmail(params: {
|
|
51
|
+
content: string;
|
|
52
|
+
messageId: string;
|
|
53
|
+
subject: string;
|
|
54
|
+
attachments?: string[];
|
|
55
|
+
bcc?: string[];
|
|
56
|
+
cc?: string[];
|
|
57
|
+
draft?: boolean;
|
|
58
|
+
html?: boolean;
|
|
59
|
+
scheduledAt?: string;
|
|
60
|
+
targets?: string[];
|
|
61
|
+
topics?: string[];
|
|
62
|
+
users?: string[];
|
|
63
|
+
}): Promise<Models.Message>;
|
|
64
|
+
/**
|
|
65
|
+
* Create a new email message.
|
|
66
|
+
*
|
|
67
|
+
* @param {string} content - Email Content.
|
|
68
|
+
* @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.
|
|
69
|
+
* @param {string} subject - Email Subject.
|
|
70
|
+
* @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>.
|
|
71
|
+
* @param {string[]} bcc - Array of target IDs to be added as BCC.
|
|
72
|
+
* @param {string[]} cc - Array of target IDs to be added as CC.
|
|
73
|
+
* @param {boolean} draft - Is message a draft
|
|
74
|
+
* @param {boolean} html - Is content of type HTML
|
|
75
|
+
* @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.
|
|
76
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
77
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
78
|
+
* @param {string[]} users - List of User IDs.
|
|
79
|
+
* @throws {RevenexxException}
|
|
80
|
+
* @returns {Promise<Models.Message>}
|
|
81
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
82
|
+
*/
|
|
83
|
+
messagingCreateEmail(content: string, messageId: string, subject: string, attachments?: string[], bcc?: string[], cc?: string[], draft?: boolean, html?: boolean, scheduledAt?: string, targets?: string[], topics?: string[], users?: string[]): Promise<Models.Message>;
|
|
84
|
+
/**
|
|
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.
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* @param {string} params.messageId - Message ID.
|
|
89
|
+
* @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>.
|
|
90
|
+
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
91
|
+
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
92
|
+
* @param {string} params.content - Email Content.
|
|
93
|
+
* @param {boolean} params.draft - Is message a draft
|
|
94
|
+
* @param {boolean} params.html - Is content of type HTML
|
|
95
|
+
* @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.
|
|
96
|
+
* @param {string} params.subject - Email Subject.
|
|
97
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
98
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
99
|
+
* @param {string[]} params.users - List of User IDs.
|
|
100
|
+
* @throws {RevenexxException}
|
|
101
|
+
* @returns {Promise<Models.Message>}
|
|
102
|
+
*/
|
|
103
|
+
messagingUpdateEmail(params: {
|
|
104
|
+
messageId: string;
|
|
105
|
+
attachments?: string[];
|
|
106
|
+
bcc?: string[];
|
|
107
|
+
cc?: string[];
|
|
108
|
+
content?: string;
|
|
109
|
+
draft?: boolean;
|
|
110
|
+
html?: boolean;
|
|
111
|
+
scheduledAt?: string;
|
|
112
|
+
subject?: string;
|
|
113
|
+
targets?: string[];
|
|
114
|
+
topics?: string[];
|
|
115
|
+
users?: 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[]} 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>.
|
|
123
|
+
* @param {string[]} bcc - Array of target IDs to be added as BCC.
|
|
124
|
+
* @param {string[]} cc - Array of target IDs to be added as CC.
|
|
125
|
+
* @param {string} content - Email Content.
|
|
126
|
+
* @param {boolean} draft - Is message a draft
|
|
127
|
+
* @param {boolean} html - Is content of type HTML
|
|
128
|
+
* @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.
|
|
129
|
+
* @param {string} subject - Email Subject.
|
|
130
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
131
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
132
|
+
* @param {string[]} users - List of User IDs.
|
|
133
|
+
* @throws {RevenexxException}
|
|
134
|
+
* @returns {Promise<Models.Message>}
|
|
135
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
136
|
+
*/
|
|
137
|
+
messagingUpdateEmail(messageId: string, attachments?: string[], bcc?: string[], cc?: string[], content?: string, draft?: boolean, html?: boolean, scheduledAt?: string, subject?: string, targets?: string[], topics?: string[], users?: string[]): Promise<Models.Message>;
|
|
138
|
+
/**
|
|
139
|
+
* Create a new push notification.
|
|
140
|
+
*
|
|
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.action - Action for push notification.
|
|
143
|
+
* @param {number} params.badge - Badge for push notification. Available only for iOS Platform.
|
|
144
|
+
* @param {string} params.body - Body for push notification.
|
|
145
|
+
* @param {string} params.color - Color for push notification. Available only for Android Platform.
|
|
146
|
+
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
147
|
+
* @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.
|
|
148
|
+
* @param {object} params.data - Additional key-value pair data for push notification.
|
|
149
|
+
* @param {boolean} params.draft - Is message a draft
|
|
150
|
+
* @param {string} params.icon - Icon for push notification. Available only for Android and Web Platform.
|
|
151
|
+
* @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>.
|
|
152
|
+
* @param {Priority} 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.
|
|
153
|
+
* @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.
|
|
154
|
+
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
155
|
+
* @param {string} params.tag - Tag for push notification. Available only for Android Platform.
|
|
156
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
157
|
+
* @param {string} params.title - Title for push notification.
|
|
158
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
159
|
+
* @param {string[]} params.users - List of User IDs.
|
|
160
|
+
* @throws {RevenexxException}
|
|
161
|
+
* @returns {Promise<Models.Message>}
|
|
162
|
+
*/
|
|
163
|
+
messagingCreatePush(params: {
|
|
164
|
+
messageId: string;
|
|
165
|
+
action?: string;
|
|
166
|
+
badge?: number;
|
|
167
|
+
body?: string;
|
|
168
|
+
color?: string;
|
|
169
|
+
contentAvailable?: boolean;
|
|
170
|
+
critical?: boolean;
|
|
171
|
+
data?: object;
|
|
172
|
+
draft?: boolean;
|
|
173
|
+
icon?: string;
|
|
174
|
+
image?: string;
|
|
175
|
+
priority?: Priority;
|
|
176
|
+
scheduledAt?: string;
|
|
177
|
+
sound?: string;
|
|
178
|
+
tag?: string;
|
|
179
|
+
targets?: string[];
|
|
180
|
+
title?: string;
|
|
181
|
+
topics?: string[];
|
|
182
|
+
users?: string[];
|
|
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} action - Action for push notification.
|
|
189
|
+
* @param {number} badge - Badge for push notification. Available only for iOS Platform.
|
|
190
|
+
* @param {string} body - Body for push notification.
|
|
191
|
+
* @param {string} color - Color for push notification. Available only for Android Platform.
|
|
192
|
+
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
193
|
+
* @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.
|
|
194
|
+
* @param {object} data - Additional key-value pair data for push notification.
|
|
195
|
+
* @param {boolean} draft - Is message a draft
|
|
196
|
+
* @param {string} icon - Icon for push notification. Available only for Android and Web Platform.
|
|
197
|
+
* @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>.
|
|
198
|
+
* @param {Priority} 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.
|
|
199
|
+
* @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.
|
|
200
|
+
* @param {string} sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
201
|
+
* @param {string} tag - Tag for push notification. Available only for Android Platform.
|
|
202
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
203
|
+
* @param {string} title - Title for push notification.
|
|
204
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
205
|
+
* @param {string[]} users - List of User IDs.
|
|
206
|
+
* @throws {RevenexxException}
|
|
207
|
+
* @returns {Promise<Models.Message>}
|
|
208
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
209
|
+
*/
|
|
210
|
+
messagingCreatePush(messageId: string, action?: string, badge?: number, body?: string, color?: string, contentAvailable?: boolean, critical?: boolean, data?: object, draft?: boolean, icon?: string, image?: string, priority?: Priority, scheduledAt?: string, sound?: string, tag?: string, targets?: string[], title?: string, topics?: string[], users?: string[]): Promise<Models.Message>;
|
|
211
|
+
/**
|
|
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.
|
|
213
|
+
*
|
|
214
|
+
*
|
|
215
|
+
* @param {string} params.messageId - Message ID.
|
|
216
|
+
* @param {string} params.action - Action for push notification.
|
|
217
|
+
* @param {number} params.badge - Badge for push notification. Available only for iOS platforms.
|
|
218
|
+
* @param {string} params.body - Body for push notification.
|
|
219
|
+
* @param {string} params.color - Color for push notification. Available only for Android platforms.
|
|
220
|
+
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
221
|
+
* @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.
|
|
222
|
+
* @param {object} params.data - Additional Data for push notification.
|
|
223
|
+
* @param {boolean} params.draft - Is message a draft
|
|
224
|
+
* @param {string} params.icon - Icon for push notification. Available only for Android and Web platforms.
|
|
225
|
+
* @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>.
|
|
226
|
+
* @param {Priority} 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.
|
|
227
|
+
* @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.
|
|
228
|
+
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
229
|
+
* @param {string} params.tag - Tag for push notification. Available only for Android platforms.
|
|
230
|
+
* @param {string[]} params.targets - List of Targets IDs.
|
|
231
|
+
* @param {string} params.title - Title for push notification.
|
|
232
|
+
* @param {string[]} params.topics - List of Topic IDs.
|
|
233
|
+
* @param {string[]} params.users - List of User IDs.
|
|
234
|
+
* @throws {RevenexxException}
|
|
235
|
+
* @returns {Promise<Models.Message>}
|
|
236
|
+
*/
|
|
237
|
+
messagingUpdatePush(params: {
|
|
238
|
+
messageId: string;
|
|
239
|
+
action?: string;
|
|
240
|
+
badge?: number;
|
|
241
|
+
body?: string;
|
|
242
|
+
color?: string;
|
|
243
|
+
contentAvailable?: boolean;
|
|
244
|
+
critical?: boolean;
|
|
245
|
+
data?: object;
|
|
246
|
+
draft?: boolean;
|
|
247
|
+
icon?: string;
|
|
248
|
+
image?: string;
|
|
249
|
+
priority?: Priority;
|
|
250
|
+
scheduledAt?: string;
|
|
251
|
+
sound?: string;
|
|
252
|
+
tag?: string;
|
|
253
|
+
targets?: string[];
|
|
254
|
+
title?: string;
|
|
255
|
+
topics?: string[];
|
|
256
|
+
users?: string[];
|
|
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} action - Action for push notification.
|
|
264
|
+
* @param {number} badge - Badge for push notification. Available only for iOS platforms.
|
|
265
|
+
* @param {string} body - Body for push notification.
|
|
266
|
+
* @param {string} color - Color for push notification. Available only for Android platforms.
|
|
267
|
+
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
268
|
+
* @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.
|
|
269
|
+
* @param {object} data - Additional Data for push notification.
|
|
270
|
+
* @param {boolean} draft - Is message a draft
|
|
271
|
+
* @param {string} icon - Icon for push notification. Available only for Android and Web platforms.
|
|
272
|
+
* @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>.
|
|
273
|
+
* @param {Priority} 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.
|
|
274
|
+
* @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.
|
|
275
|
+
* @param {string} sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
276
|
+
* @param {string} tag - Tag for push notification. Available only for Android platforms.
|
|
277
|
+
* @param {string[]} targets - List of Targets IDs.
|
|
278
|
+
* @param {string} title - Title for push notification.
|
|
279
|
+
* @param {string[]} topics - List of Topic IDs.
|
|
280
|
+
* @param {string[]} users - List of User IDs.
|
|
281
|
+
* @throws {RevenexxException}
|
|
282
|
+
* @returns {Promise<Models.Message>}
|
|
283
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
284
|
+
*/
|
|
285
|
+
messagingUpdatePush(messageId: string, action?: string, badge?: number, body?: string, color?: string, contentAvailable?: boolean, critical?: boolean, data?: object, draft?: boolean, icon?: string, image?: string, priority?: Priority, scheduledAt?: string, sound?: string, tag?: string, targets?: string[], title?: string, topics?: string[], users?: string[]): Promise<Models.Message>;
|
|
286
|
+
/**
|
|
287
|
+
* Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.
|
|
288
|
+
*
|
|
289
|
+
* @param {string} params.messageId - Message ID.
|
|
290
|
+
* @throws {RevenexxException}
|
|
291
|
+
* @returns {Promise<{}>}
|
|
292
|
+
*/
|
|
293
|
+
messagingDelete(params: {
|
|
294
|
+
messageId: string;
|
|
295
|
+
}): Promise<{}>;
|
|
296
|
+
/**
|
|
297
|
+
* Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.
|
|
298
|
+
*
|
|
299
|
+
* @param {string} messageId - Message ID.
|
|
300
|
+
* @throws {RevenexxException}
|
|
301
|
+
* @returns {Promise<{}>}
|
|
302
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
303
|
+
*/
|
|
304
|
+
messagingDelete(messageId: string): Promise<{}>;
|
|
305
|
+
/**
|
|
306
|
+
* Get a message by its unique ID.
|
|
307
|
+
*
|
|
308
|
+
*
|
|
309
|
+
* @param {string} params.messageId - Message ID.
|
|
310
|
+
* @throws {RevenexxException}
|
|
311
|
+
* @returns {Promise<Models.Message>}
|
|
312
|
+
*/
|
|
313
|
+
messagingGetMessage(params: {
|
|
314
|
+
messageId: string;
|
|
315
|
+
}): Promise<Models.Message>;
|
|
316
|
+
/**
|
|
317
|
+
* Get a message by its unique ID.
|
|
318
|
+
*
|
|
319
|
+
*
|
|
320
|
+
* @param {string} messageId - Message ID.
|
|
321
|
+
* @throws {RevenexxException}
|
|
322
|
+
* @returns {Promise<Models.Message>}
|
|
323
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
324
|
+
*/
|
|
325
|
+
messagingGetMessage(messageId: string): Promise<Models.Message>;
|
|
326
|
+
/**
|
|
327
|
+
* Get the message activity logs listed by its unique ID.
|
|
328
|
+
*
|
|
329
|
+
* @param {string} params.messageId - Message ID.
|
|
330
|
+
* @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
|
|
331
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
332
|
+
* @throws {RevenexxException}
|
|
333
|
+
* @returns {Promise<Models.LogList>}
|
|
334
|
+
*/
|
|
335
|
+
messagingListMessageLogs(params: {
|
|
336
|
+
messageId: string;
|
|
337
|
+
queries?: string[];
|
|
338
|
+
total?: boolean;
|
|
339
|
+
}): Promise<Models.LogList>;
|
|
340
|
+
/**
|
|
341
|
+
* Get the message activity logs listed by its unique ID.
|
|
342
|
+
*
|
|
343
|
+
* @param {string} messageId - Message ID.
|
|
344
|
+
* @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
|
|
345
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
346
|
+
* @throws {RevenexxException}
|
|
347
|
+
* @returns {Promise<Models.LogList>}
|
|
348
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
349
|
+
*/
|
|
350
|
+
messagingListMessageLogs(messageId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
|
|
351
|
+
/**
|
|
352
|
+
* Get a list of the targets associated with a message.
|
|
353
|
+
*
|
|
354
|
+
* @param {string} params.messageId - Message ID.
|
|
355
|
+
* @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
|
|
356
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
357
|
+
* @throws {RevenexxException}
|
|
358
|
+
* @returns {Promise<Models.TargetList>}
|
|
359
|
+
*/
|
|
360
|
+
messagingListTargets(params: {
|
|
361
|
+
messageId: string;
|
|
362
|
+
queries?: string[];
|
|
363
|
+
total?: boolean;
|
|
364
|
+
}): Promise<Models.TargetList>;
|
|
365
|
+
/**
|
|
366
|
+
* Get a list of the targets associated with a message.
|
|
367
|
+
*
|
|
368
|
+
* @param {string} messageId - Message ID.
|
|
369
|
+
* @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
|
|
370
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
371
|
+
* @throws {RevenexxException}
|
|
372
|
+
* @returns {Promise<Models.TargetList>}
|
|
373
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
374
|
+
*/
|
|
375
|
+
messagingListTargets(messageId: string, queries?: string[], total?: boolean): Promise<Models.TargetList>;
|
|
376
|
+
/**
|
|
377
|
+
* Get a list of all providers from the current Revenexx project.
|
|
378
|
+
*
|
|
379
|
+
* @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
|
|
380
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
381
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
382
|
+
* @throws {RevenexxException}
|
|
383
|
+
* @returns {Promise<Models.ProviderList>}
|
|
384
|
+
*/
|
|
385
|
+
messagingListProviders(params?: {
|
|
386
|
+
queries?: string[];
|
|
387
|
+
search?: string;
|
|
388
|
+
total?: boolean;
|
|
389
|
+
}): Promise<Models.ProviderList>;
|
|
390
|
+
/**
|
|
391
|
+
* Get a list of all providers from the current Revenexx project.
|
|
392
|
+
*
|
|
393
|
+
* @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
|
|
394
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
395
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
396
|
+
* @throws {RevenexxException}
|
|
397
|
+
* @returns {Promise<Models.ProviderList>}
|
|
398
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
399
|
+
*/
|
|
400
|
+
messagingListProviders(queries?: string[], search?: string, total?: boolean): Promise<Models.ProviderList>;
|
|
401
|
+
/**
|
|
402
|
+
* Create a new Mailgun provider.
|
|
403
|
+
*
|
|
404
|
+
* @param {string} params.name - Provider name.
|
|
405
|
+
* @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.
|
|
406
|
+
* @param {string} params.apiKey - Mailgun API Key.
|
|
407
|
+
* @param {string} params.domain - Mailgun Domain.
|
|
408
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
409
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
410
|
+
* @param {string} params.fromName - Sender Name.
|
|
411
|
+
* @param {boolean} params.isEuRegion - Set as EU region.
|
|
412
|
+
* @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.
|
|
413
|
+
* @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.
|
|
414
|
+
* @throws {RevenexxException}
|
|
415
|
+
* @returns {Promise<Models.Provider>}
|
|
416
|
+
*/
|
|
417
|
+
messagingCreateMailgunProvider(params: {
|
|
418
|
+
name: string;
|
|
419
|
+
providerId: string;
|
|
420
|
+
apiKey?: string;
|
|
421
|
+
domain?: string;
|
|
422
|
+
enabled?: boolean;
|
|
423
|
+
fromEmail?: string;
|
|
424
|
+
fromName?: string;
|
|
425
|
+
isEuRegion?: boolean;
|
|
426
|
+
replyToEmail?: string;
|
|
427
|
+
replyToName?: string;
|
|
428
|
+
}): Promise<Models.Provider>;
|
|
429
|
+
/**
|
|
430
|
+
* Create a new Mailgun provider.
|
|
431
|
+
*
|
|
432
|
+
* @param {string} name - Provider name.
|
|
433
|
+
* @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.
|
|
434
|
+
* @param {string} apiKey - Mailgun API Key.
|
|
435
|
+
* @param {string} domain - Mailgun Domain.
|
|
436
|
+
* @param {boolean} enabled - Set as enabled.
|
|
437
|
+
* @param {string} fromEmail - Sender email address.
|
|
438
|
+
* @param {string} fromName - Sender Name.
|
|
439
|
+
* @param {boolean} isEuRegion - Set as EU region.
|
|
440
|
+
* @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.
|
|
441
|
+
* @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.
|
|
442
|
+
* @throws {RevenexxException}
|
|
443
|
+
* @returns {Promise<Models.Provider>}
|
|
444
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
445
|
+
*/
|
|
446
|
+
messagingCreateMailgunProvider(name: string, providerId: string, apiKey?: string, domain?: string, enabled?: boolean, fromEmail?: string, fromName?: string, isEuRegion?: boolean, replyToEmail?: string, replyToName?: string): Promise<Models.Provider>;
|
|
447
|
+
/**
|
|
448
|
+
* Update a Mailgun provider by its unique ID.
|
|
449
|
+
*
|
|
450
|
+
* @param {string} params.providerId - Provider ID.
|
|
451
|
+
* @param {string} params.apiKey - Mailgun API Key.
|
|
452
|
+
* @param {string} params.domain - Mailgun Domain.
|
|
453
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
454
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
455
|
+
* @param {string} params.fromName - Sender Name.
|
|
456
|
+
* @param {boolean} params.isEuRegion - Set as EU region.
|
|
457
|
+
* @param {string} params.name - Provider name.
|
|
458
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
459
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
460
|
+
* @throws {RevenexxException}
|
|
461
|
+
* @returns {Promise<Models.Provider>}
|
|
462
|
+
*/
|
|
463
|
+
messagingUpdateMailgunProvider(params: {
|
|
464
|
+
providerId: string;
|
|
465
|
+
apiKey?: string;
|
|
466
|
+
domain?: string;
|
|
467
|
+
enabled?: boolean;
|
|
468
|
+
fromEmail?: string;
|
|
469
|
+
fromName?: string;
|
|
470
|
+
isEuRegion?: boolean;
|
|
471
|
+
name?: string;
|
|
472
|
+
replyToEmail?: string;
|
|
473
|
+
replyToName?: string;
|
|
474
|
+
}): Promise<Models.Provider>;
|
|
475
|
+
/**
|
|
476
|
+
* Update a Mailgun provider by its unique ID.
|
|
477
|
+
*
|
|
478
|
+
* @param {string} providerId - Provider ID.
|
|
479
|
+
* @param {string} apiKey - Mailgun API Key.
|
|
480
|
+
* @param {string} domain - Mailgun Domain.
|
|
481
|
+
* @param {boolean} enabled - Set as enabled.
|
|
482
|
+
* @param {string} fromEmail - Sender email address.
|
|
483
|
+
* @param {string} fromName - Sender Name.
|
|
484
|
+
* @param {boolean} isEuRegion - Set as EU region.
|
|
485
|
+
* @param {string} name - Provider name.
|
|
486
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
487
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
488
|
+
* @throws {RevenexxException}
|
|
489
|
+
* @returns {Promise<Models.Provider>}
|
|
490
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
491
|
+
*/
|
|
492
|
+
messagingUpdateMailgunProvider(providerId: string, apiKey?: string, domain?: string, enabled?: boolean, fromEmail?: string, fromName?: string, isEuRegion?: boolean, name?: string, replyToEmail?: string, replyToName?: string): Promise<Models.Provider>;
|
|
493
|
+
/**
|
|
494
|
+
* Create a new MSG91 provider.
|
|
495
|
+
*
|
|
496
|
+
* @param {string} params.name - Provider name.
|
|
497
|
+
* @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.
|
|
498
|
+
* @param {string} params.authKey - Msg91 auth key.
|
|
499
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
500
|
+
* @param {string} params.senderId - Msg91 sender ID.
|
|
501
|
+
* @param {string} params.templateId - Msg91 template ID
|
|
502
|
+
* @throws {RevenexxException}
|
|
503
|
+
* @returns {Promise<Models.Provider>}
|
|
504
|
+
*/
|
|
505
|
+
messagingCreateMsg91Provider(params: {
|
|
506
|
+
name: string;
|
|
507
|
+
providerId: string;
|
|
508
|
+
authKey?: string;
|
|
509
|
+
enabled?: boolean;
|
|
510
|
+
senderId?: string;
|
|
511
|
+
templateId?: string;
|
|
512
|
+
}): Promise<Models.Provider>;
|
|
513
|
+
/**
|
|
514
|
+
* Create a new MSG91 provider.
|
|
515
|
+
*
|
|
516
|
+
* @param {string} name - Provider name.
|
|
517
|
+
* @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.
|
|
518
|
+
* @param {string} authKey - Msg91 auth key.
|
|
519
|
+
* @param {boolean} enabled - Set as enabled.
|
|
520
|
+
* @param {string} senderId - Msg91 sender ID.
|
|
521
|
+
* @param {string} templateId - Msg91 template ID
|
|
522
|
+
* @throws {RevenexxException}
|
|
523
|
+
* @returns {Promise<Models.Provider>}
|
|
524
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
525
|
+
*/
|
|
526
|
+
messagingCreateMsg91Provider(name: string, providerId: string, authKey?: string, enabled?: boolean, senderId?: string, templateId?: string): Promise<Models.Provider>;
|
|
527
|
+
/**
|
|
528
|
+
* Update a MSG91 provider by its unique ID.
|
|
529
|
+
*
|
|
530
|
+
* @param {string} params.providerId - Provider ID.
|
|
531
|
+
* @param {string} params.authKey - Msg91 auth key.
|
|
532
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
533
|
+
* @param {string} params.name - Provider name.
|
|
534
|
+
* @param {string} params.senderId - Msg91 sender ID.
|
|
535
|
+
* @param {string} params.templateId - Msg91 template ID.
|
|
536
|
+
* @throws {RevenexxException}
|
|
537
|
+
* @returns {Promise<Models.Provider>}
|
|
538
|
+
*/
|
|
539
|
+
messagingUpdateMsg91Provider(params: {
|
|
540
|
+
providerId: string;
|
|
541
|
+
authKey?: string;
|
|
542
|
+
enabled?: boolean;
|
|
543
|
+
name?: string;
|
|
544
|
+
senderId?: string;
|
|
545
|
+
templateId?: string;
|
|
546
|
+
}): Promise<Models.Provider>;
|
|
547
|
+
/**
|
|
548
|
+
* Update a MSG91 provider by its unique ID.
|
|
549
|
+
*
|
|
550
|
+
* @param {string} providerId - Provider ID.
|
|
551
|
+
* @param {string} authKey - Msg91 auth key.
|
|
552
|
+
* @param {boolean} enabled - Set as enabled.
|
|
553
|
+
* @param {string} name - Provider name.
|
|
554
|
+
* @param {string} senderId - Msg91 sender ID.
|
|
555
|
+
* @param {string} templateId - Msg91 template ID.
|
|
556
|
+
* @throws {RevenexxException}
|
|
557
|
+
* @returns {Promise<Models.Provider>}
|
|
558
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
559
|
+
*/
|
|
560
|
+
messagingUpdateMsg91Provider(providerId: string, authKey?: string, enabled?: boolean, name?: string, senderId?: string, templateId?: string): Promise<Models.Provider>;
|
|
561
|
+
/**
|
|
562
|
+
* Create a new Resend provider.
|
|
563
|
+
*
|
|
564
|
+
* @param {string} params.name - Provider name.
|
|
565
|
+
* @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.
|
|
566
|
+
* @param {string} params.apiKey - Resend API key.
|
|
567
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
568
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
569
|
+
* @param {string} params.fromName - Sender Name.
|
|
570
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
571
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
572
|
+
* @throws {RevenexxException}
|
|
573
|
+
* @returns {Promise<Models.Provider>}
|
|
574
|
+
*/
|
|
575
|
+
messagingCreateResendProvider(params: {
|
|
576
|
+
name: string;
|
|
577
|
+
providerId: string;
|
|
578
|
+
apiKey?: string;
|
|
579
|
+
enabled?: boolean;
|
|
580
|
+
fromEmail?: string;
|
|
581
|
+
fromName?: string;
|
|
582
|
+
replyToEmail?: string;
|
|
583
|
+
replyToName?: string;
|
|
584
|
+
}): Promise<Models.Provider>;
|
|
585
|
+
/**
|
|
586
|
+
* Create a new Resend provider.
|
|
587
|
+
*
|
|
588
|
+
* @param {string} name - Provider name.
|
|
589
|
+
* @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.
|
|
590
|
+
* @param {string} apiKey - Resend API key.
|
|
591
|
+
* @param {boolean} enabled - Set as enabled.
|
|
592
|
+
* @param {string} fromEmail - Sender email address.
|
|
593
|
+
* @param {string} fromName - Sender Name.
|
|
594
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
595
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
596
|
+
* @throws {RevenexxException}
|
|
597
|
+
* @returns {Promise<Models.Provider>}
|
|
598
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
599
|
+
*/
|
|
600
|
+
messagingCreateResendProvider(name: string, providerId: string, apiKey?: string, enabled?: boolean, fromEmail?: string, fromName?: string, replyToEmail?: string, replyToName?: string): Promise<Models.Provider>;
|
|
601
|
+
/**
|
|
602
|
+
* Update a Resend provider by its unique ID.
|
|
603
|
+
*
|
|
604
|
+
* @param {string} params.providerId - Provider ID.
|
|
605
|
+
* @param {string} params.apiKey - Resend API key.
|
|
606
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
607
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
608
|
+
* @param {string} params.fromName - Sender Name.
|
|
609
|
+
* @param {string} params.name - Provider name.
|
|
610
|
+
* @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
611
|
+
* @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
612
|
+
* @throws {RevenexxException}
|
|
613
|
+
* @returns {Promise<Models.Provider>}
|
|
614
|
+
*/
|
|
615
|
+
messagingUpdateResendProvider(params: {
|
|
616
|
+
providerId: string;
|
|
617
|
+
apiKey?: string;
|
|
618
|
+
enabled?: boolean;
|
|
619
|
+
fromEmail?: string;
|
|
620
|
+
fromName?: string;
|
|
621
|
+
name?: string;
|
|
622
|
+
replyToEmail?: string;
|
|
623
|
+
replyToName?: string;
|
|
624
|
+
}): Promise<Models.Provider>;
|
|
625
|
+
/**
|
|
626
|
+
* Update a Resend provider by its unique ID.
|
|
627
|
+
*
|
|
628
|
+
* @param {string} providerId - Provider ID.
|
|
629
|
+
* @param {string} apiKey - Resend API key.
|
|
630
|
+
* @param {boolean} enabled - Set as enabled.
|
|
631
|
+
* @param {string} fromEmail - Sender email address.
|
|
632
|
+
* @param {string} fromName - Sender Name.
|
|
633
|
+
* @param {string} name - Provider name.
|
|
634
|
+
* @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
635
|
+
* @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
636
|
+
* @throws {RevenexxException}
|
|
637
|
+
* @returns {Promise<Models.Provider>}
|
|
638
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
639
|
+
*/
|
|
640
|
+
messagingUpdateResendProvider(providerId: string, apiKey?: string, enabled?: boolean, fromEmail?: string, fromName?: string, name?: string, replyToEmail?: string, replyToName?: string): Promise<Models.Provider>;
|
|
641
|
+
/**
|
|
642
|
+
* Create a new Sendgrid provider.
|
|
643
|
+
*
|
|
644
|
+
* @param {string} params.name - Provider name.
|
|
645
|
+
* @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.
|
|
646
|
+
* @param {string} params.apiKey - Sendgrid API key.
|
|
647
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
648
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
649
|
+
* @param {string} params.fromName - Sender Name.
|
|
650
|
+
* @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
651
|
+
* @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
652
|
+
* @throws {RevenexxException}
|
|
653
|
+
* @returns {Promise<Models.Provider>}
|
|
654
|
+
*/
|
|
655
|
+
messagingCreateSendgridProvider(params: {
|
|
656
|
+
name: string;
|
|
657
|
+
providerId: string;
|
|
658
|
+
apiKey?: string;
|
|
659
|
+
enabled?: boolean;
|
|
660
|
+
fromEmail?: string;
|
|
661
|
+
fromName?: string;
|
|
662
|
+
replyToEmail?: string;
|
|
663
|
+
replyToName?: string;
|
|
664
|
+
}): Promise<Models.Provider>;
|
|
665
|
+
/**
|
|
666
|
+
* Create a new Sendgrid provider.
|
|
667
|
+
*
|
|
668
|
+
* @param {string} name - Provider name.
|
|
669
|
+
* @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.
|
|
670
|
+
* @param {string} apiKey - Sendgrid API key.
|
|
671
|
+
* @param {boolean} enabled - Set as enabled.
|
|
672
|
+
* @param {string} fromEmail - Sender email address.
|
|
673
|
+
* @param {string} fromName - Sender Name.
|
|
674
|
+
* @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
|
|
675
|
+
* @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
|
|
676
|
+
* @throws {RevenexxException}
|
|
677
|
+
* @returns {Promise<Models.Provider>}
|
|
678
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
679
|
+
*/
|
|
680
|
+
messagingCreateSendgridProvider(name: string, providerId: string, apiKey?: string, enabled?: boolean, fromEmail?: string, fromName?: string, replyToEmail?: string, replyToName?: string): Promise<Models.Provider>;
|
|
681
|
+
/**
|
|
682
|
+
* Update a Sendgrid provider by its unique ID.
|
|
683
|
+
*
|
|
684
|
+
* @param {string} params.providerId - Provider ID.
|
|
685
|
+
* @param {string} params.apiKey - Sendgrid API key.
|
|
686
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
687
|
+
* @param {string} params.fromEmail - Sender email address.
|
|
688
|
+
* @param {string} params.fromName - Sender Name.
|
|
689
|
+
* @param {string} params.name - Provider name.
|
|
690
|
+
* @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
691
|
+
* @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
692
|
+
* @throws {RevenexxException}
|
|
693
|
+
* @returns {Promise<Models.Provider>}
|
|
694
|
+
*/
|
|
695
|
+
messagingUpdateSendgridProvider(params: {
|
|
696
|
+
providerId: string;
|
|
697
|
+
apiKey?: string;
|
|
698
|
+
enabled?: boolean;
|
|
699
|
+
fromEmail?: string;
|
|
700
|
+
fromName?: string;
|
|
701
|
+
name?: string;
|
|
702
|
+
replyToEmail?: string;
|
|
703
|
+
replyToName?: string;
|
|
704
|
+
}): Promise<Models.Provider>;
|
|
705
|
+
/**
|
|
706
|
+
* Update a Sendgrid provider by its unique ID.
|
|
707
|
+
*
|
|
708
|
+
* @param {string} providerId - Provider ID.
|
|
709
|
+
* @param {string} apiKey - Sendgrid API key.
|
|
710
|
+
* @param {boolean} enabled - Set as enabled.
|
|
711
|
+
* @param {string} fromEmail - Sender email address.
|
|
712
|
+
* @param {string} fromName - Sender Name.
|
|
713
|
+
* @param {string} name - Provider name.
|
|
714
|
+
* @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
715
|
+
* @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
716
|
+
* @throws {RevenexxException}
|
|
717
|
+
* @returns {Promise<Models.Provider>}
|
|
718
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
719
|
+
*/
|
|
720
|
+
messagingUpdateSendgridProvider(providerId: string, apiKey?: string, enabled?: boolean, fromEmail?: string, fromName?: string, name?: string, replyToEmail?: string, replyToName?: string): Promise<Models.Provider>;
|
|
721
|
+
/**
|
|
722
|
+
* Create a new Telesign provider.
|
|
723
|
+
*
|
|
724
|
+
* @param {string} params.name - Provider name.
|
|
725
|
+
* @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.
|
|
726
|
+
* @param {string} params.apiKey - Telesign API key.
|
|
727
|
+
* @param {string} params.customerId - Telesign customer ID.
|
|
728
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
729
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
730
|
+
* @throws {RevenexxException}
|
|
731
|
+
* @returns {Promise<Models.Provider>}
|
|
732
|
+
*/
|
|
733
|
+
messagingCreateTelesignProvider(params: {
|
|
734
|
+
name: string;
|
|
735
|
+
providerId: string;
|
|
736
|
+
apiKey?: string;
|
|
737
|
+
customerId?: string;
|
|
738
|
+
enabled?: boolean;
|
|
739
|
+
from?: string;
|
|
740
|
+
}): Promise<Models.Provider>;
|
|
741
|
+
/**
|
|
742
|
+
* Create a new Telesign provider.
|
|
743
|
+
*
|
|
744
|
+
* @param {string} name - Provider name.
|
|
745
|
+
* @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.
|
|
746
|
+
* @param {string} apiKey - Telesign API key.
|
|
747
|
+
* @param {string} customerId - Telesign customer ID.
|
|
748
|
+
* @param {boolean} enabled - Set as enabled.
|
|
749
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
750
|
+
* @throws {RevenexxException}
|
|
751
|
+
* @returns {Promise<Models.Provider>}
|
|
752
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
753
|
+
*/
|
|
754
|
+
messagingCreateTelesignProvider(name: string, providerId: string, apiKey?: string, customerId?: string, enabled?: boolean, from?: string): Promise<Models.Provider>;
|
|
755
|
+
/**
|
|
756
|
+
* Update a Telesign provider by its unique ID.
|
|
757
|
+
*
|
|
758
|
+
* @param {string} params.providerId - Provider ID.
|
|
759
|
+
* @param {string} params.apiKey - Telesign API key.
|
|
760
|
+
* @param {string} params.customerId - Telesign customer ID.
|
|
761
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
762
|
+
* @param {string} params.from - Sender number.
|
|
763
|
+
* @param {string} params.name - Provider name.
|
|
764
|
+
* @throws {RevenexxException}
|
|
765
|
+
* @returns {Promise<Models.Provider>}
|
|
766
|
+
*/
|
|
767
|
+
messagingUpdateTelesignProvider(params: {
|
|
768
|
+
providerId: string;
|
|
769
|
+
apiKey?: string;
|
|
770
|
+
customerId?: string;
|
|
771
|
+
enabled?: boolean;
|
|
772
|
+
from?: string;
|
|
773
|
+
name?: string;
|
|
774
|
+
}): Promise<Models.Provider>;
|
|
775
|
+
/**
|
|
776
|
+
* Update a Telesign provider by its unique ID.
|
|
777
|
+
*
|
|
778
|
+
* @param {string} providerId - Provider ID.
|
|
779
|
+
* @param {string} apiKey - Telesign API key.
|
|
780
|
+
* @param {string} customerId - Telesign customer ID.
|
|
781
|
+
* @param {boolean} enabled - Set as enabled.
|
|
782
|
+
* @param {string} from - Sender number.
|
|
783
|
+
* @param {string} name - Provider name.
|
|
784
|
+
* @throws {RevenexxException}
|
|
785
|
+
* @returns {Promise<Models.Provider>}
|
|
786
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
787
|
+
*/
|
|
788
|
+
messagingUpdateTelesignProvider(providerId: string, apiKey?: string, customerId?: string, enabled?: boolean, from?: string, name?: string): Promise<Models.Provider>;
|
|
789
|
+
/**
|
|
790
|
+
* Create a new Textmagic provider.
|
|
791
|
+
*
|
|
792
|
+
* @param {string} params.name - Provider name.
|
|
793
|
+
* @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.
|
|
794
|
+
* @param {string} params.apiKey - Textmagic apiKey.
|
|
795
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
796
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
797
|
+
* @param {string} params.username - Textmagic username.
|
|
798
|
+
* @throws {RevenexxException}
|
|
799
|
+
* @returns {Promise<Models.Provider>}
|
|
800
|
+
*/
|
|
801
|
+
messagingCreateTextmagicProvider(params: {
|
|
802
|
+
name: string;
|
|
803
|
+
providerId: string;
|
|
804
|
+
apiKey?: string;
|
|
805
|
+
enabled?: boolean;
|
|
806
|
+
from?: string;
|
|
807
|
+
username?: string;
|
|
808
|
+
}): Promise<Models.Provider>;
|
|
809
|
+
/**
|
|
810
|
+
* Create a new Textmagic provider.
|
|
811
|
+
*
|
|
812
|
+
* @param {string} name - Provider name.
|
|
813
|
+
* @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.
|
|
814
|
+
* @param {string} apiKey - Textmagic apiKey.
|
|
815
|
+
* @param {boolean} enabled - Set as enabled.
|
|
816
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
817
|
+
* @param {string} username - Textmagic username.
|
|
818
|
+
* @throws {RevenexxException}
|
|
819
|
+
* @returns {Promise<Models.Provider>}
|
|
820
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
821
|
+
*/
|
|
822
|
+
messagingCreateTextmagicProvider(name: string, providerId: string, apiKey?: string, enabled?: boolean, from?: string, username?: string): Promise<Models.Provider>;
|
|
823
|
+
/**
|
|
824
|
+
* Update a Textmagic provider by its unique ID.
|
|
825
|
+
*
|
|
826
|
+
* @param {string} params.providerId - Provider ID.
|
|
827
|
+
* @param {string} params.apiKey - Textmagic apiKey.
|
|
828
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
829
|
+
* @param {string} params.from - Sender number.
|
|
830
|
+
* @param {string} params.name - Provider name.
|
|
831
|
+
* @param {string} params.username - Textmagic username.
|
|
832
|
+
* @throws {RevenexxException}
|
|
833
|
+
* @returns {Promise<Models.Provider>}
|
|
834
|
+
*/
|
|
835
|
+
messagingUpdateTextmagicProvider(params: {
|
|
836
|
+
providerId: string;
|
|
837
|
+
apiKey?: string;
|
|
838
|
+
enabled?: boolean;
|
|
839
|
+
from?: string;
|
|
840
|
+
name?: string;
|
|
841
|
+
username?: string;
|
|
842
|
+
}): Promise<Models.Provider>;
|
|
843
|
+
/**
|
|
844
|
+
* Update a Textmagic provider by its unique ID.
|
|
845
|
+
*
|
|
846
|
+
* @param {string} providerId - Provider ID.
|
|
847
|
+
* @param {string} apiKey - Textmagic apiKey.
|
|
848
|
+
* @param {boolean} enabled - Set as enabled.
|
|
849
|
+
* @param {string} from - Sender number.
|
|
850
|
+
* @param {string} name - Provider name.
|
|
851
|
+
* @param {string} username - Textmagic username.
|
|
852
|
+
* @throws {RevenexxException}
|
|
853
|
+
* @returns {Promise<Models.Provider>}
|
|
854
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
855
|
+
*/
|
|
856
|
+
messagingUpdateTextmagicProvider(providerId: string, apiKey?: string, enabled?: boolean, from?: string, name?: string, username?: string): Promise<Models.Provider>;
|
|
857
|
+
/**
|
|
858
|
+
* Create a new Twilio provider.
|
|
859
|
+
*
|
|
860
|
+
* @param {string} params.name - Provider name.
|
|
861
|
+
* @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.
|
|
862
|
+
* @param {string} params.accountSid - Twilio account secret ID.
|
|
863
|
+
* @param {string} params.authToken - Twilio authentication token.
|
|
864
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
865
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
866
|
+
* @throws {RevenexxException}
|
|
867
|
+
* @returns {Promise<Models.Provider>}
|
|
868
|
+
*/
|
|
869
|
+
messagingCreateTwilioProvider(params: {
|
|
870
|
+
name: string;
|
|
871
|
+
providerId: string;
|
|
872
|
+
accountSid?: string;
|
|
873
|
+
authToken?: string;
|
|
874
|
+
enabled?: boolean;
|
|
875
|
+
from?: string;
|
|
876
|
+
}): Promise<Models.Provider>;
|
|
877
|
+
/**
|
|
878
|
+
* Create a new Twilio provider.
|
|
879
|
+
*
|
|
880
|
+
* @param {string} name - Provider name.
|
|
881
|
+
* @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.
|
|
882
|
+
* @param {string} accountSid - Twilio account secret ID.
|
|
883
|
+
* @param {string} authToken - Twilio authentication token.
|
|
884
|
+
* @param {boolean} enabled - Set as enabled.
|
|
885
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
886
|
+
* @throws {RevenexxException}
|
|
887
|
+
* @returns {Promise<Models.Provider>}
|
|
888
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
889
|
+
*/
|
|
890
|
+
messagingCreateTwilioProvider(name: string, providerId: string, accountSid?: string, authToken?: string, enabled?: boolean, from?: string): Promise<Models.Provider>;
|
|
891
|
+
/**
|
|
892
|
+
* Update a Twilio provider by its unique ID.
|
|
893
|
+
*
|
|
894
|
+
* @param {string} params.providerId - Provider ID.
|
|
895
|
+
* @param {string} params.accountSid - Twilio account secret ID.
|
|
896
|
+
* @param {string} params.authToken - Twilio authentication token.
|
|
897
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
898
|
+
* @param {string} params.from - Sender number.
|
|
899
|
+
* @param {string} params.name - Provider name.
|
|
900
|
+
* @throws {RevenexxException}
|
|
901
|
+
* @returns {Promise<Models.Provider>}
|
|
902
|
+
*/
|
|
903
|
+
messagingUpdateTwilioProvider(params: {
|
|
904
|
+
providerId: string;
|
|
905
|
+
accountSid?: string;
|
|
906
|
+
authToken?: string;
|
|
907
|
+
enabled?: boolean;
|
|
908
|
+
from?: string;
|
|
909
|
+
name?: string;
|
|
910
|
+
}): Promise<Models.Provider>;
|
|
911
|
+
/**
|
|
912
|
+
* Update a Twilio provider by its unique ID.
|
|
913
|
+
*
|
|
914
|
+
* @param {string} providerId - Provider ID.
|
|
915
|
+
* @param {string} accountSid - Twilio account secret ID.
|
|
916
|
+
* @param {string} authToken - Twilio authentication token.
|
|
917
|
+
* @param {boolean} enabled - Set as enabled.
|
|
918
|
+
* @param {string} from - Sender number.
|
|
919
|
+
* @param {string} name - Provider name.
|
|
920
|
+
* @throws {RevenexxException}
|
|
921
|
+
* @returns {Promise<Models.Provider>}
|
|
922
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
923
|
+
*/
|
|
924
|
+
messagingUpdateTwilioProvider(providerId: string, accountSid?: string, authToken?: string, enabled?: boolean, from?: string, name?: string): Promise<Models.Provider>;
|
|
925
|
+
/**
|
|
926
|
+
* Create a new Vonage provider.
|
|
927
|
+
*
|
|
928
|
+
* @param {string} params.name - Provider name.
|
|
929
|
+
* @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.
|
|
930
|
+
* @param {string} params.apiKey - Vonage API key.
|
|
931
|
+
* @param {string} params.apiSecret - Vonage API secret.
|
|
932
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
933
|
+
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
934
|
+
* @throws {RevenexxException}
|
|
935
|
+
* @returns {Promise<Models.Provider>}
|
|
936
|
+
*/
|
|
937
|
+
messagingCreateVonageProvider(params: {
|
|
938
|
+
name: string;
|
|
939
|
+
providerId: string;
|
|
940
|
+
apiKey?: string;
|
|
941
|
+
apiSecret?: string;
|
|
942
|
+
enabled?: boolean;
|
|
943
|
+
from?: string;
|
|
944
|
+
}): Promise<Models.Provider>;
|
|
945
|
+
/**
|
|
946
|
+
* Create a new Vonage provider.
|
|
947
|
+
*
|
|
948
|
+
* @param {string} name - Provider name.
|
|
949
|
+
* @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.
|
|
950
|
+
* @param {string} apiKey - Vonage API key.
|
|
951
|
+
* @param {string} apiSecret - Vonage API secret.
|
|
952
|
+
* @param {boolean} enabled - Set as enabled.
|
|
953
|
+
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
954
|
+
* @throws {RevenexxException}
|
|
955
|
+
* @returns {Promise<Models.Provider>}
|
|
956
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
957
|
+
*/
|
|
958
|
+
messagingCreateVonageProvider(name: string, providerId: string, apiKey?: string, apiSecret?: string, enabled?: boolean, from?: string): Promise<Models.Provider>;
|
|
959
|
+
/**
|
|
960
|
+
* Update a Vonage provider by its unique ID.
|
|
961
|
+
*
|
|
962
|
+
* @param {string} params.providerId - Provider ID.
|
|
963
|
+
* @param {string} params.apiKey - Vonage API key.
|
|
964
|
+
* @param {string} params.apiSecret - Vonage API secret.
|
|
965
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
966
|
+
* @param {string} params.from - Sender number.
|
|
967
|
+
* @param {string} params.name - Provider name.
|
|
968
|
+
* @throws {RevenexxException}
|
|
969
|
+
* @returns {Promise<Models.Provider>}
|
|
970
|
+
*/
|
|
971
|
+
messagingUpdateVonageProvider(params: {
|
|
972
|
+
providerId: string;
|
|
973
|
+
apiKey?: string;
|
|
974
|
+
apiSecret?: string;
|
|
975
|
+
enabled?: boolean;
|
|
976
|
+
from?: string;
|
|
977
|
+
name?: string;
|
|
978
|
+
}): Promise<Models.Provider>;
|
|
979
|
+
/**
|
|
980
|
+
* Update a Vonage provider by its unique ID.
|
|
981
|
+
*
|
|
982
|
+
* @param {string} providerId - Provider ID.
|
|
983
|
+
* @param {string} apiKey - Vonage API key.
|
|
984
|
+
* @param {string} apiSecret - Vonage API secret.
|
|
985
|
+
* @param {boolean} enabled - Set as enabled.
|
|
986
|
+
* @param {string} from - Sender number.
|
|
987
|
+
* @param {string} name - Provider name.
|
|
988
|
+
* @throws {RevenexxException}
|
|
989
|
+
* @returns {Promise<Models.Provider>}
|
|
990
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
991
|
+
*/
|
|
992
|
+
messagingUpdateVonageProvider(providerId: string, apiKey?: string, apiSecret?: string, enabled?: boolean, from?: string, name?: string): Promise<Models.Provider>;
|
|
993
|
+
/**
|
|
994
|
+
* Delete a provider by its unique ID.
|
|
995
|
+
*
|
|
996
|
+
* @param {string} params.providerId - Provider ID.
|
|
997
|
+
* @throws {RevenexxException}
|
|
998
|
+
* @returns {Promise<{}>}
|
|
999
|
+
*/
|
|
1000
|
+
messagingDeleteProvider(params: {
|
|
1001
|
+
providerId: string;
|
|
1002
|
+
}): Promise<{}>;
|
|
1003
|
+
/**
|
|
1004
|
+
* Delete a provider by its unique ID.
|
|
1005
|
+
*
|
|
1006
|
+
* @param {string} providerId - Provider ID.
|
|
1007
|
+
* @throws {RevenexxException}
|
|
1008
|
+
* @returns {Promise<{}>}
|
|
1009
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1010
|
+
*/
|
|
1011
|
+
messagingDeleteProvider(providerId: string): Promise<{}>;
|
|
1012
|
+
/**
|
|
1013
|
+
* Get a provider by its unique ID.
|
|
1014
|
+
*
|
|
1015
|
+
*
|
|
1016
|
+
* @param {string} params.providerId - Provider ID.
|
|
1017
|
+
* @throws {RevenexxException}
|
|
1018
|
+
* @returns {Promise<Models.Provider>}
|
|
1019
|
+
*/
|
|
1020
|
+
messagingGetProvider(params: {
|
|
1021
|
+
providerId: string;
|
|
1022
|
+
}): Promise<Models.Provider>;
|
|
1023
|
+
/**
|
|
1024
|
+
* Get a provider by its unique ID.
|
|
1025
|
+
*
|
|
1026
|
+
*
|
|
1027
|
+
* @param {string} providerId - Provider ID.
|
|
1028
|
+
* @throws {RevenexxException}
|
|
1029
|
+
* @returns {Promise<Models.Provider>}
|
|
1030
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1031
|
+
*/
|
|
1032
|
+
messagingGetProvider(providerId: string): Promise<Models.Provider>;
|
|
1033
|
+
/**
|
|
1034
|
+
* Get the provider activity logs listed by its unique ID.
|
|
1035
|
+
*
|
|
1036
|
+
* @param {string} params.providerId - Provider ID.
|
|
1037
|
+
* @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
|
|
1038
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1039
|
+
* @throws {RevenexxException}
|
|
1040
|
+
* @returns {Promise<Models.LogList>}
|
|
1041
|
+
*/
|
|
1042
|
+
messagingListProviderLogs(params: {
|
|
1043
|
+
providerId: string;
|
|
1044
|
+
queries?: string[];
|
|
1045
|
+
total?: boolean;
|
|
1046
|
+
}): Promise<Models.LogList>;
|
|
1047
|
+
/**
|
|
1048
|
+
* Get the provider activity logs listed by its unique ID.
|
|
1049
|
+
*
|
|
1050
|
+
* @param {string} providerId - Provider ID.
|
|
1051
|
+
* @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
|
|
1052
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1053
|
+
* @throws {RevenexxException}
|
|
1054
|
+
* @returns {Promise<Models.LogList>}
|
|
1055
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1056
|
+
*/
|
|
1057
|
+
messagingListProviderLogs(providerId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
|
|
1058
|
+
/**
|
|
1059
|
+
* Get the subscriber activity logs listed by its unique ID.
|
|
1060
|
+
*
|
|
1061
|
+
* @param {string} params.subscriberId - Subscriber ID.
|
|
1062
|
+
* @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
|
|
1063
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1064
|
+
* @throws {RevenexxException}
|
|
1065
|
+
* @returns {Promise<Models.LogList>}
|
|
1066
|
+
*/
|
|
1067
|
+
messagingListSubscriberLogs(params: {
|
|
1068
|
+
subscriberId: string;
|
|
1069
|
+
queries?: string[];
|
|
1070
|
+
total?: boolean;
|
|
1071
|
+
}): Promise<Models.LogList>;
|
|
1072
|
+
/**
|
|
1073
|
+
* Get the subscriber activity logs listed by its unique ID.
|
|
1074
|
+
*
|
|
1075
|
+
* @param {string} subscriberId - Subscriber ID.
|
|
1076
|
+
* @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
|
|
1077
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1078
|
+
* @throws {RevenexxException}
|
|
1079
|
+
* @returns {Promise<Models.LogList>}
|
|
1080
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1081
|
+
*/
|
|
1082
|
+
messagingListSubscriberLogs(subscriberId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
|
|
1083
|
+
/**
|
|
1084
|
+
* Get a list of all topics from the current Revenexx project.
|
|
1085
|
+
*
|
|
1086
|
+
* @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
|
|
1087
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
1088
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1089
|
+
* @throws {RevenexxException}
|
|
1090
|
+
* @returns {Promise<Models.TopicList>}
|
|
1091
|
+
*/
|
|
1092
|
+
messagingListTopics(params?: {
|
|
1093
|
+
queries?: string[];
|
|
1094
|
+
search?: string;
|
|
1095
|
+
total?: boolean;
|
|
1096
|
+
}): Promise<Models.TopicList>;
|
|
1097
|
+
/**
|
|
1098
|
+
* Get a list of all topics from the current Revenexx project.
|
|
1099
|
+
*
|
|
1100
|
+
* @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
|
|
1101
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
1102
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1103
|
+
* @throws {RevenexxException}
|
|
1104
|
+
* @returns {Promise<Models.TopicList>}
|
|
1105
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1106
|
+
*/
|
|
1107
|
+
messagingListTopics(queries?: string[], search?: string, total?: boolean): Promise<Models.TopicList>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Create a new topic.
|
|
1110
|
+
*
|
|
1111
|
+
* @param {string} params.name - Topic Name.
|
|
1112
|
+
* @param {string} params.topicId - Topic ID. Choose a custom Topic ID or a new Topic ID.
|
|
1113
|
+
* @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.
|
|
1114
|
+
* @throws {RevenexxException}
|
|
1115
|
+
* @returns {Promise<Models.Topic>}
|
|
1116
|
+
*/
|
|
1117
|
+
messagingCreateTopic(params: {
|
|
1118
|
+
name: string;
|
|
1119
|
+
topicId: string;
|
|
1120
|
+
subscribe?: string[];
|
|
1121
|
+
}): Promise<Models.Topic>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Create a new topic.
|
|
1124
|
+
*
|
|
1125
|
+
* @param {string} name - Topic Name.
|
|
1126
|
+
* @param {string} topicId - Topic ID. Choose a custom Topic ID or a new Topic ID.
|
|
1127
|
+
* @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.
|
|
1128
|
+
* @throws {RevenexxException}
|
|
1129
|
+
* @returns {Promise<Models.Topic>}
|
|
1130
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1131
|
+
*/
|
|
1132
|
+
messagingCreateTopic(name: string, topicId: string, subscribe?: string[]): Promise<Models.Topic>;
|
|
1133
|
+
/**
|
|
1134
|
+
* Delete a topic by its unique ID.
|
|
1135
|
+
*
|
|
1136
|
+
* @param {string} params.topicId - Topic ID.
|
|
1137
|
+
* @throws {RevenexxException}
|
|
1138
|
+
* @returns {Promise<{}>}
|
|
1139
|
+
*/
|
|
1140
|
+
messagingDeleteTopic(params: {
|
|
1141
|
+
topicId: string;
|
|
1142
|
+
}): Promise<{}>;
|
|
1143
|
+
/**
|
|
1144
|
+
* Delete a topic by its unique ID.
|
|
1145
|
+
*
|
|
1146
|
+
* @param {string} topicId - Topic ID.
|
|
1147
|
+
* @throws {RevenexxException}
|
|
1148
|
+
* @returns {Promise<{}>}
|
|
1149
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1150
|
+
*/
|
|
1151
|
+
messagingDeleteTopic(topicId: string): Promise<{}>;
|
|
1152
|
+
/**
|
|
1153
|
+
* Get a topic by its unique ID.
|
|
1154
|
+
*
|
|
1155
|
+
*
|
|
1156
|
+
* @param {string} params.topicId - Topic ID.
|
|
1157
|
+
* @throws {RevenexxException}
|
|
1158
|
+
* @returns {Promise<Models.Topic>}
|
|
1159
|
+
*/
|
|
1160
|
+
messagingGetTopic(params: {
|
|
1161
|
+
topicId: string;
|
|
1162
|
+
}): Promise<Models.Topic>;
|
|
1163
|
+
/**
|
|
1164
|
+
* Get a topic by its unique ID.
|
|
1165
|
+
*
|
|
1166
|
+
*
|
|
1167
|
+
* @param {string} topicId - Topic ID.
|
|
1168
|
+
* @throws {RevenexxException}
|
|
1169
|
+
* @returns {Promise<Models.Topic>}
|
|
1170
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1171
|
+
*/
|
|
1172
|
+
messagingGetTopic(topicId: string): Promise<Models.Topic>;
|
|
1173
|
+
/**
|
|
1174
|
+
* Update a topic by its unique ID.
|
|
1175
|
+
*
|
|
1176
|
+
*
|
|
1177
|
+
* @param {string} params.topicId - Topic ID.
|
|
1178
|
+
* @param {string} params.name - Topic Name.
|
|
1179
|
+
* @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.
|
|
1180
|
+
* @throws {RevenexxException}
|
|
1181
|
+
* @returns {Promise<Models.Topic>}
|
|
1182
|
+
*/
|
|
1183
|
+
messagingUpdateTopic(params: {
|
|
1184
|
+
topicId: string;
|
|
1185
|
+
name?: string;
|
|
1186
|
+
subscribe?: string[];
|
|
1187
|
+
}): Promise<Models.Topic>;
|
|
1188
|
+
/**
|
|
1189
|
+
* Update a topic by its unique ID.
|
|
1190
|
+
*
|
|
1191
|
+
*
|
|
1192
|
+
* @param {string} topicId - Topic ID.
|
|
1193
|
+
* @param {string} name - Topic Name.
|
|
1194
|
+
* @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.
|
|
1195
|
+
* @throws {RevenexxException}
|
|
1196
|
+
* @returns {Promise<Models.Topic>}
|
|
1197
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1198
|
+
*/
|
|
1199
|
+
messagingUpdateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic>;
|
|
1200
|
+
/**
|
|
1201
|
+
* Get the topic activity logs listed by its unique ID.
|
|
1202
|
+
*
|
|
1203
|
+
* @param {string} params.topicId - Topic ID.
|
|
1204
|
+
* @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
|
|
1205
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1206
|
+
* @throws {RevenexxException}
|
|
1207
|
+
* @returns {Promise<Models.LogList>}
|
|
1208
|
+
*/
|
|
1209
|
+
messagingListTopicLogs(params: {
|
|
1210
|
+
topicId: string;
|
|
1211
|
+
queries?: string[];
|
|
1212
|
+
total?: boolean;
|
|
1213
|
+
}): Promise<Models.LogList>;
|
|
1214
|
+
/**
|
|
1215
|
+
* Get the topic activity logs listed by its unique ID.
|
|
1216
|
+
*
|
|
1217
|
+
* @param {string} topicId - Topic ID.
|
|
1218
|
+
* @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
|
|
1219
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1220
|
+
* @throws {RevenexxException}
|
|
1221
|
+
* @returns {Promise<Models.LogList>}
|
|
1222
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1223
|
+
*/
|
|
1224
|
+
messagingListTopicLogs(topicId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
|
|
1225
|
+
/**
|
|
1226
|
+
* Get a list of all subscribers from the current Revenexx project.
|
|
1227
|
+
*
|
|
1228
|
+
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1229
|
+
* @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
|
|
1230
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
1231
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1232
|
+
* @throws {RevenexxException}
|
|
1233
|
+
* @returns {Promise<Models.SubscriberList>}
|
|
1234
|
+
*/
|
|
1235
|
+
messagingListSubscribers(params: {
|
|
1236
|
+
topicId: string;
|
|
1237
|
+
queries?: string[];
|
|
1238
|
+
search?: string;
|
|
1239
|
+
total?: boolean;
|
|
1240
|
+
}): Promise<Models.SubscriberList>;
|
|
1241
|
+
/**
|
|
1242
|
+
* Get a list of all subscribers from the current Revenexx project.
|
|
1243
|
+
*
|
|
1244
|
+
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1245
|
+
* @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
|
|
1246
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
1247
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1248
|
+
* @throws {RevenexxException}
|
|
1249
|
+
* @returns {Promise<Models.SubscriberList>}
|
|
1250
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1251
|
+
*/
|
|
1252
|
+
messagingListSubscribers(topicId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.SubscriberList>;
|
|
1253
|
+
/**
|
|
1254
|
+
* Create a new subscriber.
|
|
1255
|
+
*
|
|
1256
|
+
* @param {string} params.topicId - Topic ID. The topic ID to subscribe to.
|
|
1257
|
+
* @param {string} params.subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
|
|
1258
|
+
* @param {string} params.targetId - Target ID. The target ID to link to the specified Topic ID.
|
|
1259
|
+
* @throws {RevenexxException}
|
|
1260
|
+
* @returns {Promise<Models.Subscriber>}
|
|
1261
|
+
*/
|
|
1262
|
+
messagingCreateSubscriber(params: {
|
|
1263
|
+
topicId: string;
|
|
1264
|
+
subscriberId: string;
|
|
1265
|
+
targetId: string;
|
|
1266
|
+
}): Promise<Models.Subscriber>;
|
|
1267
|
+
/**
|
|
1268
|
+
* Create a new subscriber.
|
|
1269
|
+
*
|
|
1270
|
+
* @param {string} topicId - Topic ID. The topic ID to subscribe to.
|
|
1271
|
+
* @param {string} subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
|
|
1272
|
+
* @param {string} targetId - Target ID. The target ID to link to the specified Topic ID.
|
|
1273
|
+
* @throws {RevenexxException}
|
|
1274
|
+
* @returns {Promise<Models.Subscriber>}
|
|
1275
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1276
|
+
*/
|
|
1277
|
+
messagingCreateSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
|
|
1278
|
+
/**
|
|
1279
|
+
* Delete a subscriber by its unique ID.
|
|
1280
|
+
*
|
|
1281
|
+
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1282
|
+
* @param {string} params.subscriberId - Subscriber ID.
|
|
1283
|
+
* @throws {RevenexxException}
|
|
1284
|
+
* @returns {Promise<{}>}
|
|
1285
|
+
*/
|
|
1286
|
+
messagingDeleteSubscriber(params: {
|
|
1287
|
+
topicId: string;
|
|
1288
|
+
subscriberId: string;
|
|
1289
|
+
}): Promise<{}>;
|
|
1290
|
+
/**
|
|
1291
|
+
* Delete a subscriber by its unique ID.
|
|
1292
|
+
*
|
|
1293
|
+
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1294
|
+
* @param {string} subscriberId - Subscriber ID.
|
|
1295
|
+
* @throws {RevenexxException}
|
|
1296
|
+
* @returns {Promise<{}>}
|
|
1297
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1298
|
+
*/
|
|
1299
|
+
messagingDeleteSubscriber(topicId: string, subscriberId: string): Promise<{}>;
|
|
1300
|
+
/**
|
|
1301
|
+
* Get a subscriber by its unique ID.
|
|
1302
|
+
*
|
|
1303
|
+
*
|
|
1304
|
+
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1305
|
+
* @param {string} params.subscriberId - Subscriber ID.
|
|
1306
|
+
* @throws {RevenexxException}
|
|
1307
|
+
* @returns {Promise<Models.Subscriber>}
|
|
1308
|
+
*/
|
|
1309
|
+
messagingGetSubscriber(params: {
|
|
1310
|
+
topicId: string;
|
|
1311
|
+
subscriberId: string;
|
|
1312
|
+
}): Promise<Models.Subscriber>;
|
|
1313
|
+
/**
|
|
1314
|
+
* Get a subscriber by its unique ID.
|
|
1315
|
+
*
|
|
1316
|
+
*
|
|
1317
|
+
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1318
|
+
* @param {string} subscriberId - Subscriber ID.
|
|
1319
|
+
* @throws {RevenexxException}
|
|
1320
|
+
* @returns {Promise<Models.Subscriber>}
|
|
1321
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1322
|
+
*/
|
|
1323
|
+
messagingGetSubscriber(topicId: string, subscriberId: string): Promise<Models.Subscriber>;
|
|
1324
|
+
}
|