@appwrite.io/console 1.5.2 → 1.6.0

package/types/services/messaging.d.ts

@@ -6,8 +6,6 @@ export declare class Messaging {
     client: Client;
     constructor(client: Client);
     /**
-     * List messages
-     *
      * Get a list of all messages from the current Appwrite project.
      *
      * @param {string[]} queries
@@ -17,8 +15,6 @@ export declare class Messaging {
      */
     listMessages(queries?: string[], search?: string): Promise<Models.MessageList>;
     /**
-     * Create email
-     *
      * Create a new email message.
      *
      * @param {string} messageId
@@ -38,8 +34,6 @@ export declare class Messaging {
      */
     createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], attachments?: string[], draft?: boolean, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
-     * Update email
-     *
      * 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.
 
      *
@@ -60,8 +54,6 @@ export declare class Messaging {
      */
     updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, draft?: boolean, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string, attachments?: string[]): Promise<Models.Message>;
     /**
-     * Create push notification
-     *
      * Create a new push notification.
      *
      * @param {string} messageId
@@ -88,8 +80,6 @@ export declare class Messaging {
      */
     createPush(messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message>;
     /**
-     * Update push notification
-     *
      * 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.
 
      *
@@ -117,8 +107,6 @@ export declare class Messaging {
      */
     updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message>;
     /**
-     * Create SMS
-     *
      * Create a new SMS message.
      *
      * @param {string} messageId
@@ -133,8 +121,6 @@ export declare class Messaging {
      */
     createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
-     * Update SMS
-     *
      * Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
 
      *
@@ -150,8 +136,6 @@ export declare class Messaging {
      */
     updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
-     * Get message
-     *
      * Get a message by its unique ID.
 
      *
@@ -161,8 +145,6 @@ export declare class Messaging {
      */
     getMessage(messageId: string): Promise<Models.Message>;
     /**
-     * Delete message
-     *
      * 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
@@ -171,8 +153,6 @@ export declare class Messaging {
      */
     delete(messageId: string): Promise<{}>;
     /**
-     * List message logs
-     *
      * Get the message activity logs listed by its unique ID.
      *
      * @param {string} messageId
@@ -182,8 +162,6 @@ export declare class Messaging {
      */
     listMessageLogs(messageId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List message targets
-     *
      * Get a list of the targets associated with a message.
      *
      * @param {string} messageId
@@ -193,8 +171,6 @@ export declare class Messaging {
      */
     listTargets(messageId: string, queries?: string[]): Promise<Models.TargetList>;
     /**
-     * List providers
-     *
      * Get a list of all providers from the current Appwrite project.
      *
      * @param {string[]} queries
@@ -204,8 +180,6 @@ export declare class Messaging {
      */
     listProviders(queries?: string[], search?: string): Promise<Models.ProviderList>;
     /**
-     * Create APNS provider
-     *
      * Create a new Apple Push Notification service provider.
      *
      * @param {string} providerId
@@ -221,8 +195,6 @@ export declare class Messaging {
      */
     createApnsProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update APNS provider
-     *
      * Update a Apple Push Notification service provider by its unique ID.
      *
      * @param {string} providerId
@@ -238,8 +210,6 @@ export declare class Messaging {
      */
     updateApnsProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean): Promise<Models.Provider>;
     /**
-     * Create FCM provider
-     *
      * Create a new Firebase Cloud Messaging provider.
      *
      * @param {string} providerId
@@ -251,8 +221,6 @@ export declare class Messaging {
      */
     createFcmProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update FCM provider
-     *
      * Update a Firebase Cloud Messaging provider by its unique ID.
      *
      * @param {string} providerId
@@ -264,8 +232,6 @@ export declare class Messaging {
      */
     updateFcmProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
     /**
-     * Create Mailgun provider
-     *
      * Create a new Mailgun provider.
      *
      * @param {string} providerId
@@ -283,8 +249,6 @@ export declare class Messaging {
      */
     createMailgunProvider(providerId: string, name: string, apiKey?: string, domain?: string, isEuRegion?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update Mailgun provider
-     *
      * Update a Mailgun provider by its unique ID.
      *
      * @param {string} providerId
@@ -302,8 +266,6 @@ export declare class Messaging {
      */
     updateMailgunProvider(providerId: string, name?: string, apiKey?: string, domain?: string, isEuRegion?: boolean, enabled?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
     /**
-     * Create Msg91 provider
-     *
      * Create a new MSG91 provider.
      *
      * @param {string} providerId
@@ -317,8 +279,6 @@ export declare class Messaging {
      */
     createMsg91Provider(providerId: string, name: string, templateId?: string, senderId?: string, authKey?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update Msg91 provider
-     *
      * Update a MSG91 provider by its unique ID.
      *
      * @param {string} providerId
@@ -332,8 +292,6 @@ export declare class Messaging {
      */
     updateMsg91Provider(providerId: string, name?: string, enabled?: boolean, templateId?: string, senderId?: string, authKey?: string): Promise<Models.Provider>;
     /**
-     * Create Sendgrid provider
-     *
      * Create a new Sendgrid provider.
      *
      * @param {string} providerId
@@ -349,8 +307,6 @@ export declare class Messaging {
      */
     createSendgridProvider(providerId: string, name: string, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update Sendgrid provider
-     *
      * Update a Sendgrid provider by its unique ID.
      *
      * @param {string} providerId
@@ -366,8 +322,6 @@ export declare class Messaging {
      */
     updateSendgridProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
     /**
-     * Create SMTP provider
-     *
      * Create a new SMTP provider.
      *
      * @param {string} providerId
@@ -389,8 +343,6 @@ export declare class Messaging {
      */
     createSmtpProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update SMTP provider
-     *
      * Update a SMTP provider by its unique ID.
      *
      * @param {string} providerId
@@ -412,8 +364,6 @@ export declare class Messaging {
      */
     updateSmtpProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Create Telesign provider
-     *
      * Create a new Telesign provider.
      *
      * @param {string} providerId
@@ -427,8 +377,6 @@ export declare class Messaging {
      */
     createTelesignProvider(providerId: string, name: string, from?: string, customerId?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update Telesign provider
-     *
      * Update a Telesign provider by its unique ID.
      *
      * @param {string} providerId
@@ -442,8 +390,6 @@ export declare class Messaging {
      */
     updateTelesignProvider(providerId: string, name?: string, enabled?: boolean, customerId?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
     /**
-     * Create Textmagic provider
-     *
      * Create a new Textmagic provider.
      *
      * @param {string} providerId
@@ -457,8 +403,6 @@ export declare class Messaging {
      */
     createTextmagicProvider(providerId: string, name: string, from?: string, username?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update Textmagic provider
-     *
      * Update a Textmagic provider by its unique ID.
      *
      * @param {string} providerId
@@ -472,8 +416,6 @@ export declare class Messaging {
      */
     updateTextmagicProvider(providerId: string, name?: string, enabled?: boolean, username?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
     /**
-     * Create Twilio provider
-     *
      * Create a new Twilio provider.
      *
      * @param {string} providerId
@@ -487,8 +429,6 @@ export declare class Messaging {
      */
     createTwilioProvider(providerId: string, name: string, from?: string, accountSid?: string, authToken?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update Twilio provider
-     *
      * Update a Twilio provider by its unique ID.
      *
      * @param {string} providerId
@@ -502,8 +442,6 @@ export declare class Messaging {
      */
     updateTwilioProvider(providerId: string, name?: string, enabled?: boolean, accountSid?: string, authToken?: string, from?: string): Promise<Models.Provider>;
     /**
-     * Create Vonage provider
-     *
      * Create a new Vonage provider.
      *
      * @param {string} providerId
@@ -517,8 +455,6 @@ export declare class Messaging {
      */
     createVonageProvider(providerId: string, name: string, from?: string, apiKey?: string, apiSecret?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
-     * Update Vonage provider
-     *
      * Update a Vonage provider by its unique ID.
      *
      * @param {string} providerId
@@ -532,8 +468,6 @@ export declare class Messaging {
      */
     updateVonageProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, apiSecret?: string, from?: string): Promise<Models.Provider>;
     /**
-     * Get provider
-     *
      * Get a provider by its unique ID.
 
      *
@@ -543,8 +477,6 @@ export declare class Messaging {
      */
     getProvider(providerId: string): Promise<Models.Provider>;
     /**
-     * Delete provider
-     *
      * Delete a provider by its unique ID.
      *
      * @param {string} providerId
@@ -553,8 +485,6 @@ export declare class Messaging {
      */
     deleteProvider(providerId: string): Promise<{}>;
     /**
-     * List provider logs
-     *
      * Get the provider activity logs listed by its unique ID.
      *
      * @param {string} providerId
@@ -564,8 +494,6 @@ export declare class Messaging {
      */
     listProviderLogs(providerId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List subscriber logs
-     *
      * Get the subscriber activity logs listed by its unique ID.
      *
      * @param {string} subscriberId
@@ -575,8 +503,6 @@ export declare class Messaging {
      */
     listSubscriberLogs(subscriberId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List topics
-     *
      * Get a list of all topics from the current Appwrite project.
      *
      * @param {string[]} queries
@@ -586,8 +512,6 @@ export declare class Messaging {
      */
     listTopics(queries?: string[], search?: string): Promise<Models.TopicList>;
     /**
-     * Create topic
-     *
      * Create a new topic.
      *
      * @param {string} topicId
@@ -598,8 +522,6 @@ export declare class Messaging {
      */
     createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
     /**
-     * Get topic
-     *
      * Get a topic by its unique ID.
 
      *
@@ -609,8 +531,6 @@ export declare class Messaging {
      */
     getTopic(topicId: string): Promise<Models.Topic>;
     /**
-     * Update topic
-     *
      * Update a topic by its unique ID.
 
      *
@@ -622,8 +542,6 @@ export declare class Messaging {
      */
     updateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic>;
     /**
-     * Delete topic
-     *
      * Delete a topic by its unique ID.
      *
      * @param {string} topicId
@@ -632,8 +550,6 @@ export declare class Messaging {
      */
     deleteTopic(topicId: string): Promise<{}>;
     /**
-     * List topic logs
-     *
      * Get the topic activity logs listed by its unique ID.
      *
      * @param {string} topicId
@@ -643,8 +559,6 @@ export declare class Messaging {
      */
     listTopicLogs(topicId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List subscribers
-     *
      * Get a list of all subscribers from the current Appwrite project.
      *
      * @param {string} topicId
@@ -655,8 +569,6 @@ export declare class Messaging {
      */
     listSubscribers(topicId: string, queries?: string[], search?: string): Promise<Models.SubscriberList>;
     /**
-     * Create subscriber
-     *
      * Create a new subscriber.
      *
      * @param {string} topicId
@@ -667,8 +579,6 @@ export declare class Messaging {
      */
     createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
     /**
-     * Get subscriber
-     *
      * Get a subscriber by its unique ID.
 
      *
@@ -679,8 +589,6 @@ export declare class Messaging {
      */
     getSubscriber(topicId: string, subscriberId: string): Promise<Models.Subscriber>;
     /**
-     * Delete subscriber
-     *
      * Delete a subscriber by its unique ID.
      *
      * @param {string} topicId

package/types/services/migrations.d.ts

@@ -4,8 +4,6 @@ export declare class Migrations {
     client: Client;
     constructor(client: Client);
     /**
-     * List migrations
-     *
      * List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
      *
      * @param {string[]} queries
@@ -15,8 +13,6 @@ export declare class Migrations {
      */
     list(queries?: string[], search?: string): Promise<Models.MigrationList>;
     /**
-     * Migrate Appwrite data
-     *
      * Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
      *
      * @param {string[]} resources
@@ -28,8 +24,6 @@ export declare class Migrations {
      */
     createAppwriteMigration(resources: string[], endpoint: string, projectId: string, apiKey: string): Promise<Models.Migration>;
     /**
-     * Generate a report on Appwrite data
-     *
      * Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
@@ -41,8 +35,6 @@ export declare class Migrations {
      */
     getAppwriteReport(resources: string[], endpoint: string, projectID: string, key: string): Promise<Models.MigrationReport>;
     /**
-     * Migrate Firebase data
-     *
      * Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
      *
      * @param {string[]} resources
@@ -52,8 +44,6 @@ export declare class Migrations {
      */
     createFirebaseMigration(resources: string[], serviceAccount: string): Promise<Models.Migration>;
     /**
-     * Generate a report on Firebase data
-     *
      * Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
@@ -63,8 +53,6 @@ export declare class Migrations {
      */
     getFirebaseReport(resources: string[], serviceAccount: string): Promise<Models.MigrationReport>;
     /**
-     * Migrate NHost data
-     *
      * Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
      *
      * @param {string[]} resources
@@ -80,8 +68,6 @@ export declare class Migrations {
      */
     createNHostMigration(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.Migration>;
     /**
-     * Generate a report on NHost Data
-     *
      * Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
@@ -97,8 +83,6 @@ export declare class Migrations {
      */
     getNHostReport(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
     /**
-     * Migrate Supabase data
-     *
      * Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
      *
      * @param {string[]} resources
@@ -113,8 +97,6 @@ export declare class Migrations {
      */
     createSupabaseMigration(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.Migration>;
     /**
-     * Generate a report on Supabase Data
-     *
      * Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
@@ -129,8 +111,6 @@ export declare class Migrations {
      */
     getSupabaseReport(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
     /**
-     * Get migration
-     *
      * Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process.
      *
      * @param {string} migrationId
@@ -139,8 +119,6 @@ export declare class Migrations {
      */
     get(migrationId: string): Promise<Models.Migration>;
     /**
-     * Retry migration
-     *
      * Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.
      *
      * @param {string} migrationId
@@ -149,8 +127,6 @@ export declare class Migrations {
      */
     retry(migrationId: string): Promise<Models.Migration>;
     /**
-     * Delete migration
-     *
      * Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project&#039;s migration history.
      *
      * @param {string} migrationId