react-native-appwrite 0.3.0 → 0.3.1

package/types/services/avatars.d.ts

@@ -0,0 +1,149 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import { Browser } from '../enums/browser';
+import { CreditCard } from '../enums/credit-card';
+import { Flag } from '../enums/flag';
+export declare class Avatars extends Service {
+    constructor(client: Client);
+    /**
+     * Get browser icon
+     *
+     * You can use this endpoint to show different browser icons to your users.
+     * The code argument receives the browser code as it appears in your user [GET
+     * /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions)
+     * endpoint. Use width, height and quality arguments to change the output
+     * settings.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     *
+     * @param {Browser} code
+     * @param {number} width
+     * @param {number} height
+     * @param {number} quality
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getBrowser(code: Browser, width?: number, height?: number, quality?: number): URL;
+    /**
+     * Get credit card icon
+     *
+     * The credit card endpoint will return you the icon of the credit card
+     * provider you need. Use width, height and quality arguments to change the
+     * output settings.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     *
+     *
+     * @param {CreditCard} code
+     * @param {number} width
+     * @param {number} height
+     * @param {number} quality
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): URL;
+    /**
+     * Get favicon
+     *
+     * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
+     * website URL.
+     *
+     *
+     * @param {string} url
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFavicon(url: string): URL;
+    /**
+     * Get country flag
+     *
+     * You can use this endpoint to show different country flags icons to your
+     * users. The code argument receives the 2 letter country code. Use width,
+     * height and quality arguments to change the output settings. Country codes
+     * follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     *
+     *
+     * @param {Flag} code
+     * @param {number} width
+     * @param {number} height
+     * @param {number} quality
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFlag(code: Flag, width?: number, height?: number, quality?: number): URL;
+    /**
+     * Get image from URL
+     *
+     * Use this endpoint to fetch a remote image URL and crop it to any image size
+     * you want. This endpoint is very useful if you need to crop and display
+     * remote images in your app or in case you want to make sure a 3rd party
+     * image is properly served using a TLS protocol.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 400x400px.
+     *
+     *
+     * @param {string} url
+     * @param {number} width
+     * @param {number} height
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getImage(url: string, width?: number, height?: number): URL;
+    /**
+     * Get user initials
+     *
+     * Use this endpoint to show your user initials avatar icon on your website or
+     * app. By default, this route will try to print your logged-in user name or
+     * email initials. You can also overwrite the user name if you pass the 'name'
+     * parameter. If no name is given and no user is logged, an empty avatar will
+     * be returned.
+     *
+     * You can use the color and background params to change the avatar colors. By
+     * default, a random theme will be selected. The random theme will persist for
+     * the user's initials when reloading the same theme will always return for
+     * the same initials.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     *
+     *
+     * @param {string} name
+     * @param {number} width
+     * @param {number} height
+     * @param {string} background
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getInitials(name?: string, width?: number, height?: number, background?: string): URL;
+    /**
+     * Get QR code
+     *
+     * Converts a given plain text to a QR code image. You can use the query
+     * parameters to change the size and style of the resulting image.
+     *
+     *
+     * @param {string} text
+     * @param {number} size
+     * @param {number} margin
+     * @param {boolean} download
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getQR(text: string, size?: number, margin?: number, download?: boolean): URL;
+}

package/types/services/databases.d.ts

@@ -0,0 +1,77 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Databases extends Service {
+    constructor(client: Client);
+    /**
+     * List documents
+     *
+     * Get a list of all the user's documents in a given collection. You can use
+     * the query params to filter your results.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    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.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {object} data
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, 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
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    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
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {object} data
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: object, permissions?: string[]): Promise<Document>;
+    /**
+     * Delete document
+     *
+     * Delete a document by its unique ID.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
+}

package/types/services/functions.d.ts

@@ -0,0 +1,49 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+import { ExecutionMethod } from '../enums/execution-method';
+export declare class Functions extends Service {
+    constructor(client: Client);
+    /**
+     * List executions
+     *
+     * 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} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
+    /**
+     * Create 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
+     * @param {string} body
+     * @param {boolean} async
+     * @param {string} xpath
+     * @param {ExecutionMethod} method
+     * @param {object} headers
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution>;
+    /**
+     * Get execution
+     *
+     * Get a function execution log by its unique ID.
+     *
+     * @param {string} functionId
+     * @param {string} executionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
+}

package/types/services/graphql.d.ts

@@ -0,0 +1,25 @@
+import { Service } from '../service';
+import { Client } from '../client';
+export declare class Graphql extends Service {
+    constructor(client: Client);
+    /**
+     * GraphQL endpoint
+     *
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    query(query: object): Promise<{}>;
+    /**
+     * GraphQL endpoint
+     *
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    mutation(query: object): Promise<{}>;
+}

package/types/services/locale.d.ts

@@ -0,0 +1,91 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Locale extends Service {
+    constructor(client: Client);
+    /**
+     * Get user locale
+     *
+     * 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))
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    get(): Promise<Models.Locale>;
+    /**
+     * List Locale 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}
+    */
+    listCodes(): Promise<Models.LocaleCodeList>;
+    /**
+     * List continents
+     *
+     * List of all continents. You can use the locale header to get the data in a
+     * supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listContinents(): Promise<Models.ContinentList>;
+    /**
+     * List countries
+     *
+     * List of all countries. You can use the locale header to get the data in a
+     * supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listCountries(): Promise<Models.CountryList>;
+    /**
+     * List EU countries
+     *
+     * 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}
+    */
+    listCountriesEU(): Promise<Models.CountryList>;
+    /**
+     * List countries phone codes
+     *
+     * List of all countries phone codes. You can use the locale header to get the
+     * data in a supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listCountriesPhones(): Promise<Models.PhoneList>;
+    /**
+     * List currencies
+     *
+     * 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}
+    */
+    listCurrencies(): Promise<Models.CurrencyList>;
+    /**
+     * List languages
+     *
+     * 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}
+    */
+    listLanguages(): Promise<Models.LanguageList>;
+}

