react-native-appwrite 0.16.0 → 0.18.0

package/src/services/teams.ts

@@ -18,37 +18,41 @@ export 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  }): Promise<Models.TeamList<Preferences>>;
+    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>>;
     list<Preferences extends Models.Preferences = Models.DefaultPreferences>(
-        paramsOrFirst?: { queries?: string[], search?: string } | string[],
-        ...rest: [(string)?]    
+        paramsOrFirst?: { queries?: string[], search?: string, total?: boolean } | string[],
+        ...rest: [(string)?, (boolean)?]    
     ): Promise<Models.TeamList<Preferences>> {
-        let params: { queries?: string[], search?: string };
+        let params: { queries?: string[], search?: string, total?: boolean };
 
         if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
-            params = (paramsOrFirst || {}) as { queries?: string[], search?: string };
+            params = (paramsOrFirst || {}) as { queries?: string[], search?: string, total?: boolean };
         } else {
             params = {
                 queries: paramsOrFirst as string[],
-                search: rest[0] as string            
+                search: rest[0] as string,
+                total: rest[1] as boolean            
             };
         }
 
         const queries = params.queries;
         const search = params.search;
+        const total = params.total;
 
         const apiPath = '/teams';
         const payload: Payload = {};
@@ -61,6 +65,10 @@ export class Teams extends Service {
             payload['search'] = search;
         }
 
+        if (typeof total !== 'undefined') {
+            payload['total'] = total;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return this.client.call('get', uri, {
         }, payload);
@@ -289,40 +297,44 @@ export 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}
      */
-    listMemberships(params: { teamId: string, queries?: string[], search?: string  }): Promise<Models.MembershipList>;
+    listMemberships(params: { 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.
      *
      * @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>;
     listMemberships(
-        paramsOrFirst: { teamId: string, queries?: string[], search?: string } | string,
-        ...rest: [(string[])?, (string)?]    
+        paramsOrFirst: { teamId: string, queries?: string[], search?: string, total?: boolean } | string,
+        ...rest: [(string[])?, (string)?, (boolean)?]    
     ): Promise<Models.MembershipList> {
-        let params: { teamId: string, queries?: string[], search?: string };
+        let params: { teamId: string, queries?: string[], search?: string, total?: boolean };
 
         if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
-            params = (paramsOrFirst || {}) as { teamId: string, queries?: string[], search?: string };
+            params = (paramsOrFirst || {}) as { teamId: string, queries?: string[], search?: string, total?: boolean };
         } else {
             params = {
                 teamId: paramsOrFirst as string,
                 queries: rest[0] as string[],
-                search: rest[1] as string            
+                search: rest[1] as string,
+                total: rest[2] as boolean            
             };
         }
 
         const teamId = params.teamId;
         const queries = params.queries;
         const search = params.search;
+        const total = params.total;
 
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
@@ -339,6 +351,10 @@ export class Teams extends Service {
             payload['search'] = search;
         }
 
+        if (typeof total !== 'undefined') {
+            payload['total'] = total;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return this.client.call('get', uri, {
         }, payload);

package/types/enums/execution-status.d.ts

@@ -2,5 +2,6 @@ export declare enum ExecutionStatus {
     Waiting = "waiting",
     Processing = "processing",
     Completed = "completed",
-    Failed = "failed"
+    Failed = "failed",
+    Scheduled = "scheduled"
 }

package/types/index.d.ts

@@ -15,6 +15,7 @@ export { Query } from './query';
 export { Permission } from './permission';
 export { Role } from './role';
 export { ID } from './id';
+export { Operator, Condition } from './operator';
 export { AuthenticatorType } from './enums/authenticator-type';
 export { AuthenticationFactor } from './enums/authentication-factor';
 export { OAuthProvider } from './enums/o-auth-provider';
@@ -24,3 +25,5 @@ export { Flag } from './enums/flag';
 export { ExecutionMethod } from './enums/execution-method';
 export { ImageGravity } from './enums/image-gravity';
 export { ImageFormat } from './enums/image-format';
+export { ExecutionTrigger } from './enums/execution-trigger';
+export { ExecutionStatus } from './enums/execution-status';

package/types/models.d.ts

@@ -197,6 +197,19 @@ export declare namespace Models {
          */
         localeCodes: LocaleCode[];
     };
+    /**
+     * Transaction List
+     */
+    export type TransactionList = {
+        /**
+         * Total number of transactions that matched your query.
+         */
+        total: number;
+        /**
+         * List of transactions.
+         */
+        transactions: Transaction[];
+    };
     /**
      * Row
      */
@@ -970,7 +983,7 @@ export declare namespace Models {
          */
         trigger: ExecutionTrigger;
         /**
-         * The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.
+         * The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.
          */
         status: ExecutionStatus;
         /**
@@ -1184,6 +1197,35 @@ export declare namespace Models {
          */
         recoveryCode: boolean;
     };
+    /**
+     * Transaction
+     */
+    export type Transaction = {
+        /**
+         * Transaction ID.
+         */
+        $id: string;
+        /**
+         * Transaction creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Transaction update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.
+         */
+        status: string;
+        /**
+         * Number of operations in the transaction.
+         */
+        operations: number;
+        /**
+         * Expiration time in ISO 8601 format.
+         */
+        expiresAt: string;
+    };
     /**
      * Subscriber
      */

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.
      *