import { Client } from '../client'; import type { Models } from '../models'; import { Priority } from '../enums/priority'; export declare class Messaging { client: Client; constructor(client: Client); /** * Get a list of all messages from the current Revenexx project. * * @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 * @param {string} params.search - Search term to filter your list results. Max length: 256 chars. * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} */ messagingListMessages(params?: { queries?: string[]; search?: string; total?: boolean; }): Promise; /** * Get a list of all messages from the current Revenexx project. * * @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 * @param {string} search - Search term to filter your list results. Max length: 256 chars. * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingListMessages(queries?: string[], search?: string, total?: boolean): Promise; /** * Create a new email message. * * @param {string} params.content - Email Content. * @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. * @param {string} params.subject - Email Subject. * @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 :. * @param {string[]} params.bcc - Array of target IDs to be added as BCC. * @param {string[]} params.cc - Array of target IDs to be added as CC. * @param {boolean} params.draft - Is message a draft * @param {boolean} params.html - Is content of type HTML * @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. * @param {string[]} params.targets - List of Targets IDs. * @param {string[]} params.topics - List of Topic IDs. * @param {string[]} params.users - List of User IDs. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateEmail(params: { 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; /** * Create a new email message. * * @param {string} content - Email Content. * @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. * @param {string} subject - Email Subject. * @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 :. * @param {string[]} bcc - Array of target IDs to be added as BCC. * @param {string[]} cc - Array of target IDs to be added as CC. * @param {boolean} draft - Is message a draft * @param {boolean} html - Is content of type HTML * @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. * @param {string[]} targets - List of Targets IDs. * @param {string[]} topics - List of Topic IDs. * @param {string[]} users - List of User IDs. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ 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; /** * 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. * * * @param {string} params.messageId - Message ID. * @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 :. * @param {string[]} params.bcc - Array of target IDs to be added as BCC. * @param {string[]} params.cc - Array of target IDs to be added as CC. * @param {string} params.content - Email Content. * @param {boolean} params.draft - Is message a draft * @param {boolean} params.html - Is content of type HTML * @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. * @param {string} params.subject - Email Subject. * @param {string[]} params.targets - List of Targets IDs. * @param {string[]} params.topics - List of Topic IDs. * @param {string[]} params.users - List of User IDs. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateEmail(params: { 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; /** * 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. * * * @param {string} messageId - Message ID. * @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 :. * @param {string[]} bcc - Array of target IDs to be added as BCC. * @param {string[]} cc - Array of target IDs to be added as CC. * @param {string} content - Email Content. * @param {boolean} draft - Is message a draft * @param {boolean} html - Is content of type HTML * @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. * @param {string} subject - Email Subject. * @param {string[]} targets - List of Targets IDs. * @param {string[]} topics - List of Topic IDs. * @param {string[]} users - List of User IDs. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ 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; /** * Create a new push notification. * * @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. * @param {string} params.action - Action for push notification. * @param {number} params.badge - Badge for push notification. Available only for iOS Platform. * @param {string} params.body - Body for push notification. * @param {string} params.color - Color for push notification. Available only for Android Platform. * @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform. * @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. * @param {object} params.data - Additional key-value pair data for push notification. * @param {boolean} params.draft - Is message a draft * @param {string} params.icon - Icon for push notification. Available only for Android and Web Platform. * @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 :. * @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. * @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. * @param {string} params.sound - Sound for push notification. Available only for Android and iOS Platform. * @param {string} params.tag - Tag for push notification. Available only for Android Platform. * @param {string[]} params.targets - List of Targets IDs. * @param {string} params.title - Title for push notification. * @param {string[]} params.topics - List of Topic IDs. * @param {string[]} params.users - List of User IDs. * @throws {RevenexxException} * @returns {Promise} */ messagingCreatePush(params: { 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; /** * Create a new push notification. * * @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. * @param {string} action - Action for push notification. * @param {number} badge - Badge for push notification. Available only for iOS Platform. * @param {string} body - Body for push notification. * @param {string} color - Color for push notification. Available only for Android Platform. * @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform. * @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. * @param {object} data - Additional key-value pair data for push notification. * @param {boolean} draft - Is message a draft * @param {string} icon - Icon for push notification. Available only for Android and Web Platform. * @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 :. * @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. * @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. * @param {string} sound - Sound for push notification. Available only for Android and iOS Platform. * @param {string} tag - Tag for push notification. Available only for Android Platform. * @param {string[]} targets - List of Targets IDs. * @param {string} title - Title for push notification. * @param {string[]} topics - List of Topic IDs. * @param {string[]} users - List of User IDs. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ 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; /** * 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. * * * @param {string} params.messageId - Message ID. * @param {string} params.action - Action for push notification. * @param {number} params.badge - Badge for push notification. Available only for iOS platforms. * @param {string} params.body - Body for push notification. * @param {string} params.color - Color for push notification. Available only for Android platforms. * @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform. * @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. * @param {object} params.data - Additional Data for push notification. * @param {boolean} params.draft - Is message a draft * @param {string} params.icon - Icon for push notification. Available only for Android and Web platforms. * @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 :. * @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. * @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. * @param {string} params.sound - Sound for push notification. Available only for Android and iOS platforms. * @param {string} params.tag - Tag for push notification. Available only for Android platforms. * @param {string[]} params.targets - List of Targets IDs. * @param {string} params.title - Title for push notification. * @param {string[]} params.topics - List of Topic IDs. * @param {string[]} params.users - List of User IDs. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdatePush(params: { 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; /** * 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. * * * @param {string} messageId - Message ID. * @param {string} action - Action for push notification. * @param {number} badge - Badge for push notification. Available only for iOS platforms. * @param {string} body - Body for push notification. * @param {string} color - Color for push notification. Available only for Android platforms. * @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform. * @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. * @param {object} data - Additional Data for push notification. * @param {boolean} draft - Is message a draft * @param {string} icon - Icon for push notification. Available only for Android and Web platforms. * @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 :. * @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. * @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. * @param {string} sound - Sound for push notification. Available only for Android and iOS platforms. * @param {string} tag - Tag for push notification. Available only for Android platforms. * @param {string[]} targets - List of Targets IDs. * @param {string} title - Title for push notification. * @param {string[]} topics - List of Topic IDs. * @param {string[]} users - List of User IDs. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ 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; /** * Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message. * * @param {string} params.messageId - Message ID. * @throws {RevenexxException} * @returns {Promise<{}>} */ messagingDelete(params: { messageId: string; }): Promise<{}>; /** * Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message. * * @param {string} messageId - Message ID. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ messagingDelete(messageId: string): Promise<{}>; /** * Get a message by its unique ID. * * * @param {string} params.messageId - Message ID. * @throws {RevenexxException} * @returns {Promise} */ messagingGetMessage(params: { messageId: string; }): Promise; /** * Get a message by its unique ID. * * * @param {string} messageId - Message ID. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingGetMessage(messageId: string): Promise; /** * Get the message activity logs listed by its unique ID. * * @param {string} params.messageId - Message ID. * @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 * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} */ messagingListMessageLogs(params: { messageId: string; queries?: string[]; total?: boolean; }): Promise; /** * Get the message activity logs listed by its unique ID. * * @param {string} messageId - Message ID. * @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 * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingListMessageLogs(messageId: string, queries?: string[], total?: boolean): Promise; /** * Get a list of the targets associated with a message. * * @param {string} params.messageId - Message ID. * @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 * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} */ messagingListTargets(params: { messageId: string; queries?: string[]; total?: boolean; }): Promise; /** * Get a list of the targets associated with a message. * * @param {string} messageId - Message ID. * @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 * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingListTargets(messageId: string, queries?: string[], total?: boolean): Promise; /** * Get a list of all providers from the current Revenexx project. * * @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 * @param {string} params.search - Search term to filter your list results. Max length: 256 chars. * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} */ messagingListProviders(params?: { queries?: string[]; search?: string; total?: boolean; }): Promise; /** * Get a list of all providers from the current Revenexx project. * * @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 * @param {string} search - Search term to filter your list results. Max length: 256 chars. * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingListProviders(queries?: string[], search?: string, total?: boolean): Promise; /** * Create a new Mailgun provider. * * @param {string} params.name - Provider name. * @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. * @param {string} params.apiKey - Mailgun API Key. * @param {string} params.domain - Mailgun Domain. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.fromEmail - Sender email address. * @param {string} params.fromName - Sender Name. * @param {boolean} params.isEuRegion - Set as EU region. * @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. * @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. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateMailgunProvider(params: { name: string; providerId: string; apiKey?: string; domain?: string; enabled?: boolean; fromEmail?: string; fromName?: string; isEuRegion?: boolean; replyToEmail?: string; replyToName?: string; }): Promise; /** * Create a new Mailgun provider. * * @param {string} name - Provider name. * @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. * @param {string} apiKey - Mailgun API Key. * @param {string} domain - Mailgun Domain. * @param {boolean} enabled - Set as enabled. * @param {string} fromEmail - Sender email address. * @param {string} fromName - Sender Name. * @param {boolean} isEuRegion - Set as EU region. * @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. * @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. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateMailgunProvider(name: string, providerId: string, apiKey?: string, domain?: string, enabled?: boolean, fromEmail?: string, fromName?: string, isEuRegion?: boolean, replyToEmail?: string, replyToName?: string): Promise; /** * Update a Mailgun provider by its unique ID. * * @param {string} params.providerId - Provider ID. * @param {string} params.apiKey - Mailgun API Key. * @param {string} params.domain - Mailgun Domain. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.fromEmail - Sender email address. * @param {string} params.fromName - Sender Name. * @param {boolean} params.isEuRegion - Set as EU region. * @param {string} params.name - Provider name. * @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email. * @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateMailgunProvider(params: { providerId: string; apiKey?: string; domain?: string; enabled?: boolean; fromEmail?: string; fromName?: string; isEuRegion?: boolean; name?: string; replyToEmail?: string; replyToName?: string; }): Promise; /** * Update a Mailgun provider by its unique ID. * * @param {string} providerId - Provider ID. * @param {string} apiKey - Mailgun API Key. * @param {string} domain - Mailgun Domain. * @param {boolean} enabled - Set as enabled. * @param {string} fromEmail - Sender email address. * @param {string} fromName - Sender Name. * @param {boolean} isEuRegion - Set as EU region. * @param {string} name - Provider name. * @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email. * @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingUpdateMailgunProvider(providerId: string, apiKey?: string, domain?: string, enabled?: boolean, fromEmail?: string, fromName?: string, isEuRegion?: boolean, name?: string, replyToEmail?: string, replyToName?: string): Promise; /** * Create a new MSG91 provider. * * @param {string} params.name - Provider name. * @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. * @param {string} params.authKey - Msg91 auth key. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.senderId - Msg91 sender ID. * @param {string} params.templateId - Msg91 template ID * @throws {RevenexxException} * @returns {Promise} */ messagingCreateMsg91Provider(params: { name: string; providerId: string; authKey?: string; enabled?: boolean; senderId?: string; templateId?: string; }): Promise; /** * Create a new MSG91 provider. * * @param {string} name - Provider name. * @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. * @param {string} authKey - Msg91 auth key. * @param {boolean} enabled - Set as enabled. * @param {string} senderId - Msg91 sender ID. * @param {string} templateId - Msg91 template ID * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateMsg91Provider(name: string, providerId: string, authKey?: string, enabled?: boolean, senderId?: string, templateId?: string): Promise; /** * Update a MSG91 provider by its unique ID. * * @param {string} params.providerId - Provider ID. * @param {string} params.authKey - Msg91 auth key. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.name - Provider name. * @param {string} params.senderId - Msg91 sender ID. * @param {string} params.templateId - Msg91 template ID. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateMsg91Provider(params: { providerId: string; authKey?: string; enabled?: boolean; name?: string; senderId?: string; templateId?: string; }): Promise; /** * Update a MSG91 provider by its unique ID. * * @param {string} providerId - Provider ID. * @param {string} authKey - Msg91 auth key. * @param {boolean} enabled - Set as enabled. * @param {string} name - Provider name. * @param {string} senderId - Msg91 sender ID. * @param {string} templateId - Msg91 template ID. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingUpdateMsg91Provider(providerId: string, authKey?: string, enabled?: boolean, name?: string, senderId?: string, templateId?: string): Promise; /** * Create a new Resend provider. * * @param {string} params.name - Provider name. * @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. * @param {string} params.apiKey - Resend API key. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.fromEmail - Sender email address. * @param {string} params.fromName - Sender Name. * @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email. * @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateResendProvider(params: { name: string; providerId: string; apiKey?: string; enabled?: boolean; fromEmail?: string; fromName?: string; replyToEmail?: string; replyToName?: string; }): Promise; /** * Create a new Resend provider. * * @param {string} name - Provider name. * @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. * @param {string} apiKey - Resend API key. * @param {boolean} enabled - Set as enabled. * @param {string} fromEmail - Sender email address. * @param {string} fromName - Sender Name. * @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email. * @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateResendProvider(name: string, providerId: string, apiKey?: string, enabled?: boolean, fromEmail?: string, fromName?: string, replyToEmail?: string, replyToName?: string): Promise; /** * Update a Resend provider by its unique ID. * * @param {string} params.providerId - Provider ID. * @param {string} params.apiKey - Resend API key. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.fromEmail - Sender email address. * @param {string} params.fromName - Sender Name. * @param {string} params.name - Provider name. * @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email. * @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateResendProvider(params: { providerId: string; apiKey?: string; enabled?: boolean; fromEmail?: string; fromName?: string; name?: string; replyToEmail?: string; replyToName?: string; }): Promise; /** * Update a Resend provider by its unique ID. * * @param {string} providerId - Provider ID. * @param {string} apiKey - Resend API key. * @param {boolean} enabled - Set as enabled. * @param {string} fromEmail - Sender email address. * @param {string} fromName - Sender Name. * @param {string} name - Provider name. * @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email. * @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingUpdateResendProvider(providerId: string, apiKey?: string, enabled?: boolean, fromEmail?: string, fromName?: string, name?: string, replyToEmail?: string, replyToName?: string): Promise; /** * Create a new Sendgrid provider. * * @param {string} params.name - Provider name. * @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. * @param {string} params.apiKey - Sendgrid API key. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.fromEmail - Sender email address. * @param {string} params.fromName - Sender Name. * @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email. * @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateSendgridProvider(params: { name: string; providerId: string; apiKey?: string; enabled?: boolean; fromEmail?: string; fromName?: string; replyToEmail?: string; replyToName?: string; }): Promise; /** * Create a new Sendgrid provider. * * @param {string} name - Provider name. * @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. * @param {string} apiKey - Sendgrid API key. * @param {boolean} enabled - Set as enabled. * @param {string} fromEmail - Sender email address. * @param {string} fromName - Sender Name. * @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email. * @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateSendgridProvider(name: string, providerId: string, apiKey?: string, enabled?: boolean, fromEmail?: string, fromName?: string, replyToEmail?: string, replyToName?: string): Promise; /** * Update a Sendgrid provider by its unique ID. * * @param {string} params.providerId - Provider ID. * @param {string} params.apiKey - Sendgrid API key. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.fromEmail - Sender email address. * @param {string} params.fromName - Sender Name. * @param {string} params.name - Provider name. * @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email. * @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateSendgridProvider(params: { providerId: string; apiKey?: string; enabled?: boolean; fromEmail?: string; fromName?: string; name?: string; replyToEmail?: string; replyToName?: string; }): Promise; /** * Update a Sendgrid provider by its unique ID. * * @param {string} providerId - Provider ID. * @param {string} apiKey - Sendgrid API key. * @param {boolean} enabled - Set as enabled. * @param {string} fromEmail - Sender email address. * @param {string} fromName - Sender Name. * @param {string} name - Provider name. * @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email. * @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingUpdateSendgridProvider(providerId: string, apiKey?: string, enabled?: boolean, fromEmail?: string, fromName?: string, name?: string, replyToEmail?: string, replyToName?: string): Promise; /** * Create a new Telesign provider. * * @param {string} params.name - Provider name. * @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. * @param {string} params.apiKey - Telesign API key. * @param {string} params.customerId - Telesign customer ID. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateTelesignProvider(params: { name: string; providerId: string; apiKey?: string; customerId?: string; enabled?: boolean; from?: string; }): Promise; /** * Create a new Telesign provider. * * @param {string} name - Provider name. * @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. * @param {string} apiKey - Telesign API key. * @param {string} customerId - Telesign customer ID. * @param {boolean} enabled - Set as enabled. * @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateTelesignProvider(name: string, providerId: string, apiKey?: string, customerId?: string, enabled?: boolean, from?: string): Promise; /** * Update a Telesign provider by its unique ID. * * @param {string} params.providerId - Provider ID. * @param {string} params.apiKey - Telesign API key. * @param {string} params.customerId - Telesign customer ID. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.from - Sender number. * @param {string} params.name - Provider name. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateTelesignProvider(params: { providerId: string; apiKey?: string; customerId?: string; enabled?: boolean; from?: string; name?: string; }): Promise; /** * Update a Telesign provider by its unique ID. * * @param {string} providerId - Provider ID. * @param {string} apiKey - Telesign API key. * @param {string} customerId - Telesign customer ID. * @param {boolean} enabled - Set as enabled. * @param {string} from - Sender number. * @param {string} name - Provider name. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingUpdateTelesignProvider(providerId: string, apiKey?: string, customerId?: string, enabled?: boolean, from?: string, name?: string): Promise; /** * Create a new Textmagic provider. * * @param {string} params.name - Provider name. * @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. * @param {string} params.apiKey - Textmagic apiKey. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. * @param {string} params.username - Textmagic username. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateTextmagicProvider(params: { name: string; providerId: string; apiKey?: string; enabled?: boolean; from?: string; username?: string; }): Promise; /** * Create a new Textmagic provider. * * @param {string} name - Provider name. * @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. * @param {string} apiKey - Textmagic apiKey. * @param {boolean} enabled - Set as enabled. * @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. * @param {string} username - Textmagic username. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateTextmagicProvider(name: string, providerId: string, apiKey?: string, enabled?: boolean, from?: string, username?: string): Promise; /** * Update a Textmagic provider by its unique ID. * * @param {string} params.providerId - Provider ID. * @param {string} params.apiKey - Textmagic apiKey. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.from - Sender number. * @param {string} params.name - Provider name. * @param {string} params.username - Textmagic username. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateTextmagicProvider(params: { providerId: string; apiKey?: string; enabled?: boolean; from?: string; name?: string; username?: string; }): Promise; /** * Update a Textmagic provider by its unique ID. * * @param {string} providerId - Provider ID. * @param {string} apiKey - Textmagic apiKey. * @param {boolean} enabled - Set as enabled. * @param {string} from - Sender number. * @param {string} name - Provider name. * @param {string} username - Textmagic username. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingUpdateTextmagicProvider(providerId: string, apiKey?: string, enabled?: boolean, from?: string, name?: string, username?: string): Promise; /** * Create a new Twilio provider. * * @param {string} params.name - Provider name. * @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. * @param {string} params.accountSid - Twilio account secret ID. * @param {string} params.authToken - Twilio authentication token. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateTwilioProvider(params: { name: string; providerId: string; accountSid?: string; authToken?: string; enabled?: boolean; from?: string; }): Promise; /** * Create a new Twilio provider. * * @param {string} name - Provider name. * @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. * @param {string} accountSid - Twilio account secret ID. * @param {string} authToken - Twilio authentication token. * @param {boolean} enabled - Set as enabled. * @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateTwilioProvider(name: string, providerId: string, accountSid?: string, authToken?: string, enabled?: boolean, from?: string): Promise; /** * Update a Twilio provider by its unique ID. * * @param {string} params.providerId - Provider ID. * @param {string} params.accountSid - Twilio account secret ID. * @param {string} params.authToken - Twilio authentication token. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.from - Sender number. * @param {string} params.name - Provider name. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateTwilioProvider(params: { providerId: string; accountSid?: string; authToken?: string; enabled?: boolean; from?: string; name?: string; }): Promise; /** * Update a Twilio provider by its unique ID. * * @param {string} providerId - Provider ID. * @param {string} accountSid - Twilio account secret ID. * @param {string} authToken - Twilio authentication token. * @param {boolean} enabled - Set as enabled. * @param {string} from - Sender number. * @param {string} name - Provider name. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingUpdateTwilioProvider(providerId: string, accountSid?: string, authToken?: string, enabled?: boolean, from?: string, name?: string): Promise; /** * Create a new Vonage provider. * * @param {string} params.name - Provider name. * @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. * @param {string} params.apiKey - Vonage API key. * @param {string} params.apiSecret - Vonage API secret. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateVonageProvider(params: { name: string; providerId: string; apiKey?: string; apiSecret?: string; enabled?: boolean; from?: string; }): Promise; /** * Create a new Vonage provider. * * @param {string} name - Provider name. * @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. * @param {string} apiKey - Vonage API key. * @param {string} apiSecret - Vonage API secret. * @param {boolean} enabled - Set as enabled. * @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateVonageProvider(name: string, providerId: string, apiKey?: string, apiSecret?: string, enabled?: boolean, from?: string): Promise; /** * Update a Vonage provider by its unique ID. * * @param {string} params.providerId - Provider ID. * @param {string} params.apiKey - Vonage API key. * @param {string} params.apiSecret - Vonage API secret. * @param {boolean} params.enabled - Set as enabled. * @param {string} params.from - Sender number. * @param {string} params.name - Provider name. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateVonageProvider(params: { providerId: string; apiKey?: string; apiSecret?: string; enabled?: boolean; from?: string; name?: string; }): Promise; /** * Update a Vonage provider by its unique ID. * * @param {string} providerId - Provider ID. * @param {string} apiKey - Vonage API key. * @param {string} apiSecret - Vonage API secret. * @param {boolean} enabled - Set as enabled. * @param {string} from - Sender number. * @param {string} name - Provider name. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingUpdateVonageProvider(providerId: string, apiKey?: string, apiSecret?: string, enabled?: boolean, from?: string, name?: string): Promise; /** * Delete a provider by its unique ID. * * @param {string} params.providerId - Provider ID. * @throws {RevenexxException} * @returns {Promise<{}>} */ messagingDeleteProvider(params: { providerId: string; }): Promise<{}>; /** * Delete a provider by its unique ID. * * @param {string} providerId - Provider ID. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ messagingDeleteProvider(providerId: string): Promise<{}>; /** * Get a provider by its unique ID. * * * @param {string} params.providerId - Provider ID. * @throws {RevenexxException} * @returns {Promise} */ messagingGetProvider(params: { providerId: string; }): Promise; /** * Get a provider by its unique ID. * * * @param {string} providerId - Provider ID. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingGetProvider(providerId: string): Promise; /** * Get the provider activity logs listed by its unique ID. * * @param {string} params.providerId - Provider ID. * @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 * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} */ messagingListProviderLogs(params: { providerId: string; queries?: string[]; total?: boolean; }): Promise; /** * Get the provider activity logs listed by its unique ID. * * @param {string} providerId - Provider ID. * @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 * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingListProviderLogs(providerId: string, queries?: string[], total?: boolean): Promise; /** * Get the subscriber activity logs listed by its unique ID. * * @param {string} params.subscriberId - Subscriber ID. * @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 * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} */ messagingListSubscriberLogs(params: { subscriberId: string; queries?: string[]; total?: boolean; }): Promise; /** * Get the subscriber activity logs listed by its unique ID. * * @param {string} subscriberId - Subscriber ID. * @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 * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingListSubscriberLogs(subscriberId: string, queries?: string[], total?: boolean): Promise; /** * Get a list of all topics from the current Revenexx project. * * @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 * @param {string} params.search - Search term to filter your list results. Max length: 256 chars. * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} */ messagingListTopics(params?: { queries?: string[]; search?: string; total?: boolean; }): Promise; /** * Get a list of all topics from the current Revenexx project. * * @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 * @param {string} search - Search term to filter your list results. Max length: 256 chars. * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingListTopics(queries?: string[], search?: string, total?: boolean): Promise; /** * Create a new topic. * * @param {string} params.name - Topic Name. * @param {string} params.topicId - Topic ID. Choose a custom Topic ID or a new Topic ID. * @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. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateTopic(params: { name: string; topicId: string; subscribe?: string[]; }): Promise; /** * Create a new topic. * * @param {string} name - Topic Name. * @param {string} topicId - Topic ID. Choose a custom Topic ID or a new Topic ID. * @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. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateTopic(name: string, topicId: string, subscribe?: string[]): Promise; /** * Delete a topic by its unique ID. * * @param {string} params.topicId - Topic ID. * @throws {RevenexxException} * @returns {Promise<{}>} */ messagingDeleteTopic(params: { topicId: string; }): Promise<{}>; /** * Delete a topic by its unique ID. * * @param {string} topicId - Topic ID. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ messagingDeleteTopic(topicId: string): Promise<{}>; /** * Get a topic by its unique ID. * * * @param {string} params.topicId - Topic ID. * @throws {RevenexxException} * @returns {Promise} */ messagingGetTopic(params: { topicId: string; }): Promise; /** * Get a topic by its unique ID. * * * @param {string} topicId - Topic ID. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingGetTopic(topicId: string): Promise; /** * Update a topic by its unique ID. * * * @param {string} params.topicId - Topic ID. * @param {string} params.name - Topic Name. * @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. * @throws {RevenexxException} * @returns {Promise} */ messagingUpdateTopic(params: { topicId: string; name?: string; subscribe?: string[]; }): Promise; /** * Update a topic by its unique ID. * * * @param {string} topicId - Topic ID. * @param {string} name - Topic Name. * @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. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingUpdateTopic(topicId: string, name?: string, subscribe?: string[]): Promise; /** * Get the topic activity logs listed by its unique ID. * * @param {string} params.topicId - Topic ID. * @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 * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} */ messagingListTopicLogs(params: { topicId: string; queries?: string[]; total?: boolean; }): Promise; /** * Get the topic activity logs listed by its unique ID. * * @param {string} topicId - Topic ID. * @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 * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingListTopicLogs(topicId: string, queries?: string[], total?: boolean): Promise; /** * Get a list of all subscribers from the current Revenexx project. * * @param {string} params.topicId - Topic ID. The topic ID subscribed to. * @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 * @param {string} params.search - Search term to filter your list results. Max length: 256 chars. * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} */ messagingListSubscribers(params: { topicId: string; queries?: string[]; search?: string; total?: boolean; }): Promise; /** * Get a list of all subscribers from the current Revenexx project. * * @param {string} topicId - Topic ID. The topic ID subscribed to. * @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 * @param {string} search - Search term to filter your list results. Max length: 256 chars. * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingListSubscribers(topicId: string, queries?: string[], search?: string, total?: boolean): Promise; /** * Create a new subscriber. * * @param {string} params.topicId - Topic ID. The topic ID to subscribe to. * @param {string} params.subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID. * @param {string} params.targetId - Target ID. The target ID to link to the specified Topic ID. * @throws {RevenexxException} * @returns {Promise} */ messagingCreateSubscriber(params: { topicId: string; subscriberId: string; targetId: string; }): Promise; /** * Create a new subscriber. * * @param {string} topicId - Topic ID. The topic ID to subscribe to. * @param {string} subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID. * @param {string} targetId - Target ID. The target ID to link to the specified Topic ID. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingCreateSubscriber(topicId: string, subscriberId: string, targetId: string): Promise; /** * Delete a subscriber by its unique ID. * * @param {string} params.topicId - Topic ID. The topic ID subscribed to. * @param {string} params.subscriberId - Subscriber ID. * @throws {RevenexxException} * @returns {Promise<{}>} */ messagingDeleteSubscriber(params: { topicId: string; subscriberId: string; }): Promise<{}>; /** * Delete a subscriber by its unique ID. * * @param {string} topicId - Topic ID. The topic ID subscribed to. * @param {string} subscriberId - Subscriber ID. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ messagingDeleteSubscriber(topicId: string, subscriberId: string): Promise<{}>; /** * Get a subscriber by its unique ID. * * * @param {string} params.topicId - Topic ID. The topic ID subscribed to. * @param {string} params.subscriberId - Subscriber ID. * @throws {RevenexxException} * @returns {Promise} */ messagingGetSubscriber(params: { topicId: string; subscriberId: string; }): Promise; /** * Get a subscriber by its unique ID. * * * @param {string} topicId - Topic ID. The topic ID subscribed to. * @param {string} subscriberId - Subscriber ID. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ messagingGetSubscriber(topicId: string, subscriberId: string): Promise; }