react-native-appwrite 0.11.0 → 0.12.0

package/src/services/functions.ts

@@ -15,15 +15,42 @@ export class Functions extends Service {
      }
 
     /**
-     * Get a list of all the current user function execution logs. You can use the
-     * query params to filter your results.
+     * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
-     * @param {string} functionId
-     * @param {string[]} queries
+     * @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
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList> {
+    listExecutions(params: { functionId: string, queries?: string[]  }): 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
+     * @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(
+        paramsOrFirst: { functionId: string, queries?: string[] } | string,
+        ...rest: [(string[])?]    
+    ): Promise<Models.ExecutionList> {
+        let params: { functionId: string, queries?: string[] };
+
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { functionId: string, queries?: string[] };
+        } else {
+            params = {
+                functionId: paramsOrFirst as string,
+                queries: rest[0] as string[]            
+            };
+        }
+
+        const functionId = params.functionId;
+        const queries = params.queries;
+
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -41,22 +68,62 @@ export class Functions extends Service {
     }
 
     /**
-     * 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.
+     * 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.
      *
-     * @param {string} functionId
-     * @param {string} body
-     * @param {boolean} async
-     * @param {string} xpath
-     * @param {ExecutionMethod} method
-     * @param {object} headers
-     * @param {string} scheduledAt
+     * @param {string} params.functionId - Function ID.
+     * @param {string} params.body - HTTP body of execution. Default value is empty string.
+     * @param {boolean} params.async - Execute code in the background. Default value is false.
+     * @param {string} params.xpath - HTTP path of execution. Path can include query params. Default value is /
+     * @param {ExecutionMethod} params.method - HTTP method of execution. Default value is GET.
+     * @param {object} params.headers - HTTP headers of execution. Defaults to empty.
+     * @param {string} params.scheduledAt - Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution> {
+    createExecution(params: { functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string  }): Promise<Models.Execution>;
+    /**
+     * 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.
+     *
+     * @param {string} functionId - Function ID.
+     * @param {string} body - HTTP body of execution. Default value is empty string.
+     * @param {boolean} async - Execute code in the background. Default value is false.
+     * @param {string} xpath - HTTP path of execution. Path can include query params. Default value is /
+     * @param {ExecutionMethod} method - HTTP method of execution. Default value is GET.
+     * @param {object} headers - HTTP headers of execution. Defaults to empty.
+     * @param {string} scheduledAt - Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Execution>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution>;
+    createExecution(
+        paramsOrFirst: { functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string } | string,
+        ...rest: [(string)?, (boolean)?, (string)?, (ExecutionMethod)?, (object)?, (string)?]    
+    ): Promise<Models.Execution> {
+        let params: { functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string };
+
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string };
+        } else {
+            params = {
+                functionId: paramsOrFirst as string,
+                body: rest[0] as string,
+                async: rest[1] as boolean,
+                xpath: rest[2] as string,
+                method: rest[3] as ExecutionMethod,
+                headers: rest[4] as object,
+                scheduledAt: rest[5] as string            
+            };
+        }
+
+        const functionId = params.functionId;
+        const body = params.body;
+        const async = params.async;
+        const xpath = params.xpath;
+        const method = params.method;
+        const headers = params.headers;
+        const scheduledAt = params.scheduledAt;
+
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -97,12 +164,40 @@ export class Functions extends Service {
     /**
      * Get a function execution log by its unique ID.
      *
-     * @param {string} functionId
-     * @param {string} executionId
+     * @param {string} params.functionId - Function ID.
+     * @param {string} params.executionId - Execution ID.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    getExecution(functionId: string, executionId: string): Promise<Models.Execution> {
+    getExecution(params: { functionId: string, executionId: string  }): Promise<Models.Execution>;
+    /**
+     * Get a function execution log by its unique ID.
+     *
+     * @param {string} functionId - Function ID.
+     * @param {string} executionId - Execution ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Execution>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
+    getExecution(
+        paramsOrFirst: { functionId: string, executionId: string } | string,
+        ...rest: [(string)?]    
+    ): Promise<Models.Execution> {
+        let params: { functionId: string, executionId: string };
+
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { functionId: string, executionId: string };
+        } else {
+            params = {
+                functionId: paramsOrFirst as string,
+                executionId: rest[0] as string            
+            };
+        }
+
+        const functionId = params.functionId;
+        const executionId = params.executionId;
+
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }

package/src/services/graphql.ts

@@ -16,11 +16,35 @@ export class Graphql extends Service {
     /**
      * Execute a GraphQL mutation.
      *
-     * @param {object} query
+     * @param {object} params.query - The query or queries to execute.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    query(query: object): Promise<{}> {
+    query(params: { query: object  }): Promise<{}>;
+    /**
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query - The query or queries to execute.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    query(query: object): Promise<{}>;
+    query(
+        paramsOrFirst: { query: object } | object    
+    ): Promise<{}> {
+        let params: { query: object };
+
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && 'query' in paramsOrFirst)) {
+            params = (paramsOrFirst || {}) as { query: object };
+        } else {
+            params = {
+                query: paramsOrFirst as object            
+            };
+        }
+
+        const query = params.query;
+
         if (typeof query === 'undefined') {
             throw new AppwriteException('Missing required parameter: "query"');
         }
@@ -42,11 +66,35 @@ export class Graphql extends Service {
     /**
      * Execute a GraphQL mutation.
      *
-     * @param {object} query
+     * @param {object} params.query - The query or queries to execute.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    mutation(query: object): Promise<{}> {
+    mutation(params: { query: object  }): Promise<{}>;
+    /**
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query - The query or queries to execute.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    mutation(query: object): Promise<{}>;
+    mutation(
+        paramsOrFirst: { query: object } | object    
+    ): Promise<{}> {
+        let params: { query: object };
+
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && 'query' in paramsOrFirst)) {
+            params = (paramsOrFirst || {}) as { query: object };
+        } else {
+            params = {
+                query: paramsOrFirst as object            
+            };
+        }
+
+        const query = params.query;
+
         if (typeof query === 'undefined') {
             throw new AppwriteException('Missing required parameter: "query"');
         }

package/src/services/locale.ts

@@ -14,10 +14,7 @@ export class Locale extends Service {
      }
 
     /**
-     * Get the current user location based on IP. Returns an object with user
-     * country code, country name, continent name, continent code, ip address and
-     * suggested currency. You can use the locale header to get the data in a
-     * supported language.
+     * Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.
      * 
      * ([IP Geolocation by DB-IP](https://db-ip.com))
      *
@@ -34,8 +31,7 @@ export class Locale extends Service {
     }
 
     /**
-     * List of all locale codes in [ISO
-     * 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
+     * List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -50,8 +46,7 @@ export class Locale extends Service {
     }
 
     /**
-     * List of all continents. You can use the locale header to get the data in a
-     * supported language.
+     * List of all continents. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -66,8 +61,7 @@ export class Locale extends Service {
     }
 
     /**
-     * List of all countries. You can use the locale header to get the data in a
-     * supported language.
+     * List of all countries. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -82,8 +76,7 @@ export class Locale extends Service {
     }
 
     /**
-     * List of all countries that are currently members of the EU. You can use the
-     * locale header to get the data in a supported language.
+     * List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -98,8 +91,7 @@ export class Locale extends Service {
     }
 
     /**
-     * List of all countries phone codes. You can use the locale header to get the
-     * data in a supported language.
+     * List of all countries phone codes. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -114,9 +106,7 @@ export class Locale extends Service {
     }
 
     /**
-     * List of all currencies, including currency symbol, name, plural, and
-     * decimal digits for all major and minor currencies. You can use the locale
-     * header to get the data in a supported language.
+     * List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -131,8 +121,7 @@ export class Locale extends Service {
     }
 
     /**
-     * List of all languages classified by ISO 639-1 including 2-letter code, name
-     * in English, and name in the respective language.
+     * List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}

package/src/services/messaging.ts

@@ -16,13 +16,44 @@ export class Messaging extends Service {
     /**
      * Create a new subscriber.
      *
-     * @param {string} topicId
-     * @param {string} subscriberId
-     * @param {string} targetId
+     * @param {string} params.topicId - Topic ID. The topic ID to subscribe to.
+     * @param {string} params.subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
+     * @param {string} params.targetId - Target ID. The target ID to link to the specified Topic ID.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber> {
+    createSubscriber(params: { topicId: string, subscriberId: string, targetId: string  }): Promise<Models.Subscriber>;
+    /**
+     * Create a new subscriber.
+     *
+     * @param {string} topicId - Topic ID. The topic ID to subscribe to.
+     * @param {string} subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
+     * @param {string} targetId - Target ID. The target ID to link to the specified Topic ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Subscriber>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
+    createSubscriber(
+        paramsOrFirst: { topicId: string, subscriberId: string, targetId: string } | string,
+        ...rest: [(string)?, (string)?]    
+    ): Promise<Models.Subscriber> {
+        let params: { topicId: string, subscriberId: string, targetId: string };
+
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { topicId: string, subscriberId: string, targetId: string };
+        } else {
+            params = {
+                topicId: paramsOrFirst as string,
+                subscriberId: rest[0] as string,
+                targetId: rest[1] as string            
+            };
+        }
+
+        const topicId = params.topicId;
+        const subscriberId = params.subscriberId;
+        const targetId = params.targetId;
+
         if (typeof topicId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "topicId"');
         }
@@ -55,12 +86,40 @@ export class Messaging extends Service {
     /**
      * Delete a subscriber by its unique ID.
      *
-     * @param {string} topicId
-     * @param {string} subscriberId
+     * @param {string} params.topicId - Topic ID. The topic ID subscribed to.
+     * @param {string} params.subscriberId - Subscriber ID.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    deleteSubscriber(topicId: string, subscriberId: string): Promise<{}> {
+    deleteSubscriber(params: { topicId: string, subscriberId: string  }): Promise<{}>;
+    /**
+     * Delete a subscriber by its unique ID.
+     *
+     * @param {string} topicId - Topic ID. The topic ID subscribed to.
+     * @param {string} subscriberId - Subscriber ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteSubscriber(topicId: string, subscriberId: string): Promise<{}>;
+    deleteSubscriber(
+        paramsOrFirst: { topicId: string, subscriberId: string } | string,
+        ...rest: [(string)?]    
+    ): Promise<{}> {
+        let params: { topicId: string, subscriberId: string };
+
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { topicId: string, subscriberId: string };
+        } else {
+            params = {
+                topicId: paramsOrFirst as string,
+                subscriberId: rest[0] as string            
+            };
+        }
+
+        const topicId = params.topicId;
+        const subscriberId = params.subscriberId;
+
         if (typeof topicId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "topicId"');
         }