react-native-appwrite 0.17.1 → 0.18.0

package/types/operator.d.ts

@@ -0,0 +1,180 @@
+type OperatorValuesSingle = string | number | boolean;
+export type OperatorValuesList = string[] | number[] | boolean[] | any[];
+export type OperatorValues = OperatorValuesSingle | OperatorValuesList;
+export declare enum Condition {
+    Equal = "equal",
+    NotEqual = "notEqual",
+    GreaterThan = "greaterThan",
+    GreaterThanEqual = "greaterThanEqual",
+    LessThan = "lessThan",
+    LessThanEqual = "lessThanEqual",
+    Contains = "contains",
+    IsNull = "isNull",
+    IsNotNull = "isNotNull"
+}
+/**
+ * Helper class to generate operator strings for atomic operations.
+ */
+export declare class Operator {
+    method: string;
+    values: OperatorValuesList | undefined;
+    /**
+     * Constructor for Operator class.
+     *
+     * @param {string} method
+     * @param {OperatorValues} values
+     */
+    constructor(method: string, values?: OperatorValues);
+    /**
+     * Convert the operator object to a JSON string.
+     *
+     * @returns {string}
+     */
+    toString(): string;
+    /**
+     * Increment a numeric attribute by a specified value.
+     *
+     * @param {number} value
+     * @param {number} max
+     * @returns {string}
+     */
+    static increment: (value?: number, max?: number) => string;
+    /**
+     * Decrement a numeric attribute by a specified value.
+     *
+     * @param {number} value
+     * @param {number} min
+     * @returns {string}
+     */
+    static decrement: (value?: number, min?: number) => string;
+    /**
+     * Multiply a numeric attribute by a specified factor.
+     *
+     * @param {number} factor
+     * @param {number} max
+     * @returns {string}
+     */
+    static multiply: (factor: number, max?: number) => string;
+    /**
+     * Divide a numeric attribute by a specified divisor.
+     *
+     * @param {number} divisor
+     * @param {number} min
+     * @returns {string}
+     */
+    static divide: (divisor: number, min?: number) => string;
+    /**
+     * Apply modulo operation on a numeric attribute.
+     *
+     * @param {number} divisor
+     * @returns {string}
+     */
+    static modulo: (divisor: number) => string;
+    /**
+     * Raise a numeric attribute to a specified power.
+     *
+     * @param {number} exponent
+     * @param {number} max
+     * @returns {string}
+     */
+    static power: (exponent: number, max?: number) => string;
+    /**
+     * Append values to an array attribute.
+     *
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static arrayAppend: (values: any[]) => string;
+    /**
+     * Prepend values to an array attribute.
+     *
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static arrayPrepend: (values: any[]) => string;
+    /**
+     * Insert a value at a specific index in an array attribute.
+     *
+     * @param {number} index
+     * @param {any} value
+     * @returns {string}
+     */
+    static arrayInsert: (index: number, value: any) => string;
+    /**
+     * Remove a value from an array attribute.
+     *
+     * @param {any} value
+     * @returns {string}
+     */
+    static arrayRemove: (value: any) => string;
+    /**
+     * Remove duplicate values from an array attribute.
+     *
+     * @returns {string}
+     */
+    static arrayUnique: () => string;
+    /**
+     * Keep only values that exist in both the current array and the provided array.
+     *
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static arrayIntersect: (values: any[]) => string;
+    /**
+     * Remove values from the array that exist in the provided array.
+     *
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static arrayDiff: (values: any[]) => string;
+    /**
+     * Filter array values based on a condition.
+     *
+     * @param {Condition} condition
+     * @param {any} value
+     * @returns {string}
+     */
+    static arrayFilter: (condition: Condition, value?: any) => string;
+    /**
+     * Concatenate a value to a string or array attribute.
+     *
+     * @param {any} value
+     * @returns {string}
+     */
+    static stringConcat: (value: any) => string;
+    /**
+     * Replace occurrences of a search string with a replacement string.
+     *
+     * @param {string} search
+     * @param {string} replace
+     * @returns {string}
+     */
+    static stringReplace: (search: string, replace: string) => string;
+    /**
+     * Toggle a boolean attribute.
+     *
+     * @returns {string}
+     */
+    static toggle: () => string;
+    /**
+     * Add days to a date attribute.
+     *
+     * @param {number} days
+     * @returns {string}
+     */
+    static dateAddDays: (days: number) => string;
+    /**
+     * Subtract days from a date attribute.
+     *
+     * @param {number} days
+     * @returns {string}
+     */
+    static dateSubDays: (days: number) => string;
+    /**
+     * Set a date attribute to the current date and time.
+     *
+     * @returns {string}
+     */
+    static dateSetNow: () => string;
+}
+export {};

