node-appwrite 20.1.0 → 20.3.0

package/dist/services/messaging.d.ts

@@ -22,23 +22,26 @@ declare class Messaging {
      *
      * @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 {AppwriteException}
      * @returns {Promise<Models.MessageList>}
      */
     listMessages(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.MessageList>;
     /**
      * Get a list of all messages from the current Appwrite 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 {AppwriteException}
      * @returns {Promise<Models.MessageList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listMessages(queries?: string[], search?: string): Promise<Models.MessageList>;
+    listMessages(queries?: string[], search?: string, total?: boolean): Promise<Models.MessageList>;
     /**
      * Create a new email message.
      *
@@ -492,67 +495,76 @@ declare class Messaging {
      *
      * @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 {AppwriteException}
      * @returns {Promise<Models.LogList>}
      */
     listMessageLogs(params: {
         messageId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.LogList>;
     /**
      * 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 {AppwriteException}
      * @returns {Promise<Models.LogList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listMessageLogs(messageId: string, queries?: string[]): Promise<Models.LogList>;
+    listMessageLogs(messageId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
     /**
      * 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 {AppwriteException}
      * @returns {Promise<Models.TargetList>}
      */
     listTargets(params: {
         messageId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.TargetList>;
     /**
      * 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 {AppwriteException}
      * @returns {Promise<Models.TargetList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTargets(messageId: string, queries?: string[]): Promise<Models.TargetList>;
+    listTargets(messageId: string, queries?: string[], total?: boolean): Promise<Models.TargetList>;
     /**
      * Get a list of all providers from the current Appwrite 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 {AppwriteException}
      * @returns {Promise<Models.ProviderList>}
      */
     listProviders(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.ProviderList>;
     /**
      * Get a list of all providers from the current Appwrite 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 {AppwriteException}
      * @returns {Promise<Models.ProviderList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listProviders(queries?: string[], search?: string): Promise<Models.ProviderList>;
+    listProviders(queries?: string[], search?: string, total?: boolean): Promise<Models.ProviderList>;
     /**
      * Create a new Apple Push Notification service provider.
      *
@@ -989,6 +1001,86 @@ declare class Messaging {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     updateMsg91Provider(providerId: string, name?: string, enabled?: boolean, templateId?: string, senderId?: string, authKey?: string): Promise<Models.Provider>;
+    /**
+     * Create a new Resend provider.
+     *
+     * @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.name - Provider name.
+     * @param {string} params.apiKey - Resend API key.
+     * @param {string} params.fromName - Sender Name.
+     * @param {string} params.fromEmail - Sender email address.
+     * @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
+     * @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
+     * @param {boolean} params.enabled - Set as enabled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Provider>}
+     */
+    createResendProvider(params: {
+        providerId: string;
+        name: string;
+        apiKey?: string;
+        fromName?: string;
+        fromEmail?: string;
+        replyToName?: string;
+        replyToEmail?: string;
+        enabled?: boolean;
+    }): Promise<Models.Provider>;
+    /**
+     * Create a new Resend provider.
+     *
+     * @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} name - Provider name.
+     * @param {string} apiKey - Resend API key.
+     * @param {string} fromName - Sender Name.
+     * @param {string} fromEmail - Sender email address.
+     * @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
+     * @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
+     * @param {boolean} enabled - Set as enabled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Provider>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createResendProvider(providerId: string, name: string, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update a Resend provider by its unique ID.
+     *
+     * @param {string} params.providerId - Provider ID.
+     * @param {string} params.name - Provider name.
+     * @param {boolean} params.enabled - Set as enabled.
+     * @param {string} params.apiKey - Resend API key.
+     * @param {string} params.fromName - Sender Name.
+     * @param {string} params.fromEmail - Sender email address.
+     * @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
+     * @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Provider>}
+     */
+    updateResendProvider(params: {
+        providerId: string;
+        name?: string;
+        enabled?: boolean;
+        apiKey?: string;
+        fromName?: string;
+        fromEmail?: string;
+        replyToName?: string;
+        replyToEmail?: string;
+    }): Promise<Models.Provider>;
+    /**
+     * Update a Resend provider by its unique ID.
+     *
+     * @param {string} providerId - Provider ID.
+     * @param {string} name - Provider name.
+     * @param {boolean} enabled - Set as enabled.
+     * @param {string} apiKey - Resend API key.
+     * @param {string} fromName - Sender Name.
+     * @param {string} fromEmail - Sender email address.
+     * @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
+     * @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Provider>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateResendProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
     /**
      * Create a new Sendgrid provider.
      *
@@ -1620,67 +1712,76 @@ declare class Messaging {
      *
      * @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 {AppwriteException}
      * @returns {Promise<Models.LogList>}
      */
     listProviderLogs(params: {
         providerId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.LogList>;
     /**
      * 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 {AppwriteException}
      * @returns {Promise<Models.LogList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listProviderLogs(providerId: string, queries?: string[]): Promise<Models.LogList>;
+    listProviderLogs(providerId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
     /**
      * 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 {AppwriteException}
      * @returns {Promise<Models.LogList>}
      */
     listSubscriberLogs(params: {
         subscriberId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.LogList>;
     /**
      * 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 {AppwriteException}
      * @returns {Promise<Models.LogList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listSubscriberLogs(subscriberId: string, queries?: string[]): Promise<Models.LogList>;
+    listSubscriberLogs(subscriberId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
     /**
      * Get a list of all topics from the current Appwrite 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 {AppwriteException}
      * @returns {Promise<Models.TopicList>}
      */
     listTopics(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.TopicList>;
     /**
      * Get a list of all topics from the current Appwrite 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 {AppwriteException}
      * @returns {Promise<Models.TopicList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTopics(queries?: string[], search?: string): Promise<Models.TopicList>;
+    listTopics(queries?: string[], search?: string, total?: boolean): Promise<Models.TopicList>;
     /**
      * Create a new topic.
      *
@@ -1778,29 +1879,33 @@ declare class Messaging {
      *
      * @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 {AppwriteException}
      * @returns {Promise<Models.LogList>}
      */
     listTopicLogs(params: {
         topicId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.LogList>;
     /**
      * 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 {AppwriteException}
      * @returns {Promise<Models.LogList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTopicLogs(topicId: string, queries?: string[]): Promise<Models.LogList>;
+    listTopicLogs(topicId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
     /**
      * Get a list of all subscribers from the current Appwrite 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 {AppwriteException}
      * @returns {Promise<Models.SubscriberList>}
      */
@@ -1808,6 +1913,7 @@ declare class Messaging {
         topicId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.SubscriberList>;
     /**
      * Get a list of all subscribers from the current Appwrite project.
@@ -1815,11 +1921,12 @@ declare class Messaging {
      * @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 {AppwriteException}
      * @returns {Promise<Models.SubscriberList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listSubscribers(topicId: string, queries?: string[], search?: string): Promise<Models.SubscriberList>;
+    listSubscribers(topicId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.SubscriberList>;
     /**
      * Create a new subscriber.
      *