node-appwrite 14.0.0-rc.1 → 14.0.0-rc.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/client.js +3 -3
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +3 -3
- package/dist/client.mjs.map +1 -1
- package/dist/models.d.mts +182 -0
- package/dist/models.d.ts +182 -0
- package/dist/services/account.d.mts +4 -5
- package/dist/services/account.d.ts +4 -5
- package/dist/services/account.js +4 -11
- package/dist/services/account.js.map +1 -1
- package/dist/services/account.mjs +4 -11
- package/dist/services/account.mjs.map +1 -1
- package/dist/services/avatars.d.mts +2 -0
- package/dist/services/avatars.d.ts +2 -0
- package/dist/services/avatars.js +2 -0
- package/dist/services/avatars.js.map +1 -1
- package/dist/services/avatars.mjs +2 -0
- package/dist/services/avatars.mjs.map +1 -1
- package/dist/services/functions.d.mts +41 -6
- package/dist/services/functions.d.ts +41 -6
- package/dist/services/functions.js +103 -8
- package/dist/services/functions.js.map +1 -1
- package/dist/services/functions.mjs +103 -8
- package/dist/services/functions.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/services/avatars.ts"],"names":[],"mappings":";AAAA,SAAS,yBAA+D;AAMjE,IAAM,UAAN,MAAc;AAAA,EAGjB,YAAY,QAAgB;AACxB,SAAK,SAAS;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAM,WAAW,MAAe,OAAgB,QAAiB,SAAwC;AACrG,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AACA,UAAM,UAAU,2BAA2B,QAAQ,UAAU,IAAI;AACjE,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,YAAY,aAAa;AAChC,cAAQ,SAAS,IAAI;AAAA,IACzB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAM,cAAc,MAAkB,OAAgB,QAAiB,SAAwC;AAC3G,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AACA,UAAM,UAAU,+BAA+B,QAAQ,UAAU,IAAI;AACrE,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,YAAY,aAAa;AAChC,cAAQ,SAAS,IAAI;AAAA,IACzB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAM,WAAW,KAAmC;AAChD,QAAI,OAAO,QAAQ,aAAa;AAC5B,YAAM,IAAI,kBAAkB,mCAAmC;AAAA,IACnE;AACA,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,QAAQ,aAAa;AAC5B,cAAQ,KAAK,IAAI;AAAA,IACrB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAM,QAAQ,MAAY,OAAgB,QAAiB,SAAwC;AAC/F,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AACA,UAAM,UAAU,wBAAwB,QAAQ,UAAU,IAAI;AAC9D,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,YAAY,aAAa;AAChC,cAAQ,SAAS,IAAI;AAAA,IACzB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,MAAM,SAAS,KAAa,OAAgB,QAAuC;AAC/E,QAAI,OAAO,QAAQ,aAAa;AAC5B,YAAM,IAAI,kBAAkB,mCAAmC;AAAA,IACnE;AACA,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,QAAQ,aAAa;AAC5B,cAAQ,KAAK,IAAI;AAAA,IACrB;AACA,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,MAAM,YAAY,MAAe,OAAgB,QAAiB,YAA2C;AACzG,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,SAAS,aAAa;AAC7B,cAAQ,MAAM,IAAI;AAAA,IACtB;AACA,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,eAAe,aAAa;AACnC,cAAQ,YAAY,IAAI;AAAA,IAC5B;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,MAAM,MAAc,MAAe,QAAiB,UAA0C;AAChG,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AACA,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,SAAS,aAAa;AAC7B,cAAQ,MAAM,IAAI;AAAA,IACtB;AACA,QAAI,OAAO,SAAS,aAAa;AAC7B,cAAQ,MAAM,IAAI;AAAA,IACtB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,cAAQ,UAAU,IAAI;AAAA,IAC1B;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AACJ","sourcesContent":["import { AppwriteException, Client, type Payload, UploadProgress } from '../client';\nimport type { Models } from '../models';\nimport { Browser } from '../enums/browser';\nimport { CreditCard } from '../enums/credit-card';\nimport { Flag } from '../enums/flag';\n\nexport class Avatars {\n client: Client;\n\n constructor(client: Client) {\n this.client = client;\n }\n\n /**\n * Get browser icon\n *\n * 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.\n\nWhen 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.\n *\n * @param {Browser} code\n * @param {number} width\n * @param {number} height\n * @param {number} quality\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getBrowser(code: Browser, width?: number, height?: number, quality?: number): Promise<ArrayBuffer> {\n if (typeof code === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"code\"');\n }\n const apiPath = '/avatars/browsers/{code}'.replace('{code}', code);\n const payload: Payload = {};\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n if (typeof quality !== 'undefined') {\n payload['quality'] = quality;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get credit card icon\n *\n * 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.\n\nWhen 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.\n\n *\n * @param {CreditCard} code\n * @param {number} width\n * @param {number} height\n * @param {number} quality\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): Promise<ArrayBuffer> {\n if (typeof code === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"code\"');\n }\n const apiPath = '/avatars/credit-cards/{code}'.replace('{code}', code);\n const payload: Payload = {};\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n if (typeof quality !== 'undefined') {\n payload['quality'] = quality;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get favicon\n *\n * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\n *\n * @param {string} url\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getFavicon(url: string): Promise<ArrayBuffer> {\n if (typeof url === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"url\"');\n }\n const apiPath = '/avatars/favicon';\n const payload: Payload = {};\n if (typeof url !== 'undefined') {\n payload['url'] = url;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get country flag\n *\n * 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.\n\nWhen 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.\n\n *\n * @param {Flag} code\n * @param {number} width\n * @param {number} height\n * @param {number} quality\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getFlag(code: Flag, width?: number, height?: number, quality?: number): Promise<ArrayBuffer> {\n if (typeof code === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"code\"');\n }\n const apiPath = '/avatars/flags/{code}'.replace('{code}', code);\n const payload: Payload = {};\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n if (typeof quality !== 'undefined') {\n payload['quality'] = quality;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get image from URL\n *\n * 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.\n\nWhen 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.\n\n *\n * @param {string} url\n * @param {number} width\n * @param {number} height\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getImage(url: string, width?: number, height?: number): Promise<ArrayBuffer> {\n if (typeof url === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"url\"');\n }\n const apiPath = '/avatars/image';\n const payload: Payload = {};\n if (typeof url !== 'undefined') {\n payload['url'] = url;\n }\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get user initials\n *\n * 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.\n\nYou 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.\n\nWhen 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.\n\n *\n * @param {string} name\n * @param {number} width\n * @param {number} height\n * @param {string} background\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getInitials(name?: string, width?: number, height?: number, background?: string): Promise<ArrayBuffer> {\n const apiPath = '/avatars/initials';\n const payload: Payload = {};\n if (typeof name !== 'undefined') {\n payload['name'] = name;\n }\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n if (typeof background !== 'undefined') {\n payload['background'] = background;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get QR code\n *\n * 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.\n\n *\n * @param {string} text\n * @param {number} size\n * @param {number} margin\n * @param {boolean} download\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getQR(text: string, size?: number, margin?: number, download?: boolean): Promise<ArrayBuffer> {\n if (typeof text === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"text\"');\n }\n const apiPath = '/avatars/qr';\n const payload: Payload = {};\n if (typeof text !== 'undefined') {\n payload['text'] = text;\n }\n if (typeof size !== 'undefined') {\n payload['size'] = size;\n }\n if (typeof margin !== 'undefined') {\n payload['margin'] = margin;\n }\n if (typeof download !== 'undefined') {\n payload['download'] = download;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../../src/services/avatars.ts"],"names":[],"mappings":";AAAA,SAAS,yBAA+D;AAMjE,IAAM,UAAN,MAAc;AAAA,EAGjB,YAAY,QAAgB;AACxB,SAAK,SAAS;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAM,WAAW,MAAe,OAAgB,QAAiB,SAAwC;AACrG,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AACA,UAAM,UAAU,2BAA2B,QAAQ,UAAU,IAAI;AACjE,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,YAAY,aAAa;AAChC,cAAQ,SAAS,IAAI;AAAA,IACzB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAM,cAAc,MAAkB,OAAgB,QAAiB,SAAwC;AAC3G,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AACA,UAAM,UAAU,+BAA+B,QAAQ,UAAU,IAAI;AACrE,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,YAAY,aAAa;AAChC,cAAQ,SAAS,IAAI;AAAA,IACzB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,WAAW,KAAmC;AAChD,QAAI,OAAO,QAAQ,aAAa;AAC5B,YAAM,IAAI,kBAAkB,mCAAmC;AAAA,IACnE;AACA,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,QAAQ,aAAa;AAC5B,cAAQ,KAAK,IAAI;AAAA,IACrB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAM,QAAQ,MAAY,OAAgB,QAAiB,SAAwC;AAC/F,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AACA,UAAM,UAAU,wBAAwB,QAAQ,UAAU,IAAI;AAC9D,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,YAAY,aAAa;AAChC,cAAQ,SAAS,IAAI;AAAA,IACzB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAM,SAAS,KAAa,OAAgB,QAAuC;AAC/E,QAAI,OAAO,QAAQ,aAAa;AAC5B,YAAM,IAAI,kBAAkB,mCAAmC;AAAA,IACnE;AACA,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,QAAQ,aAAa;AAC5B,cAAQ,KAAK,IAAI;AAAA,IACrB;AACA,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,MAAM,YAAY,MAAe,OAAgB,QAAiB,YAA2C;AACzG,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,SAAS,aAAa;AAC7B,cAAQ,MAAM,IAAI;AAAA,IACtB;AACA,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,eAAe,aAAa;AACnC,cAAQ,YAAY,IAAI;AAAA,IAC5B;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,MAAM,MAAc,MAAe,QAAiB,UAA0C;AAChG,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AACA,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,SAAS,aAAa;AAC7B,cAAQ,MAAM,IAAI;AAAA,IACtB;AACA,QAAI,OAAO,SAAS,aAAa;AAC7B,cAAQ,MAAM,IAAI;AAAA,IACtB;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,cAAQ,QAAQ,IAAI;AAAA,IACxB;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,cAAQ,UAAU,IAAI;AAAA,IAC1B;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,MAAM,KAAK,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AACJ","sourcesContent":["import { AppwriteException, Client, type Payload, UploadProgress } from '../client';\nimport type { Models } from '../models';\nimport { Browser } from '../enums/browser';\nimport { CreditCard } from '../enums/credit-card';\nimport { Flag } from '../enums/flag';\n\nexport class Avatars {\n client: Client;\n\n constructor(client: Client) {\n this.client = client;\n }\n\n /**\n * Get browser icon\n *\n * 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.\n\nWhen 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.\n *\n * @param {Browser} code\n * @param {number} width\n * @param {number} height\n * @param {number} quality\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getBrowser(code: Browser, width?: number, height?: number, quality?: number): Promise<ArrayBuffer> {\n if (typeof code === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"code\"');\n }\n const apiPath = '/avatars/browsers/{code}'.replace('{code}', code);\n const payload: Payload = {};\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n if (typeof quality !== 'undefined') {\n payload['quality'] = quality;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get credit card icon\n *\n * 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.\n\nWhen 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.\n\n *\n * @param {CreditCard} code\n * @param {number} width\n * @param {number} height\n * @param {number} quality\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): Promise<ArrayBuffer> {\n if (typeof code === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"code\"');\n }\n const apiPath = '/avatars/credit-cards/{code}'.replace('{code}', code);\n const payload: Payload = {};\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n if (typeof quality !== 'undefined') {\n payload['quality'] = quality;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get favicon\n *\n * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\nThis endpoint does not follow HTTP redirects.\n *\n * @param {string} url\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getFavicon(url: string): Promise<ArrayBuffer> {\n if (typeof url === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"url\"');\n }\n const apiPath = '/avatars/favicon';\n const payload: Payload = {};\n if (typeof url !== 'undefined') {\n payload['url'] = url;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get country flag\n *\n * 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.\n\nWhen 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.\n\n *\n * @param {Flag} code\n * @param {number} width\n * @param {number} height\n * @param {number} quality\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getFlag(code: Flag, width?: number, height?: number, quality?: number): Promise<ArrayBuffer> {\n if (typeof code === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"code\"');\n }\n const apiPath = '/avatars/flags/{code}'.replace('{code}', code);\n const payload: Payload = {};\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n if (typeof quality !== 'undefined') {\n payload['quality'] = quality;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get image from URL\n *\n * 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.\n\nWhen 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.\n\nThis endpoint does not follow HTTP redirects.\n *\n * @param {string} url\n * @param {number} width\n * @param {number} height\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getImage(url: string, width?: number, height?: number): Promise<ArrayBuffer> {\n if (typeof url === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"url\"');\n }\n const apiPath = '/avatars/image';\n const payload: Payload = {};\n if (typeof url !== 'undefined') {\n payload['url'] = url;\n }\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get user initials\n *\n * 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.\n\nYou 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.\n\nWhen 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.\n\n *\n * @param {string} name\n * @param {number} width\n * @param {number} height\n * @param {string} background\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getInitials(name?: string, width?: number, height?: number, background?: string): Promise<ArrayBuffer> {\n const apiPath = '/avatars/initials';\n const payload: Payload = {};\n if (typeof name !== 'undefined') {\n payload['name'] = name;\n }\n if (typeof width !== 'undefined') {\n payload['width'] = width;\n }\n if (typeof height !== 'undefined') {\n payload['height'] = height;\n }\n if (typeof background !== 'undefined') {\n payload['background'] = background;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n /**\n * Get QR code\n *\n * 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.\n\n *\n * @param {string} text\n * @param {number} size\n * @param {number} margin\n * @param {boolean} download\n * @throws {AppwriteException}\n * @returns {Promise<ArrayBuffer>}\n */\n async getQR(text: string, size?: number, margin?: number, download?: boolean): Promise<ArrayBuffer> {\n if (typeof text === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"text\"');\n }\n const apiPath = '/avatars/qr';\n const payload: Payload = {};\n if (typeof text !== 'undefined') {\n payload['text'] = text;\n }\n if (typeof size !== 'undefined') {\n payload['size'] = size;\n }\n if (typeof margin !== 'undefined') {\n payload['margin'] = margin;\n }\n if (typeof download !== 'undefined') {\n payload['download'] = download;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'content-type': 'application/json',\n }\n\n return await this.client.call(\n 'get',\n uri,\n apiHeaders,\n payload,\n 'arrayBuffer'\n );\n }\n}\n"]}
|
|
@@ -43,11 +43,12 @@ declare class Functions {
|
|
|
43
43
|
* @param {string} templateRepository
|
|
44
44
|
* @param {string} templateOwner
|
|
45
45
|
* @param {string} templateRootDirectory
|
|
46
|
-
* @param {string}
|
|
46
|
+
* @param {string} templateVersion
|
|
47
|
+
* @param {string} specification
|
|
47
48
|
* @throws {AppwriteException}
|
|
48
49
|
* @returns {Promise<Models.Function>}
|
|
49
50
|
*/
|
|
50
|
-
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string,
|
|
51
|
+
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: string, specification?: string): Promise<Models.Function>;
|
|
51
52
|
/**
|
|
52
53
|
* List runtimes
|
|
53
54
|
*
|
|
@@ -57,6 +58,39 @@ declare class Functions {
|
|
|
57
58
|
* @returns {Promise<Models.RuntimeList>}
|
|
58
59
|
*/
|
|
59
60
|
listRuntimes(): Promise<Models.RuntimeList>;
|
|
61
|
+
/**
|
|
62
|
+
* List available function runtime specifications
|
|
63
|
+
*
|
|
64
|
+
* List allowed function specifications for this instance.
|
|
65
|
+
|
|
66
|
+
*
|
|
67
|
+
* @throws {AppwriteException}
|
|
68
|
+
* @returns {Promise<Models.SpecificationList>}
|
|
69
|
+
*/
|
|
70
|
+
listSpecifications(): Promise<Models.SpecificationList>;
|
|
71
|
+
/**
|
|
72
|
+
* List function templates
|
|
73
|
+
*
|
|
74
|
+
* List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
75
|
+
*
|
|
76
|
+
* @param {string[]} runtimes
|
|
77
|
+
* @param {string[]} useCases
|
|
78
|
+
* @param {number} limit
|
|
79
|
+
* @param {number} offset
|
|
80
|
+
* @throws {AppwriteException}
|
|
81
|
+
* @returns {Promise<Models.TemplateFunctionList>}
|
|
82
|
+
*/
|
|
83
|
+
listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateFunctionList>;
|
|
84
|
+
/**
|
|
85
|
+
* Get function template
|
|
86
|
+
*
|
|
87
|
+
* Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
88
|
+
*
|
|
89
|
+
* @param {string} templateId
|
|
90
|
+
* @throws {AppwriteException}
|
|
91
|
+
* @returns {Promise<Models.TemplateFunction>}
|
|
92
|
+
*/
|
|
93
|
+
getTemplate(templateId: string): Promise<Models.TemplateFunction>;
|
|
60
94
|
/**
|
|
61
95
|
* Get function
|
|
62
96
|
*
|
|
@@ -89,10 +123,11 @@ declare class Functions {
|
|
|
89
123
|
* @param {string} providerBranch
|
|
90
124
|
* @param {boolean} providerSilentMode
|
|
91
125
|
* @param {string} providerRootDirectory
|
|
126
|
+
* @param {string} specification
|
|
92
127
|
* @throws {AppwriteException}
|
|
93
128
|
* @returns {Promise<Models.Function>}
|
|
94
129
|
*/
|
|
95
|
-
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
|
|
130
|
+
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
|
|
96
131
|
/**
|
|
97
132
|
* Delete function
|
|
98
133
|
*
|
|
@@ -145,7 +180,7 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
145
180
|
*/
|
|
146
181
|
getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
|
|
147
182
|
/**
|
|
148
|
-
* Update
|
|
183
|
+
* Update deployment
|
|
149
184
|
*
|
|
150
185
|
* Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.
|
|
151
186
|
*
|
|
@@ -188,7 +223,7 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
188
223
|
*/
|
|
189
224
|
updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
|
|
190
225
|
/**
|
|
191
|
-
* Download
|
|
226
|
+
* Download deployment
|
|
192
227
|
*
|
|
193
228
|
* Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
|
|
194
229
|
*
|
|
@@ -197,7 +232,7 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
197
232
|
* @throws {AppwriteException}
|
|
198
233
|
* @returns {Promise<ArrayBuffer>}
|
|
199
234
|
*/
|
|
200
|
-
|
|
235
|
+
getDeploymentDownload(functionId: string, deploymentId: string): Promise<ArrayBuffer>;
|
|
201
236
|
/**
|
|
202
237
|
* List executions
|
|
203
238
|
*
|
|
@@ -43,11 +43,12 @@ declare class Functions {
|
|
|
43
43
|
* @param {string} templateRepository
|
|
44
44
|
* @param {string} templateOwner
|
|
45
45
|
* @param {string} templateRootDirectory
|
|
46
|
-
* @param {string}
|
|
46
|
+
* @param {string} templateVersion
|
|
47
|
+
* @param {string} specification
|
|
47
48
|
* @throws {AppwriteException}
|
|
48
49
|
* @returns {Promise<Models.Function>}
|
|
49
50
|
*/
|
|
50
|
-
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string,
|
|
51
|
+
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: string, specification?: string): Promise<Models.Function>;
|
|
51
52
|
/**
|
|
52
53
|
* List runtimes
|
|
53
54
|
*
|
|
@@ -57,6 +58,39 @@ declare class Functions {
|
|
|
57
58
|
* @returns {Promise<Models.RuntimeList>}
|
|
58
59
|
*/
|
|
59
60
|
listRuntimes(): Promise<Models.RuntimeList>;
|
|
61
|
+
/**
|
|
62
|
+
* List available function runtime specifications
|
|
63
|
+
*
|
|
64
|
+
* List allowed function specifications for this instance.
|
|
65
|
+
|
|
66
|
+
*
|
|
67
|
+
* @throws {AppwriteException}
|
|
68
|
+
* @returns {Promise<Models.SpecificationList>}
|
|
69
|
+
*/
|
|
70
|
+
listSpecifications(): Promise<Models.SpecificationList>;
|
|
71
|
+
/**
|
|
72
|
+
* List function templates
|
|
73
|
+
*
|
|
74
|
+
* List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
75
|
+
*
|
|
76
|
+
* @param {string[]} runtimes
|
|
77
|
+
* @param {string[]} useCases
|
|
78
|
+
* @param {number} limit
|
|
79
|
+
* @param {number} offset
|
|
80
|
+
* @throws {AppwriteException}
|
|
81
|
+
* @returns {Promise<Models.TemplateFunctionList>}
|
|
82
|
+
*/
|
|
83
|
+
listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateFunctionList>;
|
|
84
|
+
/**
|
|
85
|
+
* Get function template
|
|
86
|
+
*
|
|
87
|
+
* Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
88
|
+
*
|
|
89
|
+
* @param {string} templateId
|
|
90
|
+
* @throws {AppwriteException}
|
|
91
|
+
* @returns {Promise<Models.TemplateFunction>}
|
|
92
|
+
*/
|
|
93
|
+
getTemplate(templateId: string): Promise<Models.TemplateFunction>;
|
|
60
94
|
/**
|
|
61
95
|
* Get function
|
|
62
96
|
*
|
|
@@ -89,10 +123,11 @@ declare class Functions {
|
|
|
89
123
|
* @param {string} providerBranch
|
|
90
124
|
* @param {boolean} providerSilentMode
|
|
91
125
|
* @param {string} providerRootDirectory
|
|
126
|
+
* @param {string} specification
|
|
92
127
|
* @throws {AppwriteException}
|
|
93
128
|
* @returns {Promise<Models.Function>}
|
|
94
129
|
*/
|
|
95
|
-
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
|
|
130
|
+
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
|
|
96
131
|
/**
|
|
97
132
|
* Delete function
|
|
98
133
|
*
|
|
@@ -145,7 +180,7 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
145
180
|
*/
|
|
146
181
|
getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
|
|
147
182
|
/**
|
|
148
|
-
* Update
|
|
183
|
+
* Update deployment
|
|
149
184
|
*
|
|
150
185
|
* Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.
|
|
151
186
|
*
|
|
@@ -188,7 +223,7 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
188
223
|
*/
|
|
189
224
|
updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
|
|
190
225
|
/**
|
|
191
|
-
* Download
|
|
226
|
+
* Download deployment
|
|
192
227
|
*
|
|
193
228
|
* Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
|
|
194
229
|
*
|
|
@@ -197,7 +232,7 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
197
232
|
* @throws {AppwriteException}
|
|
198
233
|
* @returns {Promise<ArrayBuffer>}
|
|
199
234
|
*/
|
|
200
|
-
|
|
235
|
+
getDeploymentDownload(functionId: string, deploymentId: string): Promise<ArrayBuffer>;
|
|
201
236
|
/**
|
|
202
237
|
* List executions
|
|
203
238
|
*
|
|
@@ -61,11 +61,12 @@ class Functions {
|
|
|
61
61
|
* @param {string} templateRepository
|
|
62
62
|
* @param {string} templateOwner
|
|
63
63
|
* @param {string} templateRootDirectory
|
|
64
|
-
* @param {string}
|
|
64
|
+
* @param {string} templateVersion
|
|
65
|
+
* @param {string} specification
|
|
65
66
|
* @throws {AppwriteException}
|
|
66
67
|
* @returns {Promise<Models.Function>}
|
|
67
68
|
*/
|
|
68
|
-
async create(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, scopes, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, templateRepository, templateOwner, templateRootDirectory,
|
|
69
|
+
async create(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, scopes, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, templateRepository, templateOwner, templateRootDirectory, templateVersion, specification) {
|
|
69
70
|
if (typeof functionId === "undefined") {
|
|
70
71
|
throw new client.AppwriteException('Missing required parameter: "functionId"');
|
|
71
72
|
}
|
|
@@ -137,8 +138,11 @@ class Functions {
|
|
|
137
138
|
if (typeof templateRootDirectory !== "undefined") {
|
|
138
139
|
payload["templateRootDirectory"] = templateRootDirectory;
|
|
139
140
|
}
|
|
140
|
-
if (typeof
|
|
141
|
-
payload["
|
|
141
|
+
if (typeof templateVersion !== "undefined") {
|
|
142
|
+
payload["templateVersion"] = templateVersion;
|
|
143
|
+
}
|
|
144
|
+
if (typeof specification !== "undefined") {
|
|
145
|
+
payload["specification"] = specification;
|
|
142
146
|
}
|
|
143
147
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
144
148
|
const apiHeaders = {
|
|
@@ -173,6 +177,93 @@ class Functions {
|
|
|
173
177
|
payload
|
|
174
178
|
);
|
|
175
179
|
}
|
|
180
|
+
/**
|
|
181
|
+
* List available function runtime specifications
|
|
182
|
+
*
|
|
183
|
+
* List allowed function specifications for this instance.
|
|
184
|
+
|
|
185
|
+
*
|
|
186
|
+
* @throws {AppwriteException}
|
|
187
|
+
* @returns {Promise<Models.SpecificationList>}
|
|
188
|
+
*/
|
|
189
|
+
async listSpecifications() {
|
|
190
|
+
const apiPath = "/functions/specifications";
|
|
191
|
+
const payload = {};
|
|
192
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
193
|
+
const apiHeaders = {
|
|
194
|
+
"content-type": "application/json"
|
|
195
|
+
};
|
|
196
|
+
return await this.client.call(
|
|
197
|
+
"get",
|
|
198
|
+
uri,
|
|
199
|
+
apiHeaders,
|
|
200
|
+
payload
|
|
201
|
+
);
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* List function templates
|
|
205
|
+
*
|
|
206
|
+
* List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
207
|
+
*
|
|
208
|
+
* @param {string[]} runtimes
|
|
209
|
+
* @param {string[]} useCases
|
|
210
|
+
* @param {number} limit
|
|
211
|
+
* @param {number} offset
|
|
212
|
+
* @throws {AppwriteException}
|
|
213
|
+
* @returns {Promise<Models.TemplateFunctionList>}
|
|
214
|
+
*/
|
|
215
|
+
async listTemplates(runtimes, useCases, limit, offset) {
|
|
216
|
+
const apiPath = "/functions/templates";
|
|
217
|
+
const payload = {};
|
|
218
|
+
if (typeof runtimes !== "undefined") {
|
|
219
|
+
payload["runtimes"] = runtimes;
|
|
220
|
+
}
|
|
221
|
+
if (typeof useCases !== "undefined") {
|
|
222
|
+
payload["useCases"] = useCases;
|
|
223
|
+
}
|
|
224
|
+
if (typeof limit !== "undefined") {
|
|
225
|
+
payload["limit"] = limit;
|
|
226
|
+
}
|
|
227
|
+
if (typeof offset !== "undefined") {
|
|
228
|
+
payload["offset"] = offset;
|
|
229
|
+
}
|
|
230
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
231
|
+
const apiHeaders = {
|
|
232
|
+
"content-type": "application/json"
|
|
233
|
+
};
|
|
234
|
+
return await this.client.call(
|
|
235
|
+
"get",
|
|
236
|
+
uri,
|
|
237
|
+
apiHeaders,
|
|
238
|
+
payload
|
|
239
|
+
);
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Get function template
|
|
243
|
+
*
|
|
244
|
+
* Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
245
|
+
*
|
|
246
|
+
* @param {string} templateId
|
|
247
|
+
* @throws {AppwriteException}
|
|
248
|
+
* @returns {Promise<Models.TemplateFunction>}
|
|
249
|
+
*/
|
|
250
|
+
async getTemplate(templateId) {
|
|
251
|
+
if (typeof templateId === "undefined") {
|
|
252
|
+
throw new client.AppwriteException('Missing required parameter: "templateId"');
|
|
253
|
+
}
|
|
254
|
+
const apiPath = "/functions/templates/{templateId}".replace("{templateId}", templateId);
|
|
255
|
+
const payload = {};
|
|
256
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
257
|
+
const apiHeaders = {
|
|
258
|
+
"content-type": "application/json"
|
|
259
|
+
};
|
|
260
|
+
return await this.client.call(
|
|
261
|
+
"get",
|
|
262
|
+
uri,
|
|
263
|
+
apiHeaders,
|
|
264
|
+
payload
|
|
265
|
+
);
|
|
266
|
+
}
|
|
176
267
|
/**
|
|
177
268
|
* Get function
|
|
178
269
|
*
|
|
@@ -221,10 +312,11 @@ class Functions {
|
|
|
221
312
|
* @param {string} providerBranch
|
|
222
313
|
* @param {boolean} providerSilentMode
|
|
223
314
|
* @param {string} providerRootDirectory
|
|
315
|
+
* @param {string} specification
|
|
224
316
|
* @throws {AppwriteException}
|
|
225
317
|
* @returns {Promise<Models.Function>}
|
|
226
318
|
*/
|
|
227
|
-
async update(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, scopes, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory) {
|
|
319
|
+
async update(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, scopes, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, specification) {
|
|
228
320
|
if (typeof functionId === "undefined") {
|
|
229
321
|
throw new client.AppwriteException('Missing required parameter: "functionId"');
|
|
230
322
|
}
|
|
@@ -281,6 +373,9 @@ class Functions {
|
|
|
281
373
|
if (typeof providerRootDirectory !== "undefined") {
|
|
282
374
|
payload["providerRootDirectory"] = providerRootDirectory;
|
|
283
375
|
}
|
|
376
|
+
if (typeof specification !== "undefined") {
|
|
377
|
+
payload["specification"] = specification;
|
|
378
|
+
}
|
|
284
379
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
285
380
|
const apiHeaders = {
|
|
286
381
|
"content-type": "application/json"
|
|
@@ -437,7 +532,7 @@ class Functions {
|
|
|
437
532
|
);
|
|
438
533
|
}
|
|
439
534
|
/**
|
|
440
|
-
* Update
|
|
535
|
+
* Update deployment
|
|
441
536
|
*
|
|
442
537
|
* Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.
|
|
443
538
|
*
|
|
@@ -559,7 +654,7 @@ class Functions {
|
|
|
559
654
|
);
|
|
560
655
|
}
|
|
561
656
|
/**
|
|
562
|
-
* Download
|
|
657
|
+
* Download deployment
|
|
563
658
|
*
|
|
564
659
|
* Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
|
|
565
660
|
*
|
|
@@ -568,7 +663,7 @@ class Functions {
|
|
|
568
663
|
* @throws {AppwriteException}
|
|
569
664
|
* @returns {Promise<ArrayBuffer>}
|
|
570
665
|
*/
|
|
571
|
-
async
|
|
666
|
+
async getDeploymentDownload(functionId, deploymentId) {
|
|
572
667
|
if (typeof functionId === "undefined") {
|
|
573
668
|
throw new client.AppwriteException('Missing required parameter: "functionId"');
|
|
574
669
|
}
|