package/types/services/messaging.d.ts

@@ -0,0 +1,29 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Messaging extends Service {
+    constructor(client: Client);
+    /**
+     * Create subscriber
+     *
+     * Create a new subscriber.
+     *
+     * @param {string} topicId
+     * @param {string} subscriberId
+     * @param {string} targetId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
+    /**
+     * Delete subscriber
+     *
+     * Delete a subscriber by its unique ID.
+     *
+     * @param {string} topicId
+     * @param {string} subscriberId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteSubscriber(topicId: string, subscriberId: string): Promise<{}>;
+}

package/types/services/storage.d.ts

@@ -0,0 +1,147 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+import type { UploadProgress } from '../client';
+import { ImageGravity } from '../enums/image-gravity';
+import { ImageFormat } from '../enums/image-format';
+export declare class Storage extends Service {
+    constructor(client: Client);
+    /**
+     * List files
+     *
+     * Get a list of all the user files. You can use the query params to filter
+     * your results.
+     *
+     * @param {string} bucketId
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
+    /**
+     * Create file
+     *
+     * 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.
+     *
+     * Larger files should be uploaded using multiple requests with the
+     * [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
+     * header to send a partial request with a maximum supported chunk of `5MB`.
+     * The `content-range` header values should always be in bytes.
+     *
+     * When the first request is sent, the server will return the **File** object,
+     * and the subsequent part request must include the file's **id** in
+     * `x-appwrite-id` header to allow the server to know that the partial upload
+     * is for the existing file and not for a new one.
+     *
+     * If you're creating a new file using one of the Appwrite SDKs, all the
+     * chunking logic will be managed by the SDK internally.
+     *
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {{name: string, type: string, size: number, uri: string}} file
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createFile(bucketId: string, fileId: string, file: {
+        name: string;
+        type: string;
+        size: number;
+        uri: string;
+    }, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
+    /**
+     * Get file
+     *
+     * Get a file by its unique ID. This endpoint response returns a JSON object
+     * with the file metadata.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getFile(bucketId: string, fileId: string): Promise<Models.File>;
+    /**
+     * Update file
+     *
+     * Update a file by its unique ID. Only users with write permissions have
+     * access to update this resource.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {string} name
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
+    /**
+     * Delete File
+     *
+     * Delete a file by its unique ID. Only users with write permissions have
+     * access to delete this resource.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteFile(bucketId: string, fileId: string): Promise<{}>;
+    /**
+     * Get file for download
+     *
+     * Get a file content by its unique ID. The endpoint response return with a
+     * 'Content-Disposition: attachment' header that tells the browser to start
+     * downloading the file to user downloads directory.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFileDownload(bucketId: string, fileId: string): URL;
+    /**
+     * Get file preview
+     *
+     * Get a file preview image. Currently, this method supports preview for image
+     * files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
+     * and spreadsheets, will return the file icon image. You can also pass query
+     * string arguments for cutting and resizing your preview image. Preview is
+     * supported only for image files smaller than 10MB.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {number} width
+     * @param {number} height
+     * @param {ImageGravity} gravity
+     * @param {number} quality
+     * @param {number} borderWidth
+     * @param {string} borderColor
+     * @param {number} borderRadius
+     * @param {number} opacity
+     * @param {number} rotation
+     * @param {string} background
+     * @param {ImageFormat} output
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat): URL;
+    /**
+     * Get file for view
+     *
+     * Get a file content by its unique ID. This endpoint is similar to the
+     * download method but returns with no  'Content-Disposition: attachment'
+     * header.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFileView(bucketId: string, fileId: string): URL;
+}