@appwrite.io/console 1.5.2 → 1.6.0

package/types/services/backups.d.ts

@@ -4,8 +4,6 @@ export declare class Backups {
     client: Client;
     constructor(client: Client);
     /**
-     * List archives
-     *
      * List all archives for a project.
      *
      * @param {string[]} queries
@@ -14,8 +12,6 @@ export declare class Backups {
      */
     listArchives(queries?: string[]): Promise<Models.BackupArchiveList>;
     /**
-     * Create archive
-     *
      * Create a new archive asynchronously for a project.
      *
      * @param {string[]} services
@@ -25,8 +21,6 @@ export declare class Backups {
      */
     createArchive(services: string[], resourceId?: string): Promise<Models.BackupArchive>;
     /**
-     * Get backup archive
-     *
      * Get a backup archive using it&#039;s ID.
      *
      * @param {string} archiveId
@@ -35,8 +29,6 @@ export declare class Backups {
      */
     getArchive(archiveId: string): Promise<Models.BackupArchive>;
     /**
-     * Delete archive
-     *
      * Delete an existing archive for a project.
      *
      * @param {string} archiveId
@@ -45,8 +37,6 @@ export declare class Backups {
      */
     deleteArchive(archiveId: string): Promise<{}>;
     /**
-     * List backup policies
-     *
      * List all policies for a project.
      *
      * @param {string[]} queries
@@ -55,8 +45,6 @@ export declare class Backups {
      */
     listPolicies(queries?: string[]): Promise<Models.BackupPolicyList>;
     /**
-     * Create backup policy
-     *
      * Create a new backup policy.
      *
      * @param {string} policyId
@@ -71,8 +59,6 @@ export declare class Backups {
      */
     createPolicy(policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
     /**
-     * Get backup policy
-     *
      * Get a backup policy using it&#039;s ID.
      *
      * @param {string} policyId
@@ -81,8 +67,6 @@ export declare class Backups {
      */
     getPolicy(policyId: string): Promise<Models.BackupPolicy>;
     /**
-     * Update backup policy
-     *
      * Update an existing policy using it&#039;s ID.
      *
      * @param {string} policyId
@@ -95,8 +79,6 @@ export declare class Backups {
      */
     updatePolicy(policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
     /**
-     * Delete backup policy
-     *
      * Delete a policy using it&#039;s ID.
      *
      * @param {string} policyId
@@ -105,8 +87,6 @@ export declare class Backups {
      */
     deletePolicy(policyId: string): Promise<{}>;
     /**
-     * Create restoration
-     *
      * Create and trigger a new restoration for a backup on a project.
      *
      * @param {string} archiveId
@@ -118,8 +98,6 @@ export declare class Backups {
      */
     createRestoration(archiveId: string, services: string[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
     /**
-     * List restorations
-     *
      * List all backup restorations for a project.
      *
      * @param {string[]} queries
@@ -128,8 +106,6 @@ export declare class Backups {
      */
     listRestorations(queries?: string[]): Promise<Models.BackupRestorationList>;
     /**
-     * Get backup restoration
-     *
      * Get the current status of a backup restoration.
      *
      * @param {string} restorationId

package/types/services/console.d.ts

@@ -4,8 +4,6 @@ export declare class Console {
     client: Client;
     constructor(client: Client);
     /**
-     * Get campaign details
-     *
      * Recieve the details of a compaign using it's ID.
      *
      * @param {string} campaignId
@@ -14,8 +12,6 @@ export declare class Console {
      */
     getCampaign(campaignId: string): Promise<Models.Campaign>;
     /**
-     * Get coupon details
-     *
      * Get the details of a coupon using it&#039;s coupon ID.
      *
      * @param {string} couponId
@@ -24,8 +20,6 @@ export declare class Console {
      */
     getCoupon(couponId: string): Promise<Models.Coupon>;
     /**
-     * Get plans
-     *
      * Return a list of all available plans.
      *
      * @throws {AppwriteException}
@@ -33,8 +27,6 @@ export declare class Console {
      */
     plans(): Promise<Models.BillingPlanList>;
     /**
-     * Create program membership
-     *
      * Create a new membership for an account to a program.
      *
      * @param {string} programId
@@ -43,8 +35,6 @@ export declare class Console {
      */
     createProgramMembership<Preferences extends Models.Preferences>(programId: string): Promise<Models.Organization<Preferences>>;
     /**
-     * Get Regions
-     *
      * Get all available regions for the console.
      *
      * @throws {AppwriteException}
@@ -52,8 +42,6 @@ export declare class Console {
      */
     regions(): Promise<Models.ConsoleRegionList>;
     /**
-     * Create source
-     *
      * Create a new source.
      *
      * @param {string} ref
@@ -66,8 +54,6 @@ export declare class Console {
      */
     createSource(ref?: string, referrer?: string, utmSource?: string, utmCampaign?: string, utmMedium?: string): Promise<{}>;
     /**
-     * Get variables
-     *
      * Get all Environment Variables that are relevant for the console.
      *
      * @throws {AppwriteException}

package/types/services/databases.d.ts

@@ -8,8 +8,6 @@ export declare class Databases {
     client: Client;
     constructor(client: Client);
     /**
-     * List databases
-     *
      * Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.
      *
      * @param {string[]} queries
@@ -19,8 +17,6 @@ export declare class Databases {
      */
     list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
     /**
-     * Create database
-     *
      * Create a new Database.
 
      *
@@ -32,8 +28,6 @@ export declare class Databases {
      */
     create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
     /**
-     * Get databases usage stats
-     *
      * Get usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
      *
      * @param {DatabaseUsageRange} range
@@ -42,8 +36,6 @@ export declare class Databases {
      */
     getUsage(range?: DatabaseUsageRange): Promise<Models.UsageDatabases>;
     /**
-     * Get database
-     *
      * Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.
      *
      * @param {string} databaseId
@@ -52,8 +44,6 @@ export declare class Databases {
      */
     get(databaseId: string): Promise<Models.Database>;
     /**
-     * Update database
-     *
      * Update a database by its unique ID.
      *
      * @param {string} databaseId
@@ -64,8 +54,6 @@ export declare class Databases {
      */
     update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
     /**
-     * Delete database
-     *
      * Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
      *
      * @param {string} databaseId
@@ -74,8 +62,6 @@ export declare class Databases {
      */
     delete(databaseId: string): Promise<{}>;
     /**
-     * List collections
-     *
      * Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.
      *
      * @param {string} databaseId
@@ -86,8 +72,6 @@ export declare class Databases {
      */
     listCollections(databaseId: string, queries?: string[], search?: string): Promise<Models.CollectionList>;
     /**
-     * Create collection
-     *
      * Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
      * @param {string} databaseId
@@ -101,8 +85,6 @@ export declare class Databases {
      */
     createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
     /**
-     * Get collection
-     *
      * Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.
      *
      * @param {string} databaseId
@@ -112,8 +94,6 @@ export declare class Databases {
      */
     getCollection(databaseId: string, collectionId: string): Promise<Models.Collection>;
     /**
-     * Update collection
-     *
      * Update a collection by its unique ID.
      *
      * @param {string} databaseId
@@ -127,8 +107,6 @@ export declare class Databases {
      */
     updateCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
     /**
-     * Delete collection
-     *
      * Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
      *
      * @param {string} databaseId
@@ -138,8 +116,6 @@ export declare class Databases {
      */
     deleteCollection(databaseId: string, collectionId: string): Promise<{}>;
     /**
-     * List attributes
-     *
      * List attributes in the collection.
      *
      * @param {string} databaseId
@@ -150,8 +126,6 @@ export declare class Databases {
      */
     listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
     /**
-     * Create boolean attribute
-     *
      * Create a boolean attribute.
 
      *
@@ -166,8 +140,6 @@ export declare class Databases {
      */
     createBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, array?: boolean): Promise<Models.AttributeBoolean>;
     /**
-     * Update boolean attribute
-     *
      * Update a boolean attribute. Changing the `default` value will not update already existing documents.
      *
      * @param {string} databaseId
@@ -181,8 +153,6 @@ export declare class Databases {
      */
     updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, newKey?: string): Promise<Models.AttributeBoolean>;
     /**
-     * Create datetime attribute
-     *
      * Create a date time attribute according to the ISO 8601 standard.
      *
      * @param {string} databaseId
@@ -196,8 +166,6 @@ export declare class Databases {
      */
     createDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeDatetime>;
     /**
-     * Update dateTime attribute
-     *
      * Update a date time attribute. Changing the `default` value will not update already existing documents.
      *
      * @param {string} databaseId
@@ -211,8 +179,6 @@ export declare class Databases {
      */
     updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeDatetime>;
     /**
-     * Create email attribute
-     *
      * Create an email attribute.
 
      *
@@ -227,8 +193,6 @@ export declare class Databases {
      */
     createEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEmail>;
     /**
-     * Update email attribute
-     *
      * Update an email attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -243,8 +207,6 @@ export declare class Databases {
      */
     updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEmail>;
     /**
-     * Create enum attribute
-     *
      * Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute.
 
      *
@@ -260,8 +222,6 @@ export declare class Databases {
      */
     createEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEnum>;
     /**
-     * Update enum attribute
-     *
      * Update an enum attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -277,8 +237,6 @@ export declare class Databases {
      */
     updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEnum>;
     /**
-     * Create float attribute
-     *
      * Create a float attribute. Optionally, minimum and maximum values can be provided.
 
      *
@@ -295,8 +253,6 @@ export declare class Databases {
      */
     createFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeFloat>;
     /**
-     * Update float attribute
-     *
      * Update a float attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -313,8 +269,6 @@ export declare class Databases {
      */
     updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number, min?: number, max?: number, newKey?: string): Promise<Models.AttributeFloat>;
     /**
-     * Create integer attribute
-     *
      * Create an integer attribute. Optionally, minimum and maximum values can be provided.
 
      *
@@ -331,8 +285,6 @@ export declare class Databases {
      */
     createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeInteger>;
     /**
-     * Update integer attribute
-     *
      * Update an integer attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -349,8 +301,6 @@ export declare class Databases {
      */
     updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number, min?: number, max?: number, newKey?: string): Promise<Models.AttributeInteger>;
     /**
-     * Create IP address attribute
-     *
      * Create IP address attribute.
 
      *
@@ -365,8 +315,6 @@ export declare class Databases {
      */
     createIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeIp>;
     /**
-     * Update IP address attribute
-     *
      * Update an ip attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -381,8 +329,6 @@ export declare class Databases {
      */
     updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeIp>;
     /**
-     * Create relationship attribute
-     *
      * Create relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
 
      *
@@ -399,8 +345,6 @@ export declare class Databases {
      */
     createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
     /**
-     * Create string attribute
-     *
      * Create a string attribute.
 
      *
@@ -417,8 +361,6 @@ export declare class Databases {
      */
     createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeString>;
     /**
-     * Update string attribute
-     *
      * Update a string attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -434,8 +376,6 @@ export declare class Databases {
      */
     updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.AttributeString>;
     /**
-     * Create URL attribute
-     *
      * Create a URL attribute.
 
      *
@@ -450,8 +390,6 @@ export declare class Databases {
      */
     createUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeUrl>;
     /**
-     * Update URL attribute
-     *
      * Update an url attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -466,8 +404,6 @@ export declare class Databases {
      */
     updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeUrl>;
     /**
-     * Get attribute
-     *
      * Get attribute by ID.
      *
      * @param {string} databaseId
@@ -478,8 +414,6 @@ export declare class Databases {
      */
     getAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * Delete attribute
-     *
      * Deletes an attribute.
      *
      * @param {string} databaseId
@@ -490,8 +424,6 @@ export declare class Databases {
      */
     deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * Update relationship attribute
-     *
      * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
 
      *
@@ -505,8 +437,6 @@ export declare class Databases {
      */
     updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
     /**
-     * List documents
-     *
      * Get a list of all the user&#039;s documents in a given collection. You can use the query params to filter your results.
      *
      * @param {string} databaseId
@@ -517,8 +447,6 @@ export declare class Databases {
      */
     listDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
     /**
-     * Create document
-     *
      * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
 
      *
@@ -532,8 +460,6 @@ export declare class Databases {
      */
     createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
     /**
-     * Get document
-     *
      * Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
      *
      * @param {string} databaseId
@@ -545,8 +471,6 @@ export declare class Databases {
      */
     getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
     /**
-     * Update document
-     *
      * Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
      *
      * @param {string} databaseId
@@ -559,8 +483,6 @@ export declare class Databases {
      */
     updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: Partial<Omit<Document, keyof Models.Document>>, permissions?: string[]): Promise<Document>;
     /**
-     * Delete document
-     *
      * Delete a document by its unique ID.
      *
      * @param {string} databaseId
@@ -571,8 +493,6 @@ export declare class Databases {
      */
     deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
     /**
-     * List document logs
-     *
      * Get the document activity logs list by its unique ID.
      *
      * @param {string} databaseId
@@ -584,8 +504,6 @@ export declare class Databases {
      */
     listDocumentLogs(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List indexes
-     *
      * List indexes in the collection.
      *
      * @param {string} databaseId
@@ -596,8 +514,6 @@ export declare class Databases {
      */
     listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
     /**
-     * Create index
-     *
      * Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
 Attributes can be `key`, `fulltext`, and `unique`.
      *
@@ -612,8 +528,6 @@ Attributes can be `key`, `fulltext`, and `unique`.
      */
     createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[]): Promise<Models.Index>;
     /**
-     * Get index
-     *
      * Get index by ID.
      *
      * @param {string} databaseId
@@ -624,8 +538,6 @@ Attributes can be `key`, `fulltext`, and `unique`.
      */
     getIndex(databaseId: string, collectionId: string, key: string): Promise<Models.Index>;
     /**
-     * Delete index
-     *
      * Delete an index.
      *
      * @param {string} databaseId
@@ -636,8 +548,6 @@ Attributes can be `key`, `fulltext`, and `unique`.
      */
     deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * List collection logs
-     *
      * Get the collection activity logs list by its unique ID.
      *
      * @param {string} databaseId
@@ -648,8 +558,6 @@ Attributes can be `key`, `fulltext`, and `unique`.
      */
     listCollectionLogs(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * Get collection usage stats
-     *
      * Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
      *
      * @param {string} databaseId
@@ -660,8 +568,6 @@ Attributes can be `key`, `fulltext`, and `unique`.
      */
     getCollectionUsage(databaseId: string, collectionId: string, range?: DatabaseUsageRange): Promise<Models.UsageCollection>;
     /**
-     * List database logs
-     *
      * Get the database activity logs list by its unique ID.
      *
      * @param {string} databaseId
@@ -671,8 +577,6 @@ Attributes can be `key`, `fulltext`, and `unique`.
      */
     listLogs(databaseId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * Get database usage stats
-     *
      * Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
      *
      * @param {string} databaseId