package/types/services/account.d.ts

@@ -71,21 +71,24 @@ export declare class Account extends Service {
      * Get the list of identities for the currently logged in user.
      *
      * @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, provider, providerUid, providerEmail, providerAccessTokenExpiry
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
     listIdentities(params?: {
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.IdentityList>;
     /**
      * Get the list of identities for the currently logged in user.
      *
      * @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, provider, providerUid, providerEmail, providerAccessTokenExpiry
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.IdentityList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listIdentities(queries?: string[]): Promise<Models.IdentityList>;
+    listIdentities(queries?: string[], total?: boolean): Promise<Models.IdentityList>;
     /**
      * Delete an identity by its unique ID.
      *
@@ -116,21 +119,24 @@ export declare class Account extends Service {
      * Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
      *
      * @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}
      */
     listLogs(params?: {
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.LogList>;
     /**
      * Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
      *
      * @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.
      */
-    listLogs(queries?: string[]): Promise<Models.LogList>;
+    listLogs(queries?: string[], total?: boolean): Promise<Models.LogList>;
     /**
      * Enable or disable MFA on an account.
      *

package/types/services/databases.d.ts

@@ -133,6 +133,7 @@ export declare class Databases extends Service {
      * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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.
      * @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
@@ -142,6 +143,7 @@ export declare class Databases extends Service {
         collectionId: string;
         queries?: string[];
         transactionId?: string;
+        total?: boolean;
     }): Promise<Models.DocumentList<Document>>;
     /**
      * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
@@ -150,11 +152,12 @@ export declare class Databases extends Service {
      * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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.
      * @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string): Promise<Models.DocumentList<Document>>;
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.DocumentList<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.
      *

package/types/services/functions.d.ts

@@ -9,23 +9,26 @@ export declare class Functions extends Service {
      *
      * @param {string} params.functionId - Function 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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
     listExecutions(params: {
         functionId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.ExecutionList>;
     /**
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId - Function 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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ExecutionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList>;
+    listExecutions(functionId: string, queries?: string[], total?: boolean): Promise<Models.ExecutionList>;
     /**
      * Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.
      *

package/types/services/storage.d.ts

@@ -12,6 +12,7 @@ export declare class Storage extends Service {
      * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @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, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
      * @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}
      */
@@ -19,6 +20,7 @@ export declare class Storage extends Service {
         bucketId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.FileList>;
     /**
      * Get a list of all the user files. You can use the query params to filter your results.
@@ -26,11 +28,12 @@ export declare class Storage extends Service {
      * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @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, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
      * @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.FileList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
+    listFiles(bucketId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.FileList>;
     /**
      * Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
      *

package/types/services/tables-db.d.ts

@@ -133,6 +133,7 @@ export declare class TablesDB extends Service {
      * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/products/databases/tables#create-table).
      * @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.
      * @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
@@ -141,6 +142,7 @@ export declare class TablesDB extends Service {
         tableId: string;
         queries?: string[];
         transactionId?: string;
+        total?: boolean;
     }): Promise<Models.RowList<Row>>;
     /**
      * Get a list of all the user's rows in a given table. You can use the query params to filter your results.
@@ -149,11 +151,12 @@ export declare class TablesDB extends Service {
      * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/products/databases/tables#create-table).
      * @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.
      * @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.RowList<Row>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string): Promise<Models.RowList<Row>>;
+    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.RowList<Row>>;
     /**
      * Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
      *

package/types/services/teams.d.ts

@@ -8,23 +8,26 @@ export declare class Teams extends Service {
      *
      * @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, total, billingPlan
      * @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}
      */
     list<Preferences extends Models.Preferences = Models.DefaultPreferences>(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.TeamList<Preferences>>;
     /**
      * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
      *
      * @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, total, billingPlan
      * @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.TeamList<Preferences>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>>;
+    list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string, total?: boolean): Promise<Models.TeamList<Preferences>>;
     /**
      * Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
      *
@@ -116,6 +119,7 @@ export declare class Teams extends Service {
      * @param {string} params.teamId - Team 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, teamId, invited, joined, confirm, roles
      * @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}
      */
@@ -123,6 +127,7 @@ export declare class Teams extends Service {
         teamId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.MembershipList>;
     /**
      * Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.
@@ -130,11 +135,12 @@ export declare class Teams extends Service {
      * @param {string} teamId - Team 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, teamId, invited, joined, confirm, roles
      * @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.MembershipList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
+    listMemberships(teamId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.MembershipList>;
     /**
      * Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.
      *