@appwrite.io/console 0.5.0 → 0.6.0-rc.10

package/types/services/messaging.d.ts

@@ -0,0 +1,627 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+import { MessageStatus } from '../enums/message-status';
+import { SMTPEncryption } from '../enums/s-m-t-p-encryption';
+export declare class Messaging extends Service {
+    constructor(client: Client);
+    /**
+     * List messages
+     *
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listMessages(queries?: string[], search?: string): Promise<Models.MessageList>;
+    /**
+     * Create an email.
+     *
+     *
+     * @param {string} messageId
+     * @param {string} subject
+     * @param {string} content
+     * @param {string[]} topics
+     * @param {string[]} users
+     * @param {string[]} targets
+     * @param {string[]} cc
+     * @param {string[]} bcc
+     * @param {MessageStatus} status
+     * @param {boolean} html
+     * @param {string} scheduledAt
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], status?: MessageStatus, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
+    /**
+     * Update an email.
+     *
+     *
+     * @param {string} messageId
+     * @param {string[]} topics
+     * @param {string[]} users
+     * @param {string[]} targets
+     * @param {string} subject
+     * @param {string} content
+     * @param {MessageStatus} status
+     * @param {boolean} html
+     * @param {string[]} cc
+     * @param {string[]} bcc
+     * @param {string} scheduledAt
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, status?: MessageStatus, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string): Promise<Models.Message>;
+    /**
+     * Create a push notification.
+     *
+     *
+     * @param {string} messageId
+     * @param {string} title
+     * @param {string} body
+     * @param {string[]} topics
+     * @param {string[]} users
+     * @param {string[]} targets
+     * @param {object} data
+     * @param {string} action
+     * @param {string} icon
+     * @param {string} sound
+     * @param {string} color
+     * @param {string} tag
+     * @param {string} badge
+     * @param {MessageStatus} status
+     * @param {string} scheduledAt
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createPush(messageId: string, title: string, body: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: string, status?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
+    /**
+     * Update a push notification.
+     *
+     *
+     * @param {string} messageId
+     * @param {string[]} topics
+     * @param {string[]} users
+     * @param {string[]} targets
+     * @param {string} title
+     * @param {string} body
+     * @param {object} data
+     * @param {string} action
+     * @param {string} icon
+     * @param {string} sound
+     * @param {string} color
+     * @param {string} tag
+     * @param {number} badge
+     * @param {MessageStatus} status
+     * @param {string} scheduledAt
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, status?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
+    /**
+     * Create an SMS.
+     *
+     *
+     * @param {string} messageId
+     * @param {string} content
+     * @param {string[]} topics
+     * @param {string[]} users
+     * @param {string[]} targets
+     * @param {MessageStatus} status
+     * @param {string} scheduledAt
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createSMS(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], status?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
+    /**
+     * Update an SMS.
+     *
+     *
+     * @param {string} messageId
+     * @param {string[]} topics
+     * @param {string[]} users
+     * @param {string[]} targets
+     * @param {string} content
+     * @param {MessageStatus} status
+     * @param {string} scheduledAt
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateSMS(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, status?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
+    /**
+     * Get a message
+     *
+     *
+     * @param {string} messageId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getMessage(messageId: string): Promise<Models.Message>;
+    /**
+     * Delete a message
+     *
+     *
+     * @param {string} messageId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    delete(messageId: string): Promise<{}>;
+    /**
+     * List message logs
+     *
+     *
+     * @param {string} messageId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listMessageLogs(messageId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * List message targets
+     *
+     * List the targets associated with a message as set via the targets
+     * attribute.
+     *
+     * @param {string} messageId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listTargets(messageId: string, queries?: string[]): Promise<Models.TargetList>;
+    /**
+     * List providers
+     *
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listProviders(queries?: string[], search?: string): Promise<Models.ProviderList>;
+    /**
+     * Create APNS provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} authKey
+     * @param {string} authKeyId
+     * @param {string} teamId
+     * @param {string} bundleId
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createAPNSProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update APNS provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {boolean} enabled
+     * @param {string} authKey
+     * @param {string} authKeyId
+     * @param {string} teamId
+     * @param {string} bundleId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateAPNSProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string): Promise<Models.Provider>;
+    /**
+     * Create FCM provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {object} serviceAccountJSON
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createFCMProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update FCM provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {boolean} enabled
+     * @param {object} serviceAccountJSON
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateFCMProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
+    /**
+     * Create Mailgun provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} apiKey
+     * @param {string} domain
+     * @param {boolean} isEuRegion
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    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
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} apiKey
+     * @param {string} domain
+     * @param {boolean} isEuRegion
+     * @param {boolean} enabled
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    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
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} from
+     * @param {string} senderId
+     * @param {string} authKey
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createMsg91Provider(providerId: string, name: string, from?: string, senderId?: string, authKey?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update Msg91 provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {boolean} enabled
+     * @param {string} senderId
+     * @param {string} authKey
+     * @param {string} from
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateMsg91Provider(providerId: string, name?: string, enabled?: boolean, senderId?: string, authKey?: string, from?: string): Promise<Models.Provider>;
+    /**
+     * Create Sendgrid provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} apiKey
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createSendgridProvider(providerId: string, name: string, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update Sendgrid provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {boolean} enabled
+     * @param {string} apiKey
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateSendgridProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
+    /**
+     * Create SMTP provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} host
+     * @param {number} port
+     * @param {string} username
+     * @param {string} password
+     * @param {SMTPEncryption} encryption
+     * @param {boolean} autoTLS
+     * @param {string} mailer
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    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
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} host
+     * @param {number} port
+     * @param {string} username
+     * @param {string} password
+     * @param {SMTPEncryption} encryption
+     * @param {boolean} autoTLS
+     * @param {string} mailer
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    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
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} from
+     * @param {string} customerId
+     * @param {string} apiKey
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createTelesignProvider(providerId: string, name: string, from?: string, customerId?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update Telesign provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {boolean} enabled
+     * @param {string} customerId
+     * @param {string} apiKey
+     * @param {string} from
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateTelesignProvider(providerId: string, name?: string, enabled?: boolean, customerId?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
+    /**
+     * Create Textmagic provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} from
+     * @param {string} username
+     * @param {string} apiKey
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createTextmagicProvider(providerId: string, name: string, from?: string, username?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update Textmagic provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {boolean} enabled
+     * @param {string} username
+     * @param {string} apiKey
+     * @param {string} from
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateTextmagicProvider(providerId: string, name?: string, enabled?: boolean, username?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
+    /**
+     * Create Twilio provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} from
+     * @param {string} accountSid
+     * @param {string} authToken
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createTwilioProvider(providerId: string, name: string, from?: string, accountSid?: string, authToken?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update Twilio provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {boolean} enabled
+     * @param {string} accountSid
+     * @param {string} authToken
+     * @param {string} from
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateTwilioProvider(providerId: string, name?: string, enabled?: boolean, accountSid?: string, authToken?: string, from?: string): Promise<Models.Provider>;
+    /**
+     * Create Vonage provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} from
+     * @param {string} apiKey
+     * @param {string} apiSecret
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createVonageProvider(providerId: string, name: string, from?: string, apiKey?: string, apiSecret?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update Vonage provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {boolean} enabled
+     * @param {string} apiKey
+     * @param {string} apiSecret
+     * @param {string} from
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateVonageProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, apiSecret?: string, from?: string): Promise<Models.Provider>;
+    /**
+     * Get provider
+     *
+     *
+     * @param {string} providerId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getProvider(providerId: string): Promise<Models.Provider>;
+    /**
+     * Delete provider
+     *
+     *
+     * @param {string} providerId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteProvider(providerId: string): Promise<{}>;
+    /**
+     * List provider logs
+     *
+     *
+     * @param {string} providerId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listProviderLogs(providerId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * List subscriber logs
+     *
+     *
+     * @param {string} subscriberId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listSubscriberLogs(subscriberId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * List topics.
+     *
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listTopics(queries?: string[], search?: string): Promise<Models.TopicList>;
+    /**
+     * Create a topic.
+     *
+     *
+     * @param {string} topicId
+     * @param {string} name
+     * @param {string[]} subscribe
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
+    /**
+     * Get a topic.
+     *
+     *
+     * @param {string} topicId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getTopic(topicId: string): Promise<Models.Topic>;
+    /**
+     * Update a topic.
+     *
+     *
+     * @param {string} topicId
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateTopic(topicId: string, name?: string): Promise<Models.Topic>;
+    /**
+     * Delete a topic.
+     *
+     *
+     * @param {string} topicId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteTopic(topicId: string): Promise<{}>;
+    /**
+     * List topic logs
+     *
+     *
+     * @param {string} topicId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listTopicLogs(topicId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * List subscribers.
+     *
+     *
+     * @param {string} topicId
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listSubscribers(topicId: string, queries?: string[], search?: string): Promise<Models.SubscriberList>;
+    /**
+     * Create a subscriber.
+     *
+     *
+     * @param {string} topicId
+     * @param {string} subscriberId
+     * @param {string} targetId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
+    /**
+     * Get a subscriber.
+     *
+     *
+     * @param {string} topicId
+     * @param {string} subscriberId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getSubscriber(topicId: string, subscriberId: string): Promise<Models.Subscriber>;
+    /**
+     * Delete a subscriber.
+     *
+     *
+     * @param {string} topicId
+     * @param {string} subscriberId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteSubscriber(topicId: string, subscriberId: string): Promise<{}>;
+}

package/types/services/migrations.d.ts

@@ -7,12 +7,12 @@ export declare class Migrations extends Service {
      * List Migrations
      *
      *
-     * @param {string} queries
+     * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    list(queries?: string, search?: string): Promise<Models.MigrationList>;
+    list(queries?: string[], search?: string): Promise<Models.MigrationList>;
     /**
      * Migrate Appwrite Data
      *

package/types/services/project.d.ts

@@ -1,6 +1,7 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { ProjectUsageRange } from '../enums/project-usage-range';
 export declare class Project extends Service {
     constructor(client: Client);
     /**
@@ -9,11 +10,11 @@ export declare class Project extends Service {
      *
      * @param {string} startDate
      * @param {string} endDate
-     * @param {string} period
+     * @param {ProjectUsageRange} period
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(startDate: string, endDate: string, period?: string): Promise<Models.UsageProject>;
+    getUsage(startDate: string, endDate: string, period?: ProjectUsageRange): Promise<Models.UsageProject>;
     /**
      * List Variables
      *