From d61addf9bdb8b7cdf11a14a69bde397ab67c2810 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 13 May 2026 12:29:23 +0000 Subject: [PATCH] chore: update API specs and SDK examples --- specs/latest/open-api3-latest-client.json | 1655 +++++- specs/latest/open-api3-latest-console.json | 5828 ++++++++++++------ specs/latest/open-api3-latest-server.json | 6176 ++++++++++++++------ specs/latest/swagger2-latest-client.json | 1798 +++++- specs/latest/swagger2-latest-console.json | 5642 ++++++++++++------ specs/latest/swagger2-latest-server.json | 6080 +++++++++++++------ 6 files changed, 19692 insertions(+), 7487 deletions(-) diff --git a/specs/latest/open-api3-latest-client.json b/specs/latest/open-api3-latest-client.json index ae403fcc..5c04ff25 100644 --- a/specs/latest/open-api3-latest-client.json +++ b/specs/latest/open-api3-latest-client.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "version": "1.9.3", + "version": "1.9.5", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -555,7 +555,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 166, + "weight": 165, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -627,7 +627,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 168, + "weight": 167, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -751,7 +751,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 169, + "weight": 168, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -891,7 +891,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 170, + "weight": 169, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1015,7 +1015,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 174, + "weight": 173, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1149,7 +1149,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 175, + "weight": 174, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1287,7 +1287,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 167, + "weight": 166, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1388,7 +1388,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 173, + "weight": 172, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1487,7 +1487,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 171, + "weight": 170, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1586,7 +1586,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 172, + "weight": 171, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -4059,7 +4059,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 177, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4187,7 +4187,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 176, + "weight": 175, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4321,7 +4321,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 180, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4381,7 +4381,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 178, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4871,7 +4871,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 179, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4955,7 +4955,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 182, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5049,7 +5049,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 181, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5143,7 +5143,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 183, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5896,7 +5896,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 755, + "weight": 772, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -5963,7 +5963,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 751, + "weight": 768, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6034,7 +6034,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 752, + "weight": 769, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6098,7 +6098,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 753, + "weight": 770, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6176,7 +6176,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 754, + "weight": 771, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6242,7 +6242,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 756, + "weight": 773, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6327,7 +6327,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 897, + "weight": 916, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6451,7 +6451,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 698, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6612,7 +6612,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 699, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6723,7 +6723,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 702, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6878,7 +6878,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 700, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -6990,7 +6990,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 704, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7097,7 +7097,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 709, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7226,7 +7226,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 708, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7355,7 +7355,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 862, + "weight": 881, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -7422,7 +7422,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 858, + "weight": 877, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -7493,7 +7493,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 859, + "weight": 878, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -7557,7 +7557,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 860, + "weight": 879, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -7635,7 +7635,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 861, + "weight": 880, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -7701,7 +7701,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 863, + "weight": 882, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -7785,7 +7785,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 898, + "weight": 917, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -7905,7 +7905,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 847, + "weight": 866, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -8082,7 +8082,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 848, + "weight": 867, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -8189,7 +8189,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 851, + "weight": 870, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -8334,7 +8334,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 849, + "weight": 868, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -8440,7 +8440,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 853, + "weight": 872, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -8542,7 +8542,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 857, + "weight": 876, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -8665,7 +8665,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 856, + "weight": 875, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -8788,7 +8788,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 432, + "weight": 441, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -8878,7 +8878,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 430, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -8999,7 +8999,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 431, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -9077,7 +9077,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 117, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -9131,7 +9131,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 116, + "weight": 115, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -9617,7 +9617,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 150, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -9701,7 +9701,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 154, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -9753,21 +9753,21 @@ ] } }, - "\/storage\/buckets\/{bucketId}\/files": { + "\/presences": { "get": { - "summary": "List files", - "operationId": "storageListFiles", + "summary": "List presences", + "operationId": "presencesList", "tags": [ - "storage" + "presences" ], - "description": "Get a list of all the user files. You can use the query params to filter your results.", + "description": "List presence logs.", "responses": { "200": { - "description": "Files List", + "description": "Presences List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/fileList" + "$ref": "#\/components\/schemas\/presenceList" } } } @@ -9775,25 +9775,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "listFiles", - "group": "files", - "weight": 544, + "method": "list", + "group": "presences", + "weight": 419, "cookies": false, "type": "", - "demo": "storage\/list-files.md", + "demo": "presences\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "presences.read", "platforms": [ "console", - "client", "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [] } @@ -9806,19 +9805,9 @@ } ], "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "description": "Array of query strings generated using the Query class provided by the SDK.", "required": false, "schema": { "type": "array", @@ -9830,43 +9819,46 @@ "in": "query" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, "schema": { - "type": "string", - "x-example": "", - "default": "" + "type": "boolean", + "x-example": false, + "default": true }, "in": "query" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 }, "in": "query" } ] - }, - "post": { - "summary": "Create file", - "operationId": "storageCreateFile", + } + }, + "\/presences\/{presenceId}": { + "get": { + "summary": "Get presence", + "operationId": "presencesGet", "tags": [ - "storage" + "presences" ], - "description": "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.\n\nLarger 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.\n\nWhen 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.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "description": "Get a presence log by its unique ID.", "responses": { - "201": { - "description": "File", + "200": { + "description": "Presence", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/file" + "$ref": "#\/components\/schemas\/presence" } } } @@ -9874,25 +9866,24 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFile", - "group": "files", - "weight": 1187, + "method": "get", + "group": "presences", + "weight": 418, "cookies": false, - "type": "upload", - "demo": "storage\/create-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", - "scope": "files.write", + "type": "", + "demo": "presences\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.read", "platforms": [ "console", - "client", "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [] } @@ -9906,69 +9897,166 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "presenceId", + "description": "Presence unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Upsert presence", + "operationId": "presencesUpsert", + "tags": [ + "presences" + ], + "description": "Create or update a presence log by its unique ID.", + "responses": { + "200": { + "description": "Presence", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/presence" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsert", + "group": "presences", + "weight": 416, + "cookies": false, + "type": "", + "demo": "presences\/upsert.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "client" + ], + "packaging": false, + "public": true, + "methods": [ + { + "name": "upsert", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "presenceId", + "status", + "permissions", + "expiresAt", + "metadata" + ], + "required": [ + "presenceId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/presence" + } + ], + "description": "", + "demo": "presences\/upsert.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } ], "requestBody": { "content": { - "multipart\/form-data": { + "application\/json": { "schema": { "type": "object", "properties": { - "fileId": { + "userId": { "type": "string", - "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", - "x-upload-id": true + "description": "User ID.", + "x-example": "", + "x-nullable": true }, - "file": { + "status": { "type": "string", - "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "x-example": null, - "format": "binary" + "description": "Presence status.", + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": "[\"read(\"any\")\"]", "items": { "type": "string" }, "x-nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "x-example": "{}" } }, "required": [ - "fileId", - "file" + "status" ] } } } } - } - }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "Get file", - "operationId": "storageGetFile", + }, + "patch": { + "summary": "Update presence", + "operationId": "presencesUpdate", "tags": [ - "storage" + "presences" ], - "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", + "description": "Update a presence log by its unique ID.", "responses": { "200": { - "description": "File", + "description": "Presence", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/file" + "$ref": "#\/components\/schemas\/presence" } } } @@ -9976,25 +10064,51 @@ }, "deprecated": false, "x-appwrite": { - "method": "getFile", - "group": "files", - "weight": 543, + "method": "update", + "group": "presences", + "weight": 420, "cookies": false, "type": "", - "demo": "storage\/get-file.md", + "demo": "presences\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "presences.write", "platforms": [ - "console", - "client", - "server", - "server" + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", + "methods": [ + { + "name": "update", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "presenceId", + "status", + "expiresAt", + "metadata", + "permissions", + "purge" + ], + "required": [ + "presenceId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/presence" + } + ], + "description": "", + "demo": "presences\/update.md", + "public": true + } + ], "auth": { "Project": [] } @@ -10002,23 +10116,707 @@ "security": [ { "Project": [], - "Session": [], - "JWT": [] + "Session": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "presenceId", + "description": "Presence unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "fileId", + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "", + "x-nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "x-example": "{}", + "x-nullable": true + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "purge": { + "type": "boolean", + "description": "When true, purge cached responses used by list presences endpoint.", + "x-example": false + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete presence", + "operationId": "presencesDelete", + "tags": [ + "presences" + ], + "description": "Delete a presence log by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "presences", + "weight": 421, + "cookies": false, + "type": "", + "demo": "presences\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/reports": { + "get": { + "summary": "List reports", + "operationId": "advisorListReports", + "tags": [ + "advisor" + ], + "description": "Get a list of all the project's analyzer reports. You can use the query params to filter your results.\n", + "responses": { + "200": { + "description": "Reports List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/reportList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listReports", + "group": "reports", + "weight": 693, + "cookies": false, + "type": "", + "demo": "advisor\/list-reports.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-reports.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "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: appId, type, targetType, target, analyzedAt", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/reports\/{reportId}": { + "get": { + "summary": "Get report", + "operationId": "advisorGetReport", + "tags": [ + "advisor" + ], + "description": "Get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.\n", + "responses": { + "200": { + "description": "Report", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/report" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getReport", + "group": "reports", + "weight": 692, + "cookies": false, + "type": "", + "demo": "advisor\/get-report.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-report.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Report ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/reports\/{reportId}\/insights": { + "get": { + "summary": "List insights", + "operationId": "advisorListInsights", + "tags": [ + "advisor" + ], + "description": "List the insights produced under a single analyzer report. You can use the query params to filter your results further.\n", + "responses": { + "200": { + "description": "Insights List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/insightList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listInsights", + "group": "insights", + "weight": 696, + "cookies": false, + "type": "", + "demo": "advisor\/list-insights.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "insights.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-insights.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Parent report ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "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: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/reports\/{reportId}\/insights\/{insightId}": { + "get": { + "summary": "Get insight", + "operationId": "advisorGetInsight", + "tags": [ + "advisor" + ], + "description": "Get an insight by its unique ID, scoped to its parent report.\n", + "responses": { + "200": { + "description": "Insight", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/insight" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getInsight", + "group": "insights", + "weight": 695, + "cookies": false, + "type": "", + "demo": "advisor\/get-insight.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "insights.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-insight.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Parent report ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "insightId", + "description": "Insight ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files": { + "get": { + "summary": "List files", + "operationId": "storageListFiles", + "tags": [ + "storage" + ], + "description": "Get a list of all the user files. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Files List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/fileList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listFiles", + "group": "files", + "weight": 553, + "cookies": false, + "type": "", + "demo": "storage\/list-files.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "files.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create file", + "operationId": "storageCreateFile", + "tags": [ + "storage" + ], + "description": "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.\n\nLarger 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.\n\nWhen 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.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "responses": { + "201": { + "description": "File", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/file" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createFile", + "group": "files", + "weight": 1206, + "cookies": false, + "type": "upload", + "demo": "storage\/create-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", + "scope": "files.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "multipart\/form-data": { + "schema": { + "type": "object", + "properties": { + "fileId": { + "type": "string", + "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "", + "x-upload-id": true + }, + "file": { + "type": "string", + "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", + "x-example": null, + "format": "binary" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "required": [ + "fileId", + "file" + ] + } + } + } + } + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "get": { + "summary": "Get file", + "operationId": "storageGetFile", + "tags": [ + "storage" + ], + "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", + "responses": { + "200": { + "description": "File", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/file" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getFile", + "group": "files", + "weight": 552, + "cookies": false, + "type": "", + "demo": "storage\/get-file.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "files.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "fileId", "description": "File ID.", "required": true, "schema": { @@ -10052,7 +10850,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 545, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -10144,7 +10942,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 546, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -10213,7 +11011,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 548, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -10293,7 +11091,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 547, + "weight": 556, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -10523,7 +11321,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 549, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -10610,7 +11408,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 828, + "weight": 847, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -10680,7 +11478,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 824, + "weight": 843, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -10754,7 +11552,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 825, + "weight": 844, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -10821,7 +11619,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 826, + "weight": 845, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -10902,7 +11700,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 827, + "weight": 846, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -10971,7 +11769,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 829, + "weight": 848, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -11059,7 +11857,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 899, + "weight": 918, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -11182,7 +11980,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 812, + "weight": 831, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -11338,7 +12136,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 813, + "weight": 832, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -11448,7 +12246,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 816, + "weight": 835, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -11598,7 +12396,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 814, + "weight": 833, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -11709,7 +12507,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 818, + "weight": 837, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -11815,7 +12613,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 823, + "weight": 842, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -11943,7 +12741,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 822, + "weight": 841, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -12071,7 +12869,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 520, + "weight": 529, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -12160,7 +12958,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 518, + "weight": 527, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -12247,7 +13045,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 519, + "weight": 528, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -12311,7 +13109,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 522, + "weight": 531, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -12387,7 +13185,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 521, + "weight": 530, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -12453,7 +13251,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 527, + "weight": 536, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -12552,7 +13350,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 525, + "weight": 534, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -12668,7 +13466,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 526, + "weight": 535, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -12742,7 +13540,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 528, + "weight": 537, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -12831,7 +13629,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 1188, + "weight": 1207, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -12907,7 +13705,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 530, + "weight": 539, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -13007,7 +13805,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 523, + "weight": 532, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -13070,7 +13868,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 524, + "weight": 533, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -13154,7 +13952,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 895, + "weight": 914, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -13221,7 +14019,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 891, + "weight": 910, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -13292,7 +14090,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 892, + "weight": 911, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -13356,7 +14154,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 893, + "weight": 912, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -13434,7 +14232,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 894, + "weight": 913, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -13500,7 +14298,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 896, + "weight": 915, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -13585,7 +14383,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 885, + "weight": 904, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -13705,7 +14503,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 881, + "weight": 900, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -13855,7 +14653,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 884, + "weight": 903, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -13962,7 +14760,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 883, + "weight": 902, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -14107,7 +14905,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 882, + "weight": 901, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -14213,7 +15011,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 886, + "weight": 905, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -14454,18 +15252,46 @@ "type": "array", "description": "List of documents.", "items": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/document" + }, + "x-example": "" + } + }, + "required": [ + "total", + "documents" + ], + "example": { + "total": 5, + "documents": "" + } + }, + "presenceList": { + "description": "Presences List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of presences that matched your query.", + "x-example": 5, + "format": "int32" + }, + "presences": { + "type": "array", + "description": "List of presences.", + "items": { + "$ref": "#\/components\/schemas\/presence" }, "x-example": "" } }, "required": [ "total", - "documents" + "presences" ], "example": { "total": 5, - "documents": "" + "presences": "" } }, "sessionList": { @@ -14860,6 +15686,62 @@ "transactions": "" } }, + "insightList": { + "description": "Insights List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of insights that matched your query.", + "x-example": 5, + "format": "int32" + }, + "insights": { + "type": "array", + "description": "List of insights.", + "items": { + "$ref": "#\/components\/schemas\/insight" + }, + "x-example": "" + } + }, + "required": [ + "total", + "insights" + ], + "example": { + "total": 5, + "insights": "" + } + }, + "reportList": { + "description": "Reports List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of reports that matched your query.", + "x-example": 5, + "format": "int32" + }, + "reports": { + "type": "array", + "description": "List of reports.", + "items": { + "$ref": "#\/components\/schemas\/report" + }, + "x-example": "" + } + }, + "required": [ + "total", + "reports" + ], + "example": { + "total": 5, + "reports": "" + } + }, "row": { "description": "Row", "type": "object", @@ -15005,6 +15887,89 @@ "isAdmin": false } }, + "presence": { + "description": "Presence", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Presence ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "string", + "description": "Presence sequence ID.", + "x-example": "1", + "readOnly": true + }, + "$createdAt": { + "type": "string", + "description": "Presence creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Presence update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Presence permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "674af8f3e12a5f9ac0be" + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "online", + "nullable": true + }, + "source": { + "type": "string", + "description": "Presence source.", + "x-example": "HTTP" + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "additionalProperties": true, + "x-additional-properties-key": "metadata", + "required": [ + "$id", + "$sequence", + "$createdAt", + "$updatedAt", + "$permissions", + "userId", + "source" + ], + "example": { + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "userId": "674af8f3e12a5f9ac0be", + "status": "online", + "source": "HTTP", + "expiresAt": "2020-10-15T06:38:00.000+00:00" + } + }, "log": { "description": "Log", "type": "object", @@ -17047,6 +18012,298 @@ "identifier": "token", "expired": false } + }, + "insight": { + "description": "Insight", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Insight ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Insight creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Insight update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "reportId": { + "type": "string", + "description": "Parent report ID. Insights always belong to a report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).", + "x-example": "tablesDBIndex" + }, + "severity": { + "type": "string", + "description": "Insight severity. One of info, warning, critical.", + "x-example": "warning" + }, + "status": { + "type": "string", + "description": "Insight status. One of active, dismissed.", + "x-example": "active" + }, + "resourceType": { + "type": "string", + "description": "Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.", + "x-example": "databases" + }, + "resourceId": { + "type": "string", + "description": "ID of the resource the insight is about.", + "x-example": "main" + }, + "parentResourceType": { + "type": "string", + "description": "Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table \u2192 resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.", + "x-example": "tables" + }, + "parentResourceId": { + "type": "string", + "description": "ID of the parent resource. Empty when the resource has no parent.", + "x-example": "orders" + }, + "title": { + "type": "string", + "description": "Insight title.", + "x-example": "Missing index on collection orders" + }, + "summary": { + "type": "string", + "description": "Short markdown summary describing the insight.", + "x-example": "Queries against `orders.status` are scanning the full collection." + }, + "ctas": { + "type": "array", + "description": "List of call-to-action buttons attached to this insight.", + "items": { + "$ref": "#\/components\/schemas\/insightCTA" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the insight was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + }, + "dismissedAt": { + "type": "string", + "description": "Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + }, + "dismissedBy": { + "type": "string", + "description": "User ID that dismissed the insight. Empty when not dismissed.", + "x-example": "5e5ea5c16897e", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "reportId", + "type", + "severity", + "status", + "resourceType", + "resourceId", + "parentResourceType", + "parentResourceId", + "title", + "summary", + "ctas" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "reportId": "5e5ea5c16897e", + "type": "tablesDBIndex", + "severity": "warning", + "status": "active", + "resourceType": "databases", + "resourceId": "main", + "parentResourceType": "tables", + "parentResourceId": "orders", + "title": "Missing index on collection orders", + "summary": "Queries against `orders.status` are scanning the full collection.", + "ctas": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedBy": "5e5ea5c16897e" + } + }, + "insightCTA": { + "description": "InsightCTA", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Human-readable label for the CTA, used in UI.", + "x-example": "Create missing index" + }, + "service": { + "type": "string", + "description": "Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource \u2014 for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.", + "x-example": "tablesDB" + }, + "method": { + "type": "string", + "description": "Public API method on the chosen service the client should invoke when this CTA is triggered.", + "x-example": "createIndex" + }, + "params": { + "type": "object", + "description": "Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId\/tableId\/columns for tablesDB, databaseId\/collectionId\/attributes for the legacy Databases API).", + "x-example": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "required": [ + "label", + "service", + "method", + "params" + ], + "example": { + "label": "Create missing index", + "service": "tablesDB", + "method": "createIndex", + "params": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "report": { + "description": "Report", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Report ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Report creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Report update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "ID of the third-party app that submitted the report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.", + "x-example": "lighthouse" + }, + "title": { + "type": "string", + "description": "Short, human-readable title for the report.", + "x-example": "Lighthouse audit for https:\/\/appwrite.io\/" + }, + "summary": { + "type": "string", + "description": "Markdown summary describing the report.", + "x-example": "Performance score 78. 4 opportunities found." + }, + "targetType": { + "type": "string", + "description": "Plural noun describing what the report analyzes, e.g. databases, sites, urls.", + "x-example": "urls" + }, + "target": { + "type": "string", + "description": "Free-form target identifier (URL for lighthouse, resource ID for db).", + "x-example": "https:\/\/appwrite.io\/" + }, + "categories": { + "type": "array", + "description": "Categories covered by the report, e.g. performance, accessibility.", + "items": { + "type": "string" + }, + "x-example": [ + "performance", + "accessibility" + ] + }, + "insights": { + "type": "array", + "description": "Insights nested under this report.", + "items": { + "$ref": "#\/components\/schemas\/insight" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the report was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "type", + "title", + "summary", + "targetType", + "target", + "categories", + "insights" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "type": "lighthouse", + "title": "Lighthouse audit for https:\/\/appwrite.io\/", + "summary": "Performance score 78. 4 opportunities found.", + "targetType": "urls", + "target": "https:\/\/appwrite.io\/", + "categories": [ + "performance", + "accessibility" + ], + "insights": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00" + } } }, "securitySchemes": { diff --git a/specs/latest/open-api3-latest-console.json b/specs/latest/open-api3-latest-console.json index 56206f54..1d665a20 100644 --- a/specs/latest/open-api3-latest-console.json +++ b/specs/latest/open-api3-latest-console.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "version": "1.9.3", + "version": "1.9.5", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -229,7 +229,7 @@ "x-appwrite": { "method": "listBillingAddresses", "group": null, - "weight": 1076, + "weight": 1094, "cookies": false, "type": "", "demo": "account\/list-billing-addresses.md", @@ -291,7 +291,7 @@ "x-appwrite": { "method": "createBillingAddress", "group": null, - "weight": 1074, + "weight": 1092, "cookies": false, "type": "", "demo": "account\/create-billing-address.md", @@ -386,7 +386,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 1075, + "weight": 1093, "cookies": false, "type": "", "demo": "account\/get-billing-address.md", @@ -445,7 +445,7 @@ "x-appwrite": { "method": "updateBillingAddress", "group": null, - "weight": 1077, + "weight": 1095, "cookies": false, "type": "", "demo": "account\/update-billing-address.md", @@ -543,7 +543,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 1078, + "weight": 1096, "cookies": false, "type": "", "demo": "account\/delete-billing-address.md", @@ -604,7 +604,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 1080, + "weight": 1098, "cookies": false, "type": "", "demo": "account\/get-coupon.md", @@ -882,7 +882,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 1079, + "weight": 1097, "cookies": false, "type": "", "demo": "account\/list-invoices.md", @@ -1016,7 +1016,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1062, + "weight": 1080, "cookies": false, "type": "", "demo": "account\/list-keys.md", @@ -1075,7 +1075,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1063, + "weight": 1081, "cookies": false, "type": "", "demo": "account\/create-key.md", @@ -1165,7 +1165,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1066, + "weight": 1084, "cookies": false, "type": "", "demo": "account\/get-key.md", @@ -1223,7 +1223,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1065, + "weight": 1083, "cookies": false, "type": "", "demo": "account\/update-key.md", @@ -1316,7 +1316,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1064, + "weight": 1082, "cookies": false, "type": "", "demo": "account\/delete-key.md", @@ -1455,7 +1455,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 166, + "weight": 165, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -1527,7 +1527,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 168, + "weight": 167, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -1651,7 +1651,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 169, + "weight": 168, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -1791,7 +1791,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 170, + "weight": 169, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1915,7 +1915,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 174, + "weight": 173, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -2049,7 +2049,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 175, + "weight": 174, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -2187,7 +2187,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 167, + "weight": 166, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -2288,7 +2288,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 173, + "weight": 172, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -2387,7 +2387,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 171, + "weight": 170, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -2486,7 +2486,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 172, + "weight": 171, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2737,7 +2737,7 @@ "x-appwrite": { "method": "listPaymentMethods", "group": null, - "weight": 1069, + "weight": 1087, "cookies": false, "type": "", "demo": "account\/list-payment-methods.md", @@ -2799,7 +2799,7 @@ "x-appwrite": { "method": "createPaymentMethod", "group": null, - "weight": 1067, + "weight": 1085, "cookies": false, "type": "", "demo": "account\/create-payment-method.md", @@ -2848,7 +2848,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 1068, + "weight": 1086, "cookies": false, "type": "", "demo": "account\/get-payment-method.md", @@ -2907,7 +2907,7 @@ "x-appwrite": { "method": "updatePaymentMethod", "group": null, - "weight": 1070, + "weight": 1088, "cookies": false, "type": "", "demo": "account\/update-payment-method.md", @@ -2991,7 +2991,7 @@ "x-appwrite": { "method": "deletePaymentMethod", "group": null, - "weight": 1073, + "weight": 1091, "cookies": false, "type": "", "demo": "account\/delete-payment-method.md", @@ -3052,7 +3052,7 @@ "x-appwrite": { "method": "updatePaymentMethodProvider", "group": null, - "weight": 1071, + "weight": 1089, "cookies": false, "type": "", "demo": "account\/update-payment-method-provider.md", @@ -3144,7 +3144,7 @@ "x-appwrite": { "method": "updatePaymentMethodMandateOptions", "group": null, - "weight": 1072, + "weight": 1090, "cookies": false, "type": "", "demo": "account\/update-payment-method-mandate-options.md", @@ -5434,7 +5434,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 1185, + "weight": 1204, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -5497,7 +5497,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 1186, + "weight": 1205, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -5553,7 +5553,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 177, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -5682,7 +5682,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 176, + "weight": 175, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -5817,7 +5817,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 180, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -5878,7 +5878,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 178, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -6369,7 +6369,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 179, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -6454,7 +6454,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 182, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -6549,7 +6549,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 181, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -6644,7 +6644,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 183, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -7398,7 +7398,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 1056, + "weight": 1073, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -7462,7 +7462,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 1057, + "weight": 1074, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -7551,7 +7551,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 1055, + "weight": 1072, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -7605,7 +7605,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 1058, + "weight": 1075, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -7668,7 +7668,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 1051, + "weight": 1068, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -7735,7 +7735,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 1052, + "weight": 1069, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -7856,7 +7856,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 1050, + "weight": 1067, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -7920,7 +7920,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 1053, + "weight": 1070, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -8012,7 +8012,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 1054, + "weight": 1071, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -8078,7 +8078,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 1061, + "weight": 1078, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -8177,7 +8177,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 1060, + "weight": 1077, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -8243,7 +8243,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 1059, + "weight": 1076, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -8299,7 +8299,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 500, + "weight": 509, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -8367,7 +8367,7 @@ "x-appwrite": { "method": "getCampaign", "group": null, - "weight": 912, + "weight": 931, "cookies": false, "type": "", "demo": "console\/get-campaign.md", @@ -8428,7 +8428,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 909, + "weight": 928, "cookies": false, "type": "", "demo": "console\/get-coupon.md", @@ -8489,7 +8489,7 @@ "x-appwrite": { "method": "listOAuth2Providers", "group": "console", - "weight": 498, + "weight": 507, "cookies": false, "type": "", "demo": "console\/list-o-auth-2-providers.md", @@ -8537,7 +8537,7 @@ "x-appwrite": { "method": "getPlans", "group": null, - "weight": 907, + "weight": 926, "cookies": false, "type": "", "demo": "console\/get-plans.md", @@ -8605,7 +8605,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 908, + "weight": 927, "cookies": false, "type": "", "demo": "console\/get-plan.md", @@ -8666,7 +8666,7 @@ "x-appwrite": { "method": "getProgram", "group": null, - "weight": 910, + "weight": 929, "cookies": false, "type": "", "demo": "console\/get-program.md", @@ -8727,7 +8727,7 @@ "x-appwrite": { "method": "createProgramMembership", "group": null, - "weight": 911, + "weight": 930, "cookies": false, "type": "", "demo": "console\/create-program-membership.md", @@ -8788,7 +8788,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 906, + "weight": 925, "cookies": false, "type": "", "demo": "console\/list-regions.md", @@ -8830,7 +8830,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 501, + "weight": 510, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -8905,7 +8905,7 @@ "x-appwrite": { "method": "listProjectScopes", "group": "console", - "weight": 499, + "weight": 508, "cookies": false, "type": "", "demo": "console\/list-project-scopes.md", @@ -8953,7 +8953,7 @@ "x-appwrite": { "method": "createSource", "group": null, - "weight": 913, + "weight": 932, "cookies": false, "type": "", "demo": "console\/create-source.md", @@ -9044,7 +9044,7 @@ "x-appwrite": { "method": "suggestColumns", "group": null, - "weight": 914, + "weight": 933, "cookies": false, "type": "", "demo": "console\/suggest-columns.md", @@ -9149,7 +9149,7 @@ "x-appwrite": { "method": "suggestIndexes", "group": null, - "weight": 915, + "weight": 934, "cookies": false, "type": "", "demo": "console\/suggest-indexes.md", @@ -9227,7 +9227,7 @@ "tags": [ "console" ], - "description": "Suggest valid Appwrite query JSON objects for a supported list resource from free-text user intent. The endpoint picks a validator based on `type` \u2014 for system resources it uses the static validator and its allowed attributes, and for user-owned table rows it loads the table schema and validates against those attributes at request time. The returned queries are guaranteed to parse and pass the relevant queries validator.\n", + "description": "Suggest valid Appwrite query JSON objects for a supported list resource from free-text user intent. The endpoint picks a validator based on `resource` \u2014 for system resources it uses the static validator and its allowed attributes, and for user-owned table rows it loads the table schema and validates against those attributes at request time. The returned queries are guaranteed to parse and pass the relevant queries validator.\n", "responses": { "200": { "description": "Any", @@ -9244,7 +9244,7 @@ "x-appwrite": { "method": "suggestQueries", "group": null, - "weight": 916, + "weight": 935, "cookies": false, "type": "", "demo": "console\/suggest-queries.md", @@ -9269,8 +9269,8 @@ ], "parameters": [ { - "name": "type", - "description": "Resource list type to generate queries for.", + "name": "resource", + "description": "Resource to generate queries for.", "required": true, "schema": { "type": "string", @@ -9304,6 +9304,8 @@ "repositories", "vcscomments", "vcscommentlocks", + "reports", + "insights", "users", "cache", "tokens", @@ -9347,10 +9349,86 @@ "resourcetokens", "transactions", "transactionlogs", + "presencelogs", "stats" ], - "x-enum-name": null, - "x-enum-keys": [] + "x-enum-name": "QuerySuggestionResource", + "x-enum-keys": [ + "activities", + "activity_events", + "archives", + "credits", + "dns_records", + "domains", + "invoices", + "payment_methods", + "policies", + "projects", + "restorations", + "team_aggregations", + "teams", + "databases", + "tables", + "rows", + "schedules", + "platforms", + "keys", + "dev_keys", + "webhooks", + "certificates", + "realtime", + "rules", + "installations", + "repositories", + "vcs_comments", + "vcs_comment_locks", + "reports", + "insights", + "users", + "cache", + "tokens", + "authenticators", + "challenges", + "sessions", + "identities", + "memberships", + "buckets", + "providers", + "messages", + "topics", + "subscribers", + "targets", + "companies", + "billing_addresses", + "billing_aggregations", + "billing_aggregation_resources", + "billing_team_project_aggregations", + "billing_team_aggregations_v2", + "billing_team_aggregation_resources", + "billing_invoices_v2", + "billing_addons", + "alerts", + "payments", + "billing_discounts", + "sources", + "deals", + "blocks", + "threats", + "feedbacks", + "sh_installations", + "attributes", + "indexes", + "functions", + "sites", + "deployments", + "executions", + "variables", + "migrations", + "resource_tokens", + "transactions", + "transaction_logs", + "stats" + ] }, "in": "query" }, @@ -9366,7 +9444,7 @@ }, { "name": "databaseId", - "description": "Database ID. Required when type is `tables` or `rows`.", + "description": "Database ID. Required when resource is `tables` or `rows`.", "required": false, "schema": { "type": "string", @@ -9376,7 +9454,7 @@ }, { "name": "tableId", - "description": "Table ID. Required when type is `rows`.", + "description": "Table ID. Required when resource is `rows`.", "required": false, "schema": { "type": "string", @@ -9411,7 +9489,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 497, + "weight": 506, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -9459,7 +9537,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 687, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -9578,7 +9656,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 683, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -9695,7 +9773,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 755, + "weight": 772, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -9763,7 +9841,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 751, + "weight": 768, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -9835,7 +9913,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 752, + "weight": 769, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -9900,7 +9978,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 753, + "weight": 770, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -9979,7 +10057,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 754, + "weight": 771, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -10046,7 +10124,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 756, + "weight": 773, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -10132,7 +10210,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 690, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -10236,7 +10314,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 684, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -10330,7 +10408,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 685, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -10440,7 +10518,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 686, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -10535,7 +10613,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 695, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -10635,7 +10713,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 691, + "weight": 706, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -10762,7 +10840,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 692, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -10837,7 +10915,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 693, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -10945,7 +11023,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 694, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -11022,7 +11100,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 712, + "weight": 727, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -11099,21 +11177,21 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint": { "post": { - "summary": "Create boolean attribute", - "operationId": "databasesCreateBooleanAttribute", + "summary": "Create bigint attribute", + "operationId": "databasesCreateBigIntAttribute", "tags": [ "databases" ], - "description": "Create a boolean attribute.\n", + "description": "Create a bigint attribute. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/attributeBigint" } } } @@ -11121,12 +11199,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createBooleanAttribute", + "method": "createBigIntAttribute", "group": "attributes", - "weight": 713, + "weight": 740, "cookies": false, "type": "", - "demo": "databases\/create-boolean-attribute.md", + "demo": "databases\/create-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11137,10 +11215,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createBooleanColumn" + "replaceWith": "tablesDB.createBigIntColumn" }, "auth": { "Project": [] @@ -11165,7 +11243,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -11190,10 +11268,25 @@ "description": "Is attribute required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -11212,21 +11305,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint\/{key}": { "patch": { - "summary": "Update boolean attribute", - "operationId": "databasesUpdateBooleanAttribute", + "summary": "Update bigint attribute", + "operationId": "databasesUpdateBigIntAttribute", "tags": [ "databases" ], - "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a bigint attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/attributeBigint" } } } @@ -11234,12 +11327,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateBooleanAttribute", + "method": "updateBigIntAttribute", "group": "attributes", - "weight": 714, + "weight": 741, "cookies": false, "type": "", - "demo": "databases\/update-boolean-attribute.md", + "demo": "databases\/update-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11250,10 +11343,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateBooleanColumn" + "replaceWith": "tablesDB.updateBigIntColumn" }, "auth": { "Project": [] @@ -11278,7 +11371,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -11307,15 +11400,30 @@ "description": "Is attribute required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null, "x-nullable": true } @@ -11330,21 +11438,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { "post": { - "summary": "Create datetime attribute", - "operationId": "databasesCreateDatetimeAttribute", + "summary": "Create boolean attribute", + "operationId": "databasesCreateBooleanAttribute", "tags": [ "databases" ], - "description": "Create a date time attribute according to the ISO 8601 standard.", + "description": "Create a boolean attribute.\n", "responses": { "202": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeDatetime" + "$ref": "#\/components\/schemas\/attributeBoolean" } } } @@ -11352,12 +11460,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDatetimeAttribute", + "method": "createBooleanAttribute", "group": "attributes", - "weight": 715, + "weight": 728, "cookies": false, "type": "", - "demo": "databases\/create-datetime-attribute.md", + "demo": "databases\/create-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11368,10 +11476,241 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createDatetimeColumn" + "replaceWith": "tablesDB.createBooleanColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "patch": { + "summary": "Update boolean attribute", + "operationId": "databasesUpdateBooleanAttribute", + "tags": [ + "databases" + ], + "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "responses": { + "200": { + "description": "AttributeBoolean", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeBoolean" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateBooleanAttribute", + "group": "attributes", + "weight": 729, + "cookies": false, + "type": "", + "demo": "databases\/update-boolean-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateBooleanColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New attribute key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { + "post": { + "summary": "Create datetime attribute", + "operationId": "databasesCreateDatetimeAttribute", + "tags": [ + "databases" + ], + "description": "Create a date time attribute according to the ISO 8601 standard.", + "responses": { + "202": { + "description": "AttributeDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeDatetime" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "createDatetimeAttribute", + "group": "attributes", + "weight": 730, + "cookies": false, + "type": "", + "demo": "databases\/create-datetime-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createDatetimeColumn" }, "auth": { "Project": [] @@ -11468,7 +11807,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 716, + "weight": 731, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -11587,7 +11926,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 717, + "weight": 732, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -11701,7 +12040,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 718, + "weight": 733, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -11820,7 +12159,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 719, + "weight": 734, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -11942,7 +12281,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 720, + "weight": 735, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -12069,7 +12408,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 721, + "weight": 736, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -12197,7 +12536,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 722, + "weight": 737, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -12330,7 +12669,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 723, + "weight": 738, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -12458,7 +12797,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 724, + "weight": 739, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -12591,7 +12930,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 725, + "weight": 742, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -12704,7 +13043,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 726, + "weight": 743, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -12822,7 +13161,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 727, + "weight": 744, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -12937,7 +13276,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 728, + "weight": 745, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -13061,7 +13400,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 745, + "weight": 762, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -13175,7 +13514,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 746, + "weight": 763, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -13289,7 +13628,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 743, + "weight": 760, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -13403,7 +13742,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 744, + "weight": 761, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -13517,7 +13856,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 729, + "weight": 746, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -13632,7 +13971,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 730, + "weight": 747, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -13756,7 +14095,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 731, + "weight": 748, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -13871,7 +14210,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 732, + "weight": 749, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -13995,7 +14334,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 733, + "weight": 750, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -14134,7 +14473,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 734, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -14249,7 +14588,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 735, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -14374,7 +14713,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 736, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -14499,7 +14838,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 741, + "weight": 758, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -14613,7 +14952,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 742, + "weight": 759, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -14727,7 +15066,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 737, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -14841,7 +15180,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 738, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -14960,7 +15299,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 739, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -15081,7 +15420,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 740, + "weight": 757, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -15284,7 +15623,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 710, + "weight": 725, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -15361,7 +15700,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 711, + "weight": 726, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -15447,7 +15786,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 897, + "weight": 916, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -15572,7 +15911,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 698, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -15764,7 +16103,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 703, + "weight": 718, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -15901,7 +16240,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 701, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -16006,7 +16345,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 705, + "weight": 720, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -16108,7 +16447,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 699, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -16220,7 +16559,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 702, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -16376,7 +16715,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 700, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -16489,7 +16828,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 704, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -16597,7 +16936,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 707, + "weight": 722, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -16695,7 +17034,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 709, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -16825,7 +17164,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 708, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -16955,7 +17294,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 750, + "weight": 767, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -17054,7 +17393,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 747, + "weight": 764, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -17195,7 +17534,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 748, + "weight": 765, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -17272,7 +17611,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 749, + "weight": 766, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -17358,7 +17697,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 696, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -17446,7 +17785,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 697, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -17543,7 +17882,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 688, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -17651,7 +17990,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 689, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -17768,7 +18107,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 834, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -17854,7 +18193,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 830, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -17935,7 +18274,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 862, + "weight": 881, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -18003,7 +18342,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 858, + "weight": 877, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -18075,7 +18414,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 859, + "weight": 878, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -18140,7 +18479,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 860, + "weight": 879, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -18219,7 +18558,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 861, + "weight": 880, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -18286,7 +18625,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 836, + "weight": 855, "cookies": false, "type": "", "demo": "documentsdb\/list-usage.md", @@ -18382,7 +18721,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 831, + "weight": 850, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -18443,7 +18782,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 832, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -18521,7 +18860,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 833, + "weight": 852, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -18584,7 +18923,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 841, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -18680,7 +19019,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 837, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -18803,7 +19142,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 838, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -18874,7 +19213,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 839, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -18980,7 +19319,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 840, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -19053,7 +19392,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 898, + "weight": 917, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -19174,7 +19513,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 847, + "weight": 866, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -19350,7 +19689,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 852, + "weight": 871, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -19478,7 +19817,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 850, + "weight": 869, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -19578,7 +19917,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 854, + "weight": 873, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -19675,7 +20014,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 848, + "weight": 867, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -19783,7 +20122,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 851, + "weight": 870, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -19929,7 +20268,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 849, + "weight": 868, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -20036,7 +20375,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 853, + "weight": 872, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -20139,7 +20478,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 857, + "weight": 876, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -20263,7 +20602,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 856, + "weight": 875, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -20387,7 +20726,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 846, + "weight": 865, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -20482,7 +20821,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 843, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -20618,7 +20957,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 844, + "weight": 863, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -20691,7 +21030,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 845, + "weight": 864, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -20773,7 +21112,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 842, + "weight": 861, "cookies": false, "type": "", "demo": "documentsdb\/get-collection-usage.md", @@ -20866,7 +21205,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 835, + "weight": 854, "cookies": false, "type": "", "demo": "documentsdb\/get-usage.md", @@ -20975,7 +21314,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 922, + "weight": 941, "cookies": false, "type": "", "demo": "domains\/list.md", @@ -21047,7 +21386,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 917, + "weight": 936, "cookies": false, "type": "", "demo": "domains\/create.md", @@ -21120,7 +21459,7 @@ "x-appwrite": { "method": "getPrice", "group": null, - "weight": 920, + "weight": 939, "cookies": false, "type": "", "demo": "domains\/get-price.md", @@ -21209,7 +21548,7 @@ "x-appwrite": { "method": "createPurchase", "group": null, - "weight": 967, + "weight": 986, "cookies": false, "type": "", "demo": "domains\/create-purchase.md", @@ -21341,7 +21680,7 @@ "x-appwrite": { "method": "updatePurchase", "group": null, - "weight": 968, + "weight": 987, "cookies": false, "type": "", "demo": "domains\/update-purchase.md", @@ -21420,7 +21759,7 @@ "x-appwrite": { "method": "listSuggestions", "group": null, - "weight": 966, + "weight": 985, "cookies": false, "type": "", "demo": "domains\/list-suggestions.md", @@ -21539,7 +21878,7 @@ "x-appwrite": { "method": "createTransferIn", "group": null, - "weight": 927, + "weight": 946, "cookies": false, "type": "", "demo": "domains\/create-transfer-in.md", @@ -21629,7 +21968,7 @@ "x-appwrite": { "method": "updateTransferIn", "group": null, - "weight": 928, + "weight": 947, "cookies": false, "type": "", "demo": "domains\/update-transfer-in.md", @@ -21708,7 +22047,7 @@ "x-appwrite": { "method": "createTransferOut", "group": null, - "weight": 929, + "weight": 948, "cookies": false, "type": "", "demo": "domains\/create-transfer-out.md", @@ -21781,7 +22120,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 919, + "weight": 938, "cookies": false, "type": "", "demo": "domains\/get.md", @@ -21832,7 +22171,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 918, + "weight": 937, "cookies": false, "type": "", "demo": "domains\/delete.md", @@ -21892,7 +22231,7 @@ "x-appwrite": { "method": "updateAutoRenewal", "group": null, - "weight": 923, + "weight": 942, "cookies": false, "type": "", "demo": "domains\/update-auto-renewal.md", @@ -21971,7 +22310,7 @@ "x-appwrite": { "method": "updateNameservers", "group": null, - "weight": 924, + "weight": 943, "cookies": false, "type": "", "demo": "domains\/update-nameservers.md", @@ -22031,7 +22370,7 @@ "x-appwrite": { "method": "getPresetGoogleWorkspace", "group": null, - "weight": 955, + "weight": 974, "cookies": false, "type": "", "demo": "domains\/get-preset-google-workspace.md", @@ -22089,7 +22428,7 @@ "x-appwrite": { "method": "createPresetGoogleWorkspace", "group": null, - "weight": 954, + "weight": 973, "cookies": false, "type": "", "demo": "domains\/create-preset-google-workspace.md", @@ -22149,7 +22488,7 @@ "x-appwrite": { "method": "getPresetICloud", "group": null, - "weight": 965, + "weight": 984, "cookies": false, "type": "", "demo": "domains\/get-preset-i-cloud.md", @@ -22207,7 +22546,7 @@ "x-appwrite": { "method": "createPresetICloud", "group": null, - "weight": 964, + "weight": 983, "cookies": false, "type": "", "demo": "domains\/create-preset-i-cloud.md", @@ -22267,7 +22606,7 @@ "x-appwrite": { "method": "getPresetMailgun", "group": null, - "weight": 957, + "weight": 976, "cookies": false, "type": "", "demo": "domains\/get-preset-mailgun.md", @@ -22325,7 +22664,7 @@ "x-appwrite": { "method": "createPresetMailgun", "group": null, - "weight": 956, + "weight": 975, "cookies": false, "type": "", "demo": "domains\/create-preset-mailgun.md", @@ -22385,7 +22724,7 @@ "x-appwrite": { "method": "getPresetOutlook", "group": null, - "weight": 963, + "weight": 982, "cookies": false, "type": "", "demo": "domains\/get-preset-outlook.md", @@ -22443,7 +22782,7 @@ "x-appwrite": { "method": "createPresetOutlook", "group": null, - "weight": 962, + "weight": 981, "cookies": false, "type": "", "demo": "domains\/create-preset-outlook.md", @@ -22503,7 +22842,7 @@ "x-appwrite": { "method": "getPresetProtonMail", "group": null, - "weight": 961, + "weight": 980, "cookies": false, "type": "", "demo": "domains\/get-preset-proton-mail.md", @@ -22561,7 +22900,7 @@ "x-appwrite": { "method": "createPresetProtonMail", "group": null, - "weight": 960, + "weight": 979, "cookies": false, "type": "", "demo": "domains\/create-preset-proton-mail.md", @@ -22621,7 +22960,7 @@ "x-appwrite": { "method": "getPresetZoho", "group": null, - "weight": 959, + "weight": 978, "cookies": false, "type": "", "demo": "domains\/get-preset-zoho.md", @@ -22679,7 +23018,7 @@ "x-appwrite": { "method": "createPresetZoho", "group": null, - "weight": 958, + "weight": 977, "cookies": false, "type": "", "demo": "domains\/create-preset-zoho.md", @@ -22739,7 +23078,7 @@ "x-appwrite": { "method": "listRecords", "group": null, - "weight": 953, + "weight": 972, "cookies": false, "type": "", "demo": "domains\/list-records.md", @@ -22812,7 +23151,7 @@ "x-appwrite": { "method": "createRecordA", "group": null, - "weight": 931, + "weight": 950, "cookies": false, "type": "", "demo": "domains\/create-record-a.md", @@ -22909,7 +23248,7 @@ "x-appwrite": { "method": "updateRecordA", "group": null, - "weight": 932, + "weight": 951, "cookies": false, "type": "", "demo": "domains\/update-record-a.md", @@ -23016,7 +23355,7 @@ "x-appwrite": { "method": "createRecordAAAA", "group": null, - "weight": 933, + "weight": 952, "cookies": false, "type": "", "demo": "domains\/create-record-aaaa.md", @@ -23113,7 +23452,7 @@ "x-appwrite": { "method": "updateRecordAAAA", "group": null, - "weight": 934, + "weight": 953, "cookies": false, "type": "", "demo": "domains\/update-record-aaaa.md", @@ -23220,7 +23559,7 @@ "x-appwrite": { "method": "createRecordAlias", "group": null, - "weight": 935, + "weight": 954, "cookies": false, "type": "", "demo": "domains\/create-record-alias.md", @@ -23317,7 +23656,7 @@ "x-appwrite": { "method": "updateRecordAlias", "group": null, - "weight": 936, + "weight": 955, "cookies": false, "type": "", "demo": "domains\/update-record-alias.md", @@ -23424,7 +23763,7 @@ "x-appwrite": { "method": "createRecordCAA", "group": null, - "weight": 937, + "weight": 956, "cookies": false, "type": "", "demo": "domains\/create-record-caa.md", @@ -23521,7 +23860,7 @@ "x-appwrite": { "method": "updateRecordCAA", "group": null, - "weight": 938, + "weight": 957, "cookies": false, "type": "", "demo": "domains\/update-record-caa.md", @@ -23628,7 +23967,7 @@ "x-appwrite": { "method": "createRecordCNAME", "group": null, - "weight": 939, + "weight": 958, "cookies": false, "type": "", "demo": "domains\/create-record-cname.md", @@ -23725,7 +24064,7 @@ "x-appwrite": { "method": "updateRecordCNAME", "group": null, - "weight": 940, + "weight": 959, "cookies": false, "type": "", "demo": "domains\/update-record-cname.md", @@ -23832,7 +24171,7 @@ "x-appwrite": { "method": "createRecordHTTPS", "group": null, - "weight": 941, + "weight": 960, "cookies": false, "type": "", "demo": "domains\/create-record-https.md", @@ -23929,7 +24268,7 @@ "x-appwrite": { "method": "updateRecordHTTPS", "group": null, - "weight": 942, + "weight": 961, "cookies": false, "type": "", "demo": "domains\/update-record-https.md", @@ -24036,7 +24375,7 @@ "x-appwrite": { "method": "createRecordMX", "group": null, - "weight": 943, + "weight": 962, "cookies": false, "type": "", "demo": "domains\/create-record-mx.md", @@ -24140,7 +24479,7 @@ "x-appwrite": { "method": "updateRecordMX", "group": null, - "weight": 944, + "weight": 963, "cookies": false, "type": "", "demo": "domains\/update-record-mx.md", @@ -24254,7 +24593,7 @@ "x-appwrite": { "method": "createRecordNS", "group": null, - "weight": 945, + "weight": 964, "cookies": false, "type": "", "demo": "domains\/create-record-ns.md", @@ -24351,7 +24690,7 @@ "x-appwrite": { "method": "updateRecordNS", "group": null, - "weight": 946, + "weight": 965, "cookies": false, "type": "", "demo": "domains\/update-record-ns.md", @@ -24458,7 +24797,7 @@ "x-appwrite": { "method": "createRecordSRV", "group": null, - "weight": 947, + "weight": 966, "cookies": false, "type": "", "demo": "domains\/create-record-srv.md", @@ -24576,7 +24915,7 @@ "x-appwrite": { "method": "updateRecordSRV", "group": null, - "weight": 948, + "weight": 967, "cookies": false, "type": "", "demo": "domains\/update-record-srv.md", @@ -24704,7 +25043,7 @@ "x-appwrite": { "method": "createRecordTXT", "group": null, - "weight": 949, + "weight": 968, "cookies": false, "type": "", "demo": "domains\/create-record-txt.md", @@ -24800,7 +25139,7 @@ "x-appwrite": { "method": "updateRecordTXT", "group": null, - "weight": 950, + "weight": 969, "cookies": false, "type": "", "demo": "domains\/update-record-txt.md", @@ -24907,7 +25246,7 @@ "x-appwrite": { "method": "getRecord", "group": null, - "weight": 952, + "weight": 971, "cookies": false, "type": "", "demo": "domains\/get-record.md", @@ -24968,7 +25307,7 @@ "x-appwrite": { "method": "deleteRecord", "group": null, - "weight": 951, + "weight": 970, "cookies": false, "type": "", "demo": "domains\/delete-record.md", @@ -25038,7 +25377,7 @@ "x-appwrite": { "method": "updateTeam", "group": null, - "weight": 926, + "weight": 945, "cookies": false, "type": "", "demo": "domains\/update-team.md", @@ -25117,7 +25456,7 @@ "x-appwrite": { "method": "getTransferStatus", "group": null, - "weight": 930, + "weight": 949, "cookies": false, "type": "", "demo": "domains\/get-transfer-status.md", @@ -25170,7 +25509,7 @@ "x-appwrite": { "method": "getZone", "group": null, - "weight": 921, + "weight": 940, "cookies": false, "type": "", "demo": "domains\/get-zone.md", @@ -25228,7 +25567,7 @@ "x-appwrite": { "method": "updateZone", "group": null, - "weight": 925, + "weight": 944, "cookies": false, "type": "", "demo": "domains\/update-zone.md", @@ -25307,7 +25646,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 416, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -25392,7 +25731,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 900, + "weight": 919, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -25651,6 +25990,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -25663,8 +26004,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -25756,7 +26101,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 418, + "weight": 427, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -25806,7 +26151,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 419, + "weight": 428, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -25856,7 +26201,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 442, + "weight": 451, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -26074,7 +26419,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 441, + "weight": 450, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -26134,7 +26479,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 435, + "weight": 444, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -26206,7 +26551,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 414, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -26266,7 +26611,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 901, + "weight": 920, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -26532,6 +26877,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -26544,8 +26891,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -26627,7 +26978,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 417, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -26689,7 +27040,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 422, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -26770,7 +27121,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 423, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -26865,7 +27216,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 420, + "weight": 429, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -26965,7 +27316,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 428, + "weight": 437, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -27051,7 +27402,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 425, + "weight": 434, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -27168,7 +27519,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 426, + "weight": 435, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -27266,7 +27617,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 421, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -27329,7 +27680,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 424, + "weight": 433, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -27394,7 +27745,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 427, + "weight": 436, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -27485,7 +27836,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 429, + "weight": 438, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -27557,7 +27908,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 432, + "weight": 441, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -27648,7 +27999,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 430, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -27770,7 +28121,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 431, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -27840,7 +28191,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 433, + "weight": 442, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -27915,7 +28266,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 434, + "weight": 443, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -27997,7 +28348,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 438, + "weight": 447, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -28031,6 +28382,30 @@ "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "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: key, resourceType, resourceId, secret", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } ] }, @@ -28057,7 +28432,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 902, + "weight": 921, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -28099,6 +28474,11 @@ "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -28116,6 +28496,7 @@ } }, "required": [ + "variableId", "key", "value" ] @@ -28149,7 +28530,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 437, + "weight": 446, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -28219,7 +28600,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 439, + "weight": 448, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -28274,7 +28655,8 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -28288,10 +28670,7 @@ "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } } @@ -28313,7 +28692,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 440, + "weight": 449, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -28385,7 +28764,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 117, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -28440,7 +28819,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 116, + "weight": 115, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -28495,7 +28874,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 443, + "weight": 452, "cookies": false, "type": "", "demo": "health\/get.md", @@ -28546,7 +28925,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 452, + "weight": 461, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -28597,7 +28976,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 446, + "weight": 455, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -28648,7 +29027,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 449, + "weight": 458, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -28710,7 +29089,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 1044, + "weight": 1061, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -28785,7 +29164,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 445, + "weight": 454, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -28836,7 +29215,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 447, + "weight": 456, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -28887,7 +29266,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 453, + "weight": 462, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -28951,7 +29330,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 1040, + "weight": 1057, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -29015,7 +29394,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 1039, + "weight": 1056, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -29079,7 +29458,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 457, + "weight": 466, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -29143,7 +29522,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 1041, + "weight": 1058, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -29207,7 +29586,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 456, + "weight": 465, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -29271,7 +29650,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 458, + "weight": 467, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -29346,7 +29725,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 459, + "weight": 468, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -29410,7 +29789,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 466, + "weight": 475, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -29501,7 +29880,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 463, + "weight": 472, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -29565,7 +29944,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 455, + "weight": 464, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -29629,7 +30008,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 460, + "weight": 469, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -29693,7 +30072,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 461, + "weight": 470, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -29757,7 +30136,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 462, + "weight": 471, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -29821,7 +30200,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 1042, + "weight": 1059, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -29885,7 +30264,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 464, + "weight": 473, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -29949,7 +30328,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 465, + "weight": 474, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -30013,7 +30392,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 1043, + "weight": 1060, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -30077,7 +30456,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 454, + "weight": 463, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -30141,7 +30520,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 451, + "weight": 460, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -30192,7 +30571,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 450, + "weight": 459, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -30243,7 +30622,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 448, + "weight": 457, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -30734,7 +31113,7 @@ "x-appwrite": { "method": "createBlock", "group": null, - "weight": 975, + "weight": 994, "cookies": false, "type": "", "demo": "manager\/create-block.md", @@ -30826,7 +31205,7 @@ "x-appwrite": { "method": "deleteBlock", "group": null, - "weight": 977, + "weight": 996, "cookies": false, "type": "", "demo": "manager\/delete-block.md", @@ -30909,7 +31288,7 @@ "x-appwrite": { "method": "listBlocks", "group": null, - "weight": 976, + "weight": 995, "cookies": false, "type": "", "demo": "manager\/list-blocks.md", @@ -30961,7 +31340,7 @@ "x-appwrite": { "method": "updateUserStatus", "group": "users", - "weight": 978, + "weight": 997, "cookies": false, "type": "", "demo": "manager\/update-user-status.md", @@ -31035,7 +31414,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 158, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -31123,7 +31502,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 155, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -31270,7 +31649,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 162, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -31429,7 +31808,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 157, + "weight": 156, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -31608,7 +31987,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 164, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -31807,7 +32186,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 156, + "weight": 155, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -31989,7 +32368,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 163, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -32177,7 +32556,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 161, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -32231,7 +32610,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 165, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -32294,7 +32673,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 159, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -32381,7 +32760,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 160, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -32468,7 +32847,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 129, + "weight": 128, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -32556,7 +32935,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 128, + "weight": 127, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -32735,7 +33114,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 142, + "weight": 141, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -32916,7 +33295,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 127, + "weight": 126, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -33068,7 +33447,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 141, + "weight": 140, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -33221,7 +33600,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 118, + "weight": 117, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -33341,7 +33720,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 132, + "weight": 131, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -33463,7 +33842,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 122, + "weight": 121, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -33560,7 +33939,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 136, + "weight": 135, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -33660,7 +34039,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 120, + "weight": 119, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -33769,7 +34148,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 134, + "weight": 133, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -33880,7 +34259,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 119, + "weight": 118, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -33989,7 +34368,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 133, + "weight": 132, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -34100,7 +34479,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 121, + "weight": 120, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -34334,7 +34713,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 135, + "weight": 134, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -34567,7 +34946,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 123, + "weight": 122, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -34665,7 +35044,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 137, + "weight": 136, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -34765,7 +35144,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 124, + "weight": 123, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -34863,7 +35242,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 138, + "weight": 137, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -34963,7 +35342,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 125, + "weight": 124, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -35061,7 +35440,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 139, + "weight": 138, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -35161,7 +35540,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 126, + "weight": 125, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -35259,7 +35638,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 140, + "weight": 139, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -35359,7 +35738,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 131, + "weight": 130, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -35413,7 +35792,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 143, + "weight": 142, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -35476,7 +35855,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 130, + "weight": 129, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -35563,7 +35942,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 152, + "weight": 151, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -35650,7 +36029,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 145, + "weight": 144, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -35736,7 +36115,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 144, + "weight": 143, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -35820,7 +36199,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 147, + "weight": 146, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -35881,7 +36260,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 148, + "weight": 147, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -35961,7 +36340,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 149, + "weight": 148, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -36024,7 +36403,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 146, + "weight": 145, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -36111,7 +36490,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 151, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -36207,7 +36586,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 150, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -36299,7 +36678,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 153, + "weight": 152, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -36363,7 +36742,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 154, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -36440,7 +36819,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 572, + "weight": 581, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -36526,7 +36905,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 576, + "weight": 585, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -36608,6 +36987,18 @@ "type": "string", "description": "Source API Key", "x-example": "" + }, + "onDuplicate": { + "type": "string", + "description": "Behavior when a row with an existing $id is encountered. \"fail\" (default): abort on first conflict. \"skip\": silently ignore. \"overwrite\": replace existing row.", + "x-example": "fail", + "enum": [ + "fail", + "skip", + "overwrite" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ @@ -36646,7 +37037,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 577, + "weight": 1079, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -36770,7 +37161,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 585, + "weight": 594, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -36885,7 +37276,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 584, + "weight": 593, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -36933,6 +37324,18 @@ "type": "boolean", "description": "Is the file stored in an internal bucket?", "x-example": false + }, + "onDuplicate": { + "type": "string", + "description": "Behavior when a row with an existing $id is encountered. \"fail\" (default): abort on first conflict. \"skip\": silently ignore. \"overwrite\": replace existing row.", + "x-example": "fail", + "enum": [ + "fail", + "skip", + "overwrite" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ @@ -36970,7 +37373,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 578, + "weight": 587, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -37061,7 +37464,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 579, + "weight": 588, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -37148,7 +37551,7 @@ "x-appwrite": { "method": "createJSONExport", "group": null, - "weight": 587, + "weight": 596, "cookies": false, "type": "", "demo": "migrations\/create-json-export.md", @@ -37243,7 +37646,7 @@ "x-appwrite": { "method": "createJSONImport", "group": null, - "weight": 586, + "weight": 595, "cookies": false, "type": "", "demo": "migrations\/create-json-import.md", @@ -37291,6 +37694,18 @@ "type": "boolean", "description": "Is the file stored in an internal bucket?", "x-example": false + }, + "onDuplicate": { + "type": "string", + "description": "Behavior when a row with an existing $id is encountered. \"fail\" (default): abort on first conflict. \"skip\": silently ignore. \"overwrite\": replace existing row.", + "x-example": "fail", + "enum": [ + "fail", + "skip", + "overwrite" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ @@ -37328,7 +37743,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 582, + "weight": 591, "cookies": false, "type": "", "demo": "migrations\/create-n-host-migration.md", @@ -37456,7 +37871,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 583, + "weight": 592, "cookies": false, "type": "", "demo": "migrations\/get-n-host-report.md", @@ -37605,7 +38020,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 580, + "weight": 589, "cookies": false, "type": "", "demo": "migrations\/create-supabase-migration.md", @@ -37728,7 +38143,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 581, + "weight": 590, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -37868,7 +38283,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 573, + "weight": 582, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -37927,7 +38342,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 574, + "weight": 583, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -37979,7 +38394,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 575, + "weight": 584, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -38040,7 +38455,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 990, + "weight": 1007, "cookies": false, "type": "", "demo": "organizations\/list.md", @@ -38120,7 +38535,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 989, + "weight": 1006, "cookies": false, "type": "", "demo": "organizations\/create.md", @@ -38250,7 +38665,7 @@ "x-appwrite": { "method": "estimationCreateOrganization", "group": null, - "weight": 1024, + "weight": 1041, "cookies": false, "type": "", "demo": "organizations\/estimation-create-organization.md", @@ -38342,7 +38757,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 991, + "weight": 1008, "cookies": false, "type": "", "demo": "organizations\/delete.md", @@ -38403,7 +38818,7 @@ "x-appwrite": { "method": "listAddons", "group": null, - "weight": 1032, + "weight": 1049, "cookies": false, "type": "", "demo": "organizations\/list-addons.md", @@ -38464,7 +38879,7 @@ "x-appwrite": { "method": "createBaaAddon", "group": null, - "weight": 1035, + "weight": 1052, "cookies": false, "type": "", "demo": "organizations\/create-baa-addon.md", @@ -38525,7 +38940,7 @@ "x-appwrite": { "method": "getAddon", "group": null, - "weight": 1033, + "weight": 1050, "cookies": false, "type": "", "demo": "organizations\/get-addon.md", @@ -38587,7 +39002,7 @@ "x-appwrite": { "method": "deleteAddon", "group": null, - "weight": 1036, + "weight": 1053, "cookies": false, "type": "", "demo": "organizations\/delete-addon.md", @@ -38658,7 +39073,7 @@ "x-appwrite": { "method": "confirmAddonPayment", "group": null, - "weight": 1037, + "weight": 1054, "cookies": false, "type": "", "demo": "organizations\/confirm-addon-payment.md", @@ -38729,7 +39144,7 @@ "x-appwrite": { "method": "getAddonPrice", "group": null, - "weight": 1034, + "weight": 1051, "cookies": false, "type": "", "demo": "organizations\/get-addon-price.md", @@ -38805,7 +39220,7 @@ "x-appwrite": { "method": "listAggregations", "group": null, - "weight": 1006, + "weight": 1023, "cookies": false, "type": "", "demo": "organizations\/list-aggregations.md", @@ -38879,7 +39294,7 @@ "x-appwrite": { "method": "getAggregation", "group": null, - "weight": 1007, + "weight": 1024, "cookies": false, "type": "", "demo": "organizations\/get-aggregation.md", @@ -38973,7 +39388,7 @@ "x-appwrite": { "method": "setBillingAddress", "group": null, - "weight": 999, + "weight": 1016, "cookies": false, "type": "", "demo": "organizations\/set-billing-address.md", @@ -39044,7 +39459,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 1000, + "weight": 1017, "cookies": false, "type": "", "demo": "organizations\/delete-billing-address.md", @@ -39105,7 +39520,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 998, + "weight": 1015, "cookies": false, "type": "", "demo": "organizations\/get-billing-address.md", @@ -39176,7 +39591,7 @@ "x-appwrite": { "method": "setBillingEmail", "group": null, - "weight": 1018, + "weight": 1035, "cookies": false, "type": "", "demo": "organizations\/set-billing-email.md", @@ -39257,7 +39672,7 @@ "x-appwrite": { "method": "updateBudget", "group": null, - "weight": 995, + "weight": 1012, "cookies": false, "type": "", "demo": "organizations\/update-budget.md", @@ -39347,7 +39762,7 @@ "x-appwrite": { "method": "listCredits", "group": null, - "weight": 1010, + "weight": 1027, "cookies": false, "type": "", "demo": "organizations\/list-credits.md", @@ -39419,7 +39834,7 @@ "x-appwrite": { "method": "addCredit", "group": null, - "weight": 1011, + "weight": 1028, "cookies": false, "type": "", "demo": "organizations\/add-credit.md", @@ -39499,7 +39914,7 @@ "x-appwrite": { "method": "getAvailableCredits", "group": null, - "weight": 1009, + "weight": 1026, "cookies": false, "type": "", "demo": "organizations\/get-available-credits.md", @@ -39560,7 +39975,7 @@ "x-appwrite": { "method": "getCredit", "group": null, - "weight": 1008, + "weight": 1025, "cookies": false, "type": "", "demo": "organizations\/get-credit.md", @@ -39631,7 +40046,7 @@ "x-appwrite": { "method": "estimationDeleteOrganization", "group": null, - "weight": 1025, + "weight": 1042, "cookies": false, "type": "", "demo": "organizations\/estimation-delete-organization.md", @@ -39692,7 +40107,7 @@ "x-appwrite": { "method": "estimationUpdatePlan", "group": null, - "weight": 1022, + "weight": 1039, "cookies": false, "type": "", "demo": "organizations\/estimation-update-plan.md", @@ -39786,7 +40201,7 @@ "x-appwrite": { "method": "createDowngradeFeedback", "group": null, - "weight": 1026, + "weight": 1043, "cookies": false, "type": "", "demo": "organizations\/create-downgrade-feedback.md", @@ -39884,7 +40299,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 1013, + "weight": 1030, "cookies": false, "type": "", "demo": "organizations\/list-invoices.md", @@ -39958,7 +40373,7 @@ "x-appwrite": { "method": "getInvoice", "group": null, - "weight": 1012, + "weight": 1029, "cookies": false, "type": "", "demo": "organizations\/get-invoice.md", @@ -40029,7 +40444,7 @@ "x-appwrite": { "method": "getInvoiceDownload", "group": null, - "weight": 1016, + "weight": 1033, "cookies": false, "type": "", "demo": "organizations\/get-invoice-download.md", @@ -40100,7 +40515,7 @@ "x-appwrite": { "method": "createInvoicePayment", "group": null, - "weight": 1017, + "weight": 1034, "cookies": false, "type": "", "demo": "organizations\/create-invoice-payment.md", @@ -40190,7 +40605,7 @@ "x-appwrite": { "method": "validateInvoice", "group": null, - "weight": 1014, + "weight": 1031, "cookies": false, "type": "", "demo": "organizations\/validate-invoice.md", @@ -40261,7 +40676,7 @@ "x-appwrite": { "method": "getInvoiceView", "group": null, - "weight": 1015, + "weight": 1032, "cookies": false, "type": "", "demo": "organizations\/get-invoice-view.md", @@ -40332,7 +40747,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1029, + "weight": 1046, "cookies": false, "type": "", "demo": "organizations\/list-keys.md", @@ -40401,7 +40816,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1027, + "weight": 1044, "cookies": false, "type": "", "demo": "organizations\/create-key.md", @@ -40508,7 +40923,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1031, + "weight": 1048, "cookies": false, "type": "", "demo": "organizations\/get-key.md", @@ -40576,7 +40991,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1028, + "weight": 1045, "cookies": false, "type": "", "demo": "organizations\/update-key.md", @@ -40684,7 +41099,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1030, + "weight": 1047, "cookies": false, "type": "", "demo": "organizations\/delete-key.md", @@ -40754,7 +41169,7 @@ "x-appwrite": { "method": "setDefaultPaymentMethod", "group": null, - "weight": 1002, + "weight": 1019, "cookies": false, "type": "", "demo": "organizations\/set-default-payment-method.md", @@ -40832,7 +41247,7 @@ "x-appwrite": { "method": "deleteDefaultPaymentMethod", "group": null, - "weight": 1004, + "weight": 1021, "cookies": false, "type": "", "demo": "organizations\/delete-default-payment-method.md", @@ -40893,7 +41308,7 @@ "x-appwrite": { "method": "setBackupPaymentMethod", "group": null, - "weight": 1003, + "weight": 1020, "cookies": false, "type": "", "demo": "organizations\/set-backup-payment-method.md", @@ -40971,7 +41386,7 @@ "x-appwrite": { "method": "deleteBackupPaymentMethod", "group": null, - "weight": 1005, + "weight": 1022, "cookies": false, "type": "", "demo": "organizations\/delete-backup-payment-method.md", @@ -41032,7 +41447,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 1001, + "weight": 1018, "cookies": false, "type": "", "demo": "organizations\/get-payment-method.md", @@ -41103,7 +41518,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 992, + "weight": 1009, "cookies": false, "type": "", "demo": "organizations\/get-plan.md", @@ -41162,7 +41577,7 @@ "x-appwrite": { "method": "updatePlan", "group": null, - "weight": 993, + "weight": 1010, "cookies": false, "type": "", "demo": "organizations\/update-plan.md", @@ -41280,7 +41695,7 @@ "x-appwrite": { "method": "cancelDowngrade", "group": null, - "weight": 994, + "weight": 1011, "cookies": false, "type": "", "demo": "organizations\/cancel-downgrade.md", @@ -41341,7 +41756,7 @@ "x-appwrite": { "method": "createPlanEstimation", "group": null, - "weight": 1023, + "weight": 1040, "cookies": false, "type": "", "demo": "organizations\/create-plan-estimation.md", @@ -41435,7 +41850,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 1021, + "weight": 1038, "cookies": false, "type": "", "demo": "organizations\/list-regions.md", @@ -41496,7 +41911,7 @@ "x-appwrite": { "method": "getScopes", "group": null, - "weight": 1020, + "weight": 1037, "cookies": false, "type": "", "demo": "organizations\/get-scopes.md", @@ -41568,7 +41983,7 @@ "x-appwrite": { "method": "setBillingTaxId", "group": null, - "weight": 996, + "weight": 1013, "cookies": false, "type": "", "demo": "organizations\/set-billing-tax-id.md", @@ -41649,7 +42064,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 997, + "weight": 1014, "cookies": false, "type": "", "demo": "organizations\/get-usage.md", @@ -41732,7 +42147,7 @@ "x-appwrite": { "method": "validatePayment", "group": null, - "weight": 1019, + "weight": 1036, "cookies": false, "type": "", "demo": "organizations\/validate-payment.md", @@ -41788,33 +42203,42 @@ } } }, - "\/project": { - "delete": { - "summary": "Delete project", - "operationId": "projectDelete", + "\/presences": { + "get": { + "summary": "List presences", + "operationId": "presencesList", "tags": [ - "project" + "presences" ], - "description": "Delete a project.", + "description": "List presence logs.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Presences List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/presenceList" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": null, - "weight": 1088, + "method": "list", + "group": "presences", + "weight": 419, "cookies": false, "type": "", - "demo": "project\/delete.md", + "demo": "presences\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.read", "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, @@ -41826,26 +42250,66 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" } ] } }, - "\/project\/auth-methods\/{methodId}": { - "patch": { - "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", - "operationId": "projectUpdateAuthMethod", + "\/presences\/usage": { + "get": { + "summary": "Get presence usage", + "operationId": "presencesGetUsage", "tags": [ - "project" + "presences" ], - "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", + "description": "Get presence usage metrics and statistics, including the current total of online users and historical online user counts for the selected time range.", "responses": { "200": { - "description": "Project", + "description": "UsagePresence", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/usagePresence" } } } @@ -41853,18 +42317,88 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAuthMethod", + "method": "getUsage", "group": null, - "weight": 1137, + "weight": 417, "cookies": false, "type": "", - "demo": "project\/update-auth-method.md", + "demo": "presences\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "range", + "description": "Date range.", + "required": false, + "schema": { + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": null, + "x-enum-keys": [], + "default": "30d" + }, + "in": "query" + } + ] + } + }, + "\/presences\/{presenceId}": { + "get": { + "summary": "Get presence", + "operationId": "presencesGet", + "tags": [ + "presences" + ], + "description": "Get a presence log by its unique ID.", + "responses": { + "200": { + "description": "Presence", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/presence" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "presences", + "weight": 418, + "cookies": false, + "type": "", + "demo": "presences\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.read", "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, @@ -41876,28 +42410,110 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "methodId", - "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "name": "presenceId", + "description": "Presence unique ID.", "required": true, "schema": { "type": "string", - "x-example": "email-password", - "enum": [ - "email-password", - "magic-url", - "email-otp", - "anonymous", - "invites", - "jwt", - "phone" + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Upsert presence", + "operationId": "presencesUpsert", + "tags": [ + "presences" + ], + "description": "Create or update a presence log by its unique ID.", + "responses": { + "200": { + "description": "Presence", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/presence" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsert", + "group": "presences", + "weight": 416, + "cookies": false, + "type": "", + "demo": "presences\/upsert.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "client" + ], + "packaging": false, + "public": true, + "methods": [ + { + "name": "upsert", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "presenceId", + "userId", + "status", + "permissions", + "expiresAt", + "metadata" ], - "x-enum-name": null, - "x-enum-keys": [] + "required": [ + "presenceId", + "userId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/presence" + } + ], + "description": "", + "demo": "presences\/upsert.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -41908,36 +42524,61 @@ "schema": { "type": "object", "properties": { - "enabled": { - "type": "boolean", - "description": "Auth method status.", - "x-example": false + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "x-example": "{}" } }, "required": [ - "enabled" + "status" ] } } } } - } - }, - "\/project\/auth\/canonical-emails": { + }, "patch": { - "summary": "Update project auth canonical emails", - "operationId": "projectUpdateCanonicalEmails", + "summary": "Update presence", + "operationId": "presencesUpdate", "tags": [ - "project" + "presences" ], - "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", + "description": "Update a presence log by its unique ID.", "responses": { "200": { - "description": "Project", + "description": "Presence", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/presence" } } } @@ -41945,22 +42586,53 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateCanonicalEmails", - "group": "auth", - "weight": 1182, + "method": "update", + "group": "presences", + "weight": 420, "cookies": false, "type": "", - "demo": "project\/update-canonical-emails.md", + "demo": "presences\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.write", "platforms": [ - "console", - "server" + "client" ], "packaging": false, "public": true, + "methods": [ + { + "name": "updatePresence", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "presenceId", + "userId", + "status", + "expiresAt", + "metadata", + "permissions", + "purge" + ], + "required": [ + "presenceId", + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/presence" + } + ], + "description": "", + "demo": "presences\/update-presence.md", + "public": true + } + ], "auth": { "Project": [] } @@ -41968,7 +42640,19 @@ "security": [ { "Project": [], - "Key": [] + "Session": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -41977,34 +42661,122 @@ "schema": { "type": "object", "properties": { - "enabled": { + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "", + "x-nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "x-example": "{}", + "x-nullable": true + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "purge": { "type": "boolean", - "description": "Set whether or not to require canonical email addresses during signup and email updates.", + "description": "When true, purge cached responses used by list presences endpoint.", "x-example": false } - }, - "required": [ - "enabled" - ] + } } } } } + }, + "delete": { + "summary": "Delete presence", + "operationId": "presencesDelete", + "tags": [ + "presences" + ], + "description": "Delete a presence log by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "presences", + "weight": 421, + "cookies": false, + "type": "", + "demo": "presences\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] } }, - "\/project\/auth\/disposable-emails": { - "patch": { - "summary": "Update project auth disposable emails", - "operationId": "projectUpdateDisposableEmails", + "\/project": { + "get": { + "summary": "Get project", + "operationId": "projectGet", "tags": [ "project" ], - "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", + "description": "Get a project.", "responses": { "200": { "description": "Project", "content": { - "application\/json": { + "": { "schema": { "$ref": "#\/components\/schemas\/project" } @@ -42014,16 +42786,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDisposableEmails", - "group": "auth", - "weight": 1183, + "method": "get", + "group": null, + "weight": 1107, "cookies": false, "type": "", - "demo": "project\/update-disposable-emails.md", + "demo": "project\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "project.read", "platforms": [ "console", "server" @@ -42039,36 +42811,58 @@ "Project": [], "Key": [] } + ] + }, + "delete": { + "summary": "Delete project", + "operationId": "projectDelete", + "tags": [ + "project" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to block disposable email addresses during signup and email updates.", - "x-example": false - } - }, - "required": [ - "enabled" - ] - } - } + "description": "Delete a project.", + "responses": { + "204": { + "description": "No content" } - } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 1106, + "cookies": false, + "type": "", + "demo": "project\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] } }, - "\/project\/auth\/free-emails": { + "\/project\/auth-methods\/{methodId}": { "patch": { - "summary": "Update project auth free emails", - "operationId": "projectUpdateFreeEmails", + "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", + "operationId": "projectUpdateAuthMethod", "tags": [ "project" ], - "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", + "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", "responses": { "200": { "description": "Project", @@ -42083,12 +42877,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateFreeEmails", - "group": "auth", - "weight": 1184, + "method": "updateAuthMethod", + "group": null, + "weight": 1156, "cookies": false, "type": "", - "demo": "project\/update-free-emails.md", + "demo": "project\/update-auth-method.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42109,6 +42903,29 @@ "Key": [] } ], + "parameters": [ + { + "name": "methodId", + "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "required": true, + "schema": { + "type": "string", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "ProjectAuthMethodId", + "x-enum-keys": [] + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { @@ -42117,7 +42934,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Set whether or not to block free email addresses during signup and email updates.", + "description": "Auth method status.", "x-example": false } }, @@ -42154,7 +42971,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1104, + "weight": 1123, "cookies": false, "type": "", "demo": "project\/list-keys.md", @@ -42228,7 +43045,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1102, + "weight": 1121, "cookies": false, "type": "", "demo": "project\/create-key.md", @@ -42339,6 +43156,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -42351,8 +43170,190 @@ "schedules.write", "vcs.read", "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [] + } + }, + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + } + }, + "required": [ + "keyId", + "name", + "scopes" + ] + } + } + } + } + } + }, + "\/project\/keys\/ephemeral": { + "post": { + "summary": "Create ephemeral project key", + "operationId": "projectCreateEphemeralKey", + "tags": [ + "project" + ], + "description": "Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create a standard API key if you need a longer-lived key instead.", + "responses": { + "201": { + "description": "Ephemeral Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/ephemeralKey" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createEphemeralKey", + "group": "keys", + "weight": 1122, + "cookies": false, + "type": "", + "demo": "project\/create-ephemeral-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", "rules.read", "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -42363,186 +43364,14 @@ "domains.write", "events.read" ], - "x-enum-name": null, - "x-enum-keys": [] - } - }, - "expire": { - "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true - } - }, - "required": [ - "keyId", - "name", - "scopes" - ] - } - } - } - } - } - }, - "\/project\/keys\/ephemeral": { - "post": { - "summary": "Create ephemeral project key", - "operationId": "projectCreateEphemeralKey", - "tags": [ - "project" - ], - "description": "Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create a standard API key if you need a longer-lived key instead.", - "responses": { - "201": { - "description": "Ephemeral Key", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/ephemeralKey" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createEphemeralKey", - "group": "keys", - "weight": 1103, - "cookies": false, - "type": "", - "demo": "project\/create-ephemeral-key.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "scopes": { - "type": "array", - "description": "Key scopes list. Maximum of 100 scopes are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "mocks.read", - "mocks.write", - "policies.read", - "policies.write", - "project.policies.read", - "project.policies.write", - "templates.read", - "templates.write", - "oauth2.read", - "oauth2.write", - "users.read", - "users.write", - "sessions.read", - "sessions.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "tables.read", - "tables.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "rows.read", - "rows.write", - "collections.read", - "collections.write", - "attributes.read", - "attributes.write", - "documents.read", - "documents.write", - "buckets.read", - "buckets.write", - "files.read", - "files.write", - "tokens.read", - "tokens.write", - "functions.read", - "functions.write", - "executions.read", - "executions.write", - "execution.read", - "execution.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "providers.read", - "providers.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "messages.read", - "messages.write", - "webhooks.read", - "webhooks.write", - "locale.read", - "avatars.read", - "health.read", - "assistant.read", - "migrations.read", - "migrations.write", - "schedules.read", - "schedules.write", - "vcs.read", - "vcs.write", - "rules.read", - "rules.write", - "backups.policies.read", - "backups.policies.write", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, "duration": { "type": "integer", "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", - "x-example": 1, + "x-example": "600", "format": "int32" } }, @@ -42580,7 +43409,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1105, + "weight": 1124, "cookies": false, "type": "", "demo": "project\/get-key.md", @@ -42640,7 +43469,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1107, + "weight": 1126, "cookies": false, "type": "", "demo": "project\/update-key.md", @@ -42758,6 +43587,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -42770,8 +43601,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -42782,7 +43617,7 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, @@ -42819,7 +43654,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1106, + "weight": 1125, "cookies": false, "type": "", "demo": "project\/delete-key.md", @@ -42881,7 +43716,7 @@ "x-appwrite": { "method": "updateLabels", "group": null, - "weight": 1089, + "weight": 1108, "cookies": false, "type": "", "demo": "project\/update-labels.md", @@ -42953,7 +43788,7 @@ "x-appwrite": { "method": "listMockPhones", "group": "mocks", - "weight": 1122, + "weight": 1141, "cookies": false, "type": "", "demo": "project\/list-mock-phones.md", @@ -43027,7 +43862,7 @@ "x-appwrite": { "method": "createMockPhone", "group": "mocks", - "weight": 1121, + "weight": 1140, "cookies": false, "type": "", "demo": "project\/create-mock-phone.md", @@ -43103,7 +43938,7 @@ "x-appwrite": { "method": "getMockPhone", "group": "mocks", - "weight": 1123, + "weight": 1142, "cookies": false, "type": "", "demo": "project\/get-mock-phone.md", @@ -43164,7 +43999,7 @@ "x-appwrite": { "method": "updateMockPhone", "group": "mocks", - "weight": 1124, + "weight": 1143, "cookies": false, "type": "", "demo": "project\/update-mock-phone.md", @@ -43237,7 +44072,7 @@ "x-appwrite": { "method": "deleteMockPhone", "group": "mocks", - "weight": 1125, + "weight": 1144, "cookies": false, "type": "", "demo": "project\/delete-mock-phone.md", @@ -43300,7 +44135,7 @@ "x-appwrite": { "method": "listOAuth2Providers", "group": "oauth2", - "weight": 1138, + "weight": 1157, "cookies": false, "type": "", "demo": "project\/list-o-auth-2-providers.md", @@ -43323,6 +44158,32 @@ "Project": [], "Key": [] } + ], + "parameters": [ + { + "name": "queries", + "description": "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", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } ] } }, @@ -43350,7 +44211,7 @@ "x-appwrite": { "method": "updateOAuth2Amazon", "group": "oauth2", - "weight": 1165, + "weight": 1184, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-amazon.md", @@ -43429,7 +44290,7 @@ "x-appwrite": { "method": "updateOAuth2Apple", "group": "oauth2", - "weight": 1180, + "weight": 1199, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-apple.md", @@ -43520,7 +44381,7 @@ "x-appwrite": { "method": "updateOAuth2Auth0", "group": "oauth2", - "weight": 1174, + "weight": 1193, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-auth-0.md", @@ -43605,7 +44466,7 @@ "x-appwrite": { "method": "updateOAuth2Authentik", "group": "oauth2", - "weight": 1173, + "weight": 1192, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-authentik.md", @@ -43690,7 +44551,7 @@ "x-appwrite": { "method": "updateOAuth2Autodesk", "group": "oauth2", - "weight": 1148, + "weight": 1167, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-autodesk.md", @@ -43769,7 +44630,7 @@ "x-appwrite": { "method": "updateOAuth2Bitbucket", "group": "oauth2", - "weight": 1145, + "weight": 1164, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-bitbucket.md", @@ -43848,7 +44709,7 @@ "x-appwrite": { "method": "updateOAuth2Bitly", "group": "oauth2", - "weight": 1146, + "weight": 1165, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-bitly.md", @@ -43927,7 +44788,7 @@ "x-appwrite": { "method": "updateOAuth2Box", "group": "oauth2", - "weight": 1147, + "weight": 1166, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-box.md", @@ -44006,7 +44867,7 @@ "x-appwrite": { "method": "updateOAuth2Dailymotion", "group": "oauth2", - "weight": 1144, + "weight": 1163, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-dailymotion.md", @@ -44085,7 +44946,7 @@ "x-appwrite": { "method": "updateOAuth2Discord", "group": "oauth2", - "weight": 1141, + "weight": 1160, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-discord.md", @@ -44164,7 +45025,7 @@ "x-appwrite": { "method": "updateOAuth2Disqus", "group": "oauth2", - "weight": 1164, + "weight": 1183, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-disqus.md", @@ -44243,7 +45104,7 @@ "x-appwrite": { "method": "updateOAuth2Dropbox", "group": "oauth2", - "weight": 1143, + "weight": 1162, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-dropbox.md", @@ -44322,7 +45183,7 @@ "x-appwrite": { "method": "updateOAuth2Etsy", "group": "oauth2", - "weight": 1166, + "weight": 1185, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-etsy.md", @@ -44401,7 +45262,7 @@ "x-appwrite": { "method": "updateOAuth2Facebook", "group": "oauth2", - "weight": 1167, + "weight": 1186, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-facebook.md", @@ -44480,7 +45341,7 @@ "x-appwrite": { "method": "updateOAuth2Figma", "group": "oauth2", - "weight": 1142, + "weight": 1161, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-figma.md", @@ -44559,7 +45420,7 @@ "x-appwrite": { "method": "updateOAuth2FusionAuth", "group": "oauth2", - "weight": 1175, + "weight": 1194, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-fusion-auth.md", @@ -44644,7 +45505,7 @@ "x-appwrite": { "method": "updateOAuth2GitHub", "group": "oauth2", - "weight": 1140, + "weight": 1159, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-git-hub.md", @@ -44723,7 +45584,7 @@ "x-appwrite": { "method": "updateOAuth2Gitlab", "group": "oauth2", - "weight": 1172, + "weight": 1191, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-gitlab.md", @@ -44809,7 +45670,7 @@ "x-appwrite": { "method": "updateOAuth2Google", "group": "oauth2", - "weight": 1149, + "weight": 1168, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-google.md", @@ -44851,6 +45712,22 @@ "x-example": "", "x-nullable": true }, + "prompt": { + "type": "array", + "description": "Array of Google OAuth2 prompt values. If \"none\" is included, it must be the only element. \"none\" means: don't display any authentication or consent screens. Must not be specified with other values. \"consent\" means: prompt the user for consent. \"select_account\" means: prompt the user to select an account.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "none", + "consent", + "select_account" + ], + "x-enum-name": "ProjectOAuth2GooglePrompt", + "x-enum-keys": [] + }, + "x-nullable": true + }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", @@ -44888,7 +45765,7 @@ "x-appwrite": { "method": "updateOAuth2Keycloak", "group": "oauth2", - "weight": 1176, + "weight": 1195, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-keycloak.md", @@ -44979,7 +45856,7 @@ "x-appwrite": { "method": "updateOAuth2Kick", "group": "oauth2", - "weight": 1179, + "weight": 1198, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-kick.md", @@ -45058,7 +45935,7 @@ "x-appwrite": { "method": "updateOAuth2Linkedin", "group": "oauth2", - "weight": 1163, + "weight": 1182, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-linkedin.md", @@ -45137,7 +46014,7 @@ "x-appwrite": { "method": "updateOAuth2Microsoft", "group": "oauth2", - "weight": 1181, + "weight": 1200, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-microsoft.md", @@ -45222,7 +46099,7 @@ "x-appwrite": { "method": "updateOAuth2Notion", "group": "oauth2", - "weight": 1160, + "weight": 1179, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-notion.md", @@ -45301,7 +46178,7 @@ "x-appwrite": { "method": "updateOAuth2Oidc", "group": "oauth2", - "weight": 1177, + "weight": 1196, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-oidc.md", @@ -45357,14 +46234,14 @@ "format": "url", "x-nullable": true }, - "tokenUrl": { + "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", "x-example": "https:\/\/example.com", "format": "url", "x-nullable": true }, - "userInfoUrl": { + "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", "x-example": "https:\/\/example.com", @@ -45408,7 +46285,7 @@ "x-appwrite": { "method": "updateOAuth2Okta", "group": "oauth2", - "weight": 1178, + "weight": 1197, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-okta.md", @@ -45499,7 +46376,7 @@ "x-appwrite": { "method": "updateOAuth2Paypal", "group": "oauth2", - "weight": 1170, + "weight": 1189, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-paypal.md", @@ -45578,7 +46455,7 @@ "x-appwrite": { "method": "updateOAuth2PaypalSandbox", "group": "oauth2", - "weight": 1171, + "weight": 1190, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-paypal-sandbox.md", @@ -45657,7 +46534,7 @@ "x-appwrite": { "method": "updateOAuth2Podio", "group": "oauth2", - "weight": 1159, + "weight": 1178, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-podio.md", @@ -45736,7 +46613,7 @@ "x-appwrite": { "method": "updateOAuth2Salesforce", "group": "oauth2", - "weight": 1161, + "weight": 1180, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-salesforce.md", @@ -45815,7 +46692,7 @@ "x-appwrite": { "method": "updateOAuth2Slack", "group": "oauth2", - "weight": 1158, + "weight": 1177, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-slack.md", @@ -45894,7 +46771,7 @@ "x-appwrite": { "method": "updateOAuth2Spotify", "group": "oauth2", - "weight": 1157, + "weight": 1176, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-spotify.md", @@ -45973,7 +46850,7 @@ "x-appwrite": { "method": "updateOAuth2Stripe", "group": "oauth2", - "weight": 1156, + "weight": 1175, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-stripe.md", @@ -46052,7 +46929,7 @@ "x-appwrite": { "method": "updateOAuth2Tradeshift", "group": "oauth2", - "weight": 1168, + "weight": 1187, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-tradeshift.md", @@ -46131,7 +47008,7 @@ "x-appwrite": { "method": "updateOAuth2TradeshiftSandbox", "group": "oauth2", - "weight": 1169, + "weight": 1188, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-tradeshift-sandbox.md", @@ -46210,7 +47087,7 @@ "x-appwrite": { "method": "updateOAuth2Twitch", "group": "oauth2", - "weight": 1155, + "weight": 1174, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-twitch.md", @@ -46289,7 +47166,7 @@ "x-appwrite": { "method": "updateOAuth2WordPress", "group": "oauth2", - "weight": 1154, + "weight": 1173, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-word-press.md", @@ -46368,7 +47245,7 @@ "x-appwrite": { "method": "updateOAuth2X", "group": "oauth2", - "weight": 1153, + "weight": 1172, "cookies": false, "type": "", "demo": "project\/update-o-auth-2x.md", @@ -46447,7 +47324,7 @@ "x-appwrite": { "method": "updateOAuth2Yahoo", "group": "oauth2", - "weight": 1162, + "weight": 1181, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-yahoo.md", @@ -46526,7 +47403,7 @@ "x-appwrite": { "method": "updateOAuth2Yandex", "group": "oauth2", - "weight": 1152, + "weight": 1171, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-yandex.md", @@ -46605,7 +47482,7 @@ "x-appwrite": { "method": "updateOAuth2Zoho", "group": "oauth2", - "weight": 1151, + "weight": 1170, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-zoho.md", @@ -46684,7 +47561,7 @@ "x-appwrite": { "method": "updateOAuth2Zoom", "group": "oauth2", - "weight": 1150, + "weight": 1169, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-zoom.md", @@ -46739,7 +47616,7 @@ } } }, - "\/project\/oauth2\/{provider}": { + "\/project\/oauth2\/{providerId}": { "get": { "summary": "Get project OAuth2 provider", "operationId": "projectGetOAuth2Provider", @@ -46931,7 +47808,7 @@ "x-appwrite": { "method": "getOAuth2Provider", "group": "oauth2", - "weight": 1139, + "weight": 1158, "cookies": false, "type": "", "demo": "project\/get-o-auth-2-provider.md", @@ -46957,12 +47834,61 @@ ], "parameters": [ { - "name": "provider", + "name": "providerId", "description": "OAuth2 provider key. For example: github, google, apple.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "amazon", + "enum": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom", + "githubImagine", + "googleImagine" + ], + "x-enum-name": "ProjectOAuthProviderId", + "x-enum-keys": [] }, "in": "path" } @@ -46993,7 +47919,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 1120, + "weight": 1139, "cookies": false, "type": "", "demo": "project\/list-platforms.md", @@ -47069,7 +47995,7 @@ "x-appwrite": { "method": "createAndroidPlatform", "group": "platforms", - "weight": 1116, + "weight": 1135, "cookies": false, "type": "", "demo": "project\/create-android-platform.md", @@ -47150,7 +48076,7 @@ "x-appwrite": { "method": "updateAndroidPlatform", "group": "platforms", - "weight": 1111, + "weight": 1130, "cookies": false, "type": "", "demo": "project\/update-android-platform.md", @@ -47237,7 +48163,7 @@ "x-appwrite": { "method": "createApplePlatform", "group": "platforms", - "weight": 1115, + "weight": 1134, "cookies": false, "type": "", "demo": "project\/create-apple-platform.md", @@ -47318,7 +48244,7 @@ "x-appwrite": { "method": "updateApplePlatform", "group": "platforms", - "weight": 1110, + "weight": 1129, "cookies": false, "type": "", "demo": "project\/update-apple-platform.md", @@ -47405,7 +48331,7 @@ "x-appwrite": { "method": "createLinuxPlatform", "group": "platforms", - "weight": 1118, + "weight": 1137, "cookies": false, "type": "", "demo": "project\/create-linux-platform.md", @@ -47486,7 +48412,7 @@ "x-appwrite": { "method": "updateLinuxPlatform", "group": "platforms", - "weight": 1113, + "weight": 1132, "cookies": false, "type": "", "demo": "project\/update-linux-platform.md", @@ -47573,7 +48499,7 @@ "x-appwrite": { "method": "createWebPlatform", "group": "platforms", - "weight": 1114, + "weight": 1133, "cookies": false, "type": "", "demo": "project\/create-web-platform.md", @@ -47654,7 +48580,7 @@ "x-appwrite": { "method": "updateWebPlatform", "group": "platforms", - "weight": 1109, + "weight": 1128, "cookies": false, "type": "", "demo": "project\/update-web-platform.md", @@ -47741,7 +48667,7 @@ "x-appwrite": { "method": "createWindowsPlatform", "group": "platforms", - "weight": 1117, + "weight": 1136, "cookies": false, "type": "", "demo": "project\/create-windows-platform.md", @@ -47822,7 +48748,7 @@ "x-appwrite": { "method": "updateWindowsPlatform", "group": "platforms", - "weight": 1112, + "weight": 1131, "cookies": false, "type": "", "demo": "project\/update-windows-platform.md", @@ -47935,7 +48861,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 1119, + "weight": 1138, "cookies": false, "type": "", "demo": "project\/get-platform.md", @@ -47988,7 +48914,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 1108, + "weight": 1127, "cookies": false, "type": "", "demo": "project\/delete-platform.md", @@ -48050,7 +48976,7 @@ "x-appwrite": { "method": "listPolicies", "group": "policies", - "weight": 1126, + "weight": 1145, "cookies": false, "type": "", "demo": "project\/list-policies.md", @@ -48105,6 +49031,222 @@ ] } }, + "\/project\/policies\/deny-aliased-email": { + "patch": { + "summary": "Update deny aliased email policy", + "operationId": "projectUpdateDenyAliasedEmailPolicy", + "tags": [ + "project" + ], + "description": "Configures if aliased emails such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDenyAliasedEmailPolicy", + "group": "policies", + "weight": 1201, + "cookies": false, + "type": "", + "demo": "project\/update-deny-aliased-email-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block aliased emails during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/policies\/deny-disposable-email": { + "patch": { + "summary": "Update deny disposable email policy", + "operationId": "projectUpdateDenyDisposableEmailPolicy", + "tags": [ + "project" + ], + "description": "Configures if disposable emails from known temporary domains are denied during new users sign-ups and email updates.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDenyDisposableEmailPolicy", + "group": "policies", + "weight": 1202, + "cookies": false, + "type": "", + "demo": "project\/update-deny-disposable-email-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/policies\/deny-free-email": { + "patch": { + "summary": "Update deny free email policy", + "operationId": "projectUpdateDenyFreeEmailPolicy", + "tags": [ + "project" + ], + "description": "Configures if emails from free providers such as Gmail or Yahoo are denied during new users sign-ups and email updates.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDenyFreeEmailPolicy", + "group": "policies", + "weight": 1203, + "cookies": false, + "type": "", + "demo": "project\/update-deny-free-email-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block free email addresses during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, "\/project\/policies\/membership-privacy": { "patch": { "summary": "Update membership privacy policy", @@ -48129,7 +49271,7 @@ "x-appwrite": { "method": "updateMembershipPrivacyPolicy", "group": "policies", - "weight": 1128, + "weight": 1147, "cookies": false, "type": "", "demo": "project\/update-membership-privacy-policy.md", @@ -48218,7 +49360,7 @@ "x-appwrite": { "method": "updatePasswordDictionaryPolicy", "group": "policies", - "weight": 1129, + "weight": 1148, "cookies": false, "type": "", "demo": "project\/update-password-dictionary-policy.md", @@ -48290,7 +49432,7 @@ "x-appwrite": { "method": "updatePasswordHistoryPolicy", "group": "policies", - "weight": 1130, + "weight": 1149, "cookies": false, "type": "", "demo": "project\/update-password-history-policy.md", @@ -48364,7 +49506,7 @@ "x-appwrite": { "method": "updatePasswordPersonalDataPolicy", "group": "policies", - "weight": 1131, + "weight": 1150, "cookies": false, "type": "", "demo": "project\/update-password-personal-data-policy.md", @@ -48436,7 +49578,7 @@ "x-appwrite": { "method": "updateSessionAlertPolicy", "group": "policies", - "weight": 1132, + "weight": 1151, "cookies": false, "type": "", "demo": "project\/update-session-alert-policy.md", @@ -48508,7 +49650,7 @@ "x-appwrite": { "method": "updateSessionDurationPolicy", "group": "policies", - "weight": 1133, + "weight": 1152, "cookies": false, "type": "", "demo": "project\/update-session-duration-policy.md", @@ -48581,7 +49723,7 @@ "x-appwrite": { "method": "updateSessionInvalidationPolicy", "group": "policies", - "weight": 1134, + "weight": 1153, "cookies": false, "type": "", "demo": "project\/update-session-invalidation-policy.md", @@ -48653,7 +49795,7 @@ "x-appwrite": { "method": "updateSessionLimitPolicy", "group": "policies", - "weight": 1135, + "weight": 1154, "cookies": false, "type": "", "demo": "project\/update-session-limit-policy.md", @@ -48727,7 +49869,7 @@ "x-appwrite": { "method": "updateUserLimitPolicy", "group": "policies", - "weight": 1136, + "weight": 1155, "cookies": false, "type": "", "demo": "project\/update-user-limit-policy.md", @@ -48843,7 +49985,7 @@ "x-appwrite": { "method": "getPolicy", "group": "policies", - "weight": 1127, + "weight": 1146, "cookies": false, "type": "", "demo": "project\/get-policy.md", @@ -48889,7 +50031,7 @@ "user-limit", "membership-privacy" ], - "x-enum-name": null, + "x-enum-name": "ProjectPolicyId", "x-enum-keys": [] }, "in": "path" @@ -48921,7 +50063,7 @@ "x-appwrite": { "method": "updateProtocol", "group": null, - "weight": 1090, + "weight": 1109, "cookies": false, "type": "", "demo": "project\/update-protocol.md", @@ -48958,7 +50100,7 @@ "graphql", "websocket" ], - "x-enum-name": null, + "x-enum-name": "ProjectProtocolId", "x-enum-keys": [] }, "in": "path" @@ -49009,7 +50151,7 @@ "x-appwrite": { "method": "updateService", "group": null, - "weight": 1091, + "weight": 1110, "cookies": false, "type": "", "demo": "project\/update-service.md", @@ -49036,7 +50178,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "schema": { "type": "string", @@ -49058,9 +50200,10 @@ "proxy", "graphql", "migrations", - "messaging" + "messaging", + "advisor" ], - "x-enum-name": null, + "x-enum-name": "ProjectServiceId", "x-enum-keys": [] }, "in": "path" @@ -49111,7 +50254,7 @@ "x-appwrite": { "method": "updateSMTP", "group": "smtp", - "weight": 1092, + "weight": 1111, "cookies": false, "type": "", "demo": "project\/update-smtp.md", @@ -49200,7 +50343,7 @@ "tls", "ssl" ], - "x-enum-name": null, + "x-enum-name": "ProjectSMTPSecure", "x-enum-keys": [], "x-nullable": true }, @@ -49234,7 +50377,7 @@ "x-appwrite": { "method": "createSMTPTest", "group": "smtp", - "weight": 1093, + "weight": 1112, "cookies": false, "type": "", "demo": "project\/create-smtp-test.md", @@ -49306,7 +50449,7 @@ "x-appwrite": { "method": "listEmailTemplates", "group": "templates", - "weight": 1094, + "weight": 1113, "cookies": false, "type": "", "demo": "project\/list-email-templates.md", @@ -49380,7 +50523,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 1096, + "weight": 1115, "cookies": false, "type": "", "demo": "project\/update-email-template.md", @@ -49423,7 +50566,7 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "EmailTemplateType", + "x-enum-name": "ProjectEmailTemplateId", "x-enum-keys": [] }, "locale": { @@ -49563,7 +50706,7 @@ "zh-tw", "zu" ], - "x-enum-name": "EmailTemplateLocale", + "x-enum-name": "ProjectEmailTemplateLocale", "x-enum-keys": [] }, "subject": { @@ -49638,7 +50781,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 1095, + "weight": 1114, "cookies": false, "type": "", "demo": "project\/get-email-template.md", @@ -49679,7 +50822,7 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "EmailTemplateType", + "x-enum-name": "ProjectEmailTemplateId", "x-enum-keys": [] }, "in": "path" @@ -49824,7 +50967,7 @@ "zh-tw", "zu" ], - "x-enum-name": "EmailTemplateLocale", + "x-enum-name": "ProjectEmailTemplateLocale", "x-enum-keys": [], "default": "" }, @@ -49857,7 +51000,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 682, + "weight": 697, "cookies": false, "type": "", "demo": "project\/get-usage.md", @@ -49950,7 +51093,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 1098, + "weight": 1117, "cookies": false, "type": "", "demo": "project\/list-variables.md", @@ -50024,7 +51167,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 1097, + "weight": 1116, "cookies": false, "type": "", "demo": "project\/create-variable.md", @@ -50056,7 +51199,7 @@ "properties": { "variableId": { "type": "string", - "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "x-example": "" }, "key": { @@ -50110,7 +51253,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 1099, + "weight": 1118, "cookies": false, "type": "", "demo": "project\/get-variable.md", @@ -50137,7 +51280,7 @@ "parameters": [ { "name": "variableId", - "description": "Variable ID.", + "description": "Variable unique ID.", "required": true, "schema": { "type": "string", @@ -50170,7 +51313,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 1101, + "weight": 1120, "cookies": false, "type": "", "demo": "project\/update-variable.md", @@ -50197,7 +51340,7 @@ "parameters": [ { "name": "variableId", - "description": "Variable ID.", + "description": "Variable unique ID.", "required": true, "schema": { "type": "string", @@ -50252,7 +51395,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 1100, + "weight": 1119, "cookies": false, "type": "", "demo": "project\/delete-variable.md", @@ -50279,7 +51422,7 @@ "parameters": [ { "name": "variableId", - "description": "Variable ID.", + "description": "Variable unique ID.", "required": true, "schema": { "type": "string", @@ -50314,7 +51457,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 1086, + "weight": 1104, "cookies": false, "type": "", "demo": "projects\/list.md", @@ -50397,7 +51540,7 @@ "x-appwrite": { "method": "create", "group": "projects", - "weight": 1084, + "weight": 1102, "cookies": false, "type": "", "demo": "projects\/create.md", @@ -50455,52 +51598,6 @@ ], "x-enum-name": null, "x-enum-keys": [] - }, - "description": { - "type": "string", - "description": "Project description. Max length: 256 chars.", - "x-example": "" - }, - "logo": { - "type": "string", - "description": "Project logo.", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Project URL.", - "x-example": "https:\/\/example.com", - "format": "url" - }, - "legalName": { - "type": "string", - "description": "Project legal Name. Max length: 256 chars.", - "x-example": "" - }, - "legalCountry": { - "type": "string", - "description": "Project legal Country. Max length: 256 chars.", - "x-example": "" - }, - "legalState": { - "type": "string", - "description": "Project legal State. Max length: 256 chars.", - "x-example": "" - }, - "legalCity": { - "type": "string", - "description": "Project legal City. Max length: 256 chars.", - "x-example": "" - }, - "legalAddress": { - "type": "string", - "description": "Project legal Address. Max length: 256 chars.", - "x-example": "" - }, - "legalTaxId": { - "type": "string", - "description": "Project legal Tax ID. Max length: 256 chars.", - "x-example": "" } }, "required": [ @@ -50515,65 +51612,6 @@ } }, "\/projects\/{projectId}": { - "get": { - "summary": "Get project", - "operationId": "projectsGet", - "tags": [ - "projects" - ], - "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", - "responses": { - "200": { - "description": "Project", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/project" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "get", - "group": "projects", - "weight": 57, - "cookies": false, - "type": "", - "demo": "projects\/get.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, "patch": { "summary": "Update project", "operationId": "projectsUpdate", @@ -50597,7 +51635,7 @@ "x-appwrite": { "method": "update", "group": "projects", - "weight": 1085, + "weight": 1103, "cookies": false, "type": "", "demo": "projects\/update.md", @@ -50716,7 +51754,7 @@ "x-appwrite": { "method": "updateConsoleAccess", "group": null, - "weight": 1081, + "weight": 1099, "cookies": false, "type": "", "demo": "projects\/update-console-access.md", @@ -50777,7 +51815,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 404, + "weight": 407, "cookies": false, "type": "", "demo": "projects\/list-dev-keys.md", @@ -50848,7 +51886,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 401, + "weight": 404, "cookies": false, "type": "", "demo": "projects\/create-dev-key.md", @@ -50934,7 +51972,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 403, + "weight": 406, "cookies": false, "type": "", "demo": "projects\/get-dev-key.md", @@ -51002,7 +52040,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 402, + "weight": 405, "cookies": false, "type": "", "demo": "projects\/update-dev-key.md", @@ -51089,7 +52127,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 405, + "weight": 408, "cookies": false, "type": "", "demo": "projects\/delete-dev-key.md", @@ -51159,7 +52197,7 @@ "x-appwrite": { "method": "listSchedules", "group": "schedules", - "weight": 412, + "weight": 415, "cookies": false, "type": "", "demo": "projects\/list-schedules.md", @@ -51242,7 +52280,7 @@ "x-appwrite": { "method": "createSchedule", "group": "schedules", - "weight": 1087, + "weight": 1105, "cookies": false, "type": "", "demo": "projects\/create-schedule.md", @@ -51352,7 +52390,7 @@ "x-appwrite": { "method": "getSchedule", "group": "schedules", - "weight": 411, + "weight": 414, "cookies": false, "type": "", "demo": "projects\/get-schedule.md", @@ -51416,7 +52454,7 @@ "x-appwrite": { "method": "updateStatus", "group": null, - "weight": 1082, + "weight": 1100, "cookies": false, "type": "", "demo": "projects\/update-status.md", @@ -51501,7 +52539,7 @@ "x-appwrite": { "method": "updateTeam", "group": "projects", - "weight": 1083, + "weight": 1101, "cookies": false, "type": "", "demo": "projects\/update-team.md", @@ -51580,8 +52618,8 @@ "deprecated": false, "x-appwrite": { "method": "listRules", - "group": null, - "weight": 1194, + "group": "rules", + "weight": 1213, "cookies": false, "type": "", "demo": "proxy\/list-rules.md", @@ -51590,7 +52628,8 @@ "rate-key": "url:{url},ip:{ip}", "scope": "rules.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -51600,7 +52639,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -51617,17 +52657,6 @@ }, "in": "query" }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -51649,7 +52678,7 @@ "tags": [ "proxy" ], - "description": "Create a new proxy rule for serving Appwrite's API on custom domain.", + "description": "Create a new proxy rule for serving Appwrite's API on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", "responses": { "201": { "description": "Rule", @@ -51665,8 +52694,8 @@ "deprecated": false, "x-appwrite": { "method": "createAPIRule", - "group": null, - "weight": 1189, + "group": "rules", + "weight": 1208, "cookies": false, "type": "", "demo": "proxy\/create-api-rule.md", @@ -51675,7 +52704,8 @@ "rate-key": "userId:{userId}, url:{url}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -51685,7 +52715,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "requestBody": { @@ -51716,7 +52747,7 @@ "tags": [ "proxy" ], - "description": "Create a new proxy rule for executing Appwrite Function on custom domain.", + "description": "Create a new proxy rule for executing Appwrite Function on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", "responses": { "201": { "description": "Rule", @@ -51732,8 +52763,8 @@ "deprecated": false, "x-appwrite": { "method": "createFunctionRule", - "group": null, - "weight": 1191, + "group": "rules", + "weight": 1210, "cookies": false, "type": "", "demo": "proxy\/create-function-rule.md", @@ -51742,7 +52773,8 @@ "rate-key": "userId:{userId}, url:{url}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -51752,7 +52784,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "requestBody": { @@ -51794,7 +52827,7 @@ "tags": [ "proxy" ], - "description": "Create a new proxy rule for to redirect from custom domain to another domain.", + "description": "Create a new proxy rule for to redirect from custom domain to another domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", "responses": { "201": { "description": "Rule", @@ -51810,8 +52843,8 @@ "deprecated": false, "x-appwrite": { "method": "createRedirectRule", - "group": null, - "weight": 1192, + "group": "rules", + "weight": 1211, "cookies": false, "type": "", "demo": "proxy\/create-redirect-rule.md", @@ -51820,7 +52853,8 @@ "rate-key": "userId:{userId}, url:{url}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -51830,7 +52864,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "requestBody": { @@ -51908,9 +52943,204 @@ "tags": [ "proxy" ], - "description": "Create a new proxy rule for serving Appwrite Site on custom domain.", + "description": "Create a new proxy rule for serving Appwrite Site on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", + "responses": { + "201": { + "description": "Rule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/proxyRule" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSiteRule", + "group": "rules", + "weight": 1209, + "cookies": false, + "type": "", + "demo": "proxy\/create-site-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": null + }, + "siteId": { + "type": "string", + "description": "ID of site to be executed.", + "x-example": "" + }, + "branch": { + "type": "string", + "description": "Name of VCS branch to deploy changes automatically", + "x-example": "" + } + }, + "required": [ + "domain", + "siteId" + ] + } + } + } + } + } + }, + "\/proxy\/rules\/{ruleId}": { + "get": { + "summary": "Get rule", + "operationId": "proxyGetRule", + "tags": [ + "proxy" + ], + "description": "Get a proxy rule by its unique ID.", + "responses": { + "200": { + "description": "Rule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/proxyRule" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getRule", + "group": "rules", + "weight": 1212, + "cookies": false, + "type": "", + "demo": "proxy\/get-rule.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "ruleId", + "description": "Rule ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete rule", + "operationId": "proxyDeleteRule", + "tags": [ + "proxy" + ], + "description": "Delete a proxy rule by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteRule", + "group": "rules", + "weight": 1214, + "cookies": false, + "type": "", + "demo": "proxy\/delete-rule.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "ruleId", + "description": "Rule ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/proxy\/rules\/{ruleId}\/status": { + "patch": { + "summary": "Update rule status", + "operationId": "proxyUpdateRuleStatus", + "tags": [ + "proxy" + ], + "description": "If not succeeded yet, retry verification process of a proxy rule domain. This endpoint triggers domain verification by checking DNS records. If verification is successful, a TLS certificate will be automatically provisioned for the domain asynchronously in the background.", "responses": { - "201": { + "200": { "description": "Rule", "content": { "application\/json": { @@ -51923,18 +53153,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSiteRule", - "group": null, - "weight": 1190, + "method": "updateRuleStatus", + "group": "rules", + "weight": 1215, "cookies": false, "type": "", - "demo": "proxy\/create-site-rule.md", - "rate-limit": 10, - "rate-time": 60, - "rate-key": "userId:{userId}, url:{url}", + "demo": "proxy\/update-rule-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -51944,56 +53175,120 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "domain": { - "type": "string", - "description": "Domain name.", - "x-example": null - }, - "siteId": { - "type": "string", - "description": "ID of site to be executed.", - "x-example": "" - }, - "branch": { - "type": "string", - "description": "Name of VCS branch to deploy changes automatically", - "x-example": "" - } - }, - "required": [ - "domain", - "siteId" - ] + "parameters": [ + { + "name": "ruleId", + "description": "Rule ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/reports": { + "get": { + "summary": "List reports", + "operationId": "advisorListReports", + "tags": [ + "advisor" + ], + "description": "Get a list of all the project's analyzer reports. You can use the query params to filter your results.\n", + "responses": { + "200": { + "description": "Reports List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/reportList" + } } } } - } + }, + "deprecated": false, + "x-appwrite": { + "method": "listReports", + "group": "reports", + "weight": 693, + "cookies": false, + "type": "", + "demo": "advisor\/list-reports.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-reports.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "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: appId, type, targetType, target, analyzedAt", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] } }, - "\/proxy\/rules\/{ruleId}": { + "\/reports\/{reportId}": { "get": { - "summary": "Get rule", - "operationId": "proxyGetRule", + "summary": "Get report", + "operationId": "advisorGetReport", "tags": [ - "proxy" + "advisor" ], - "description": "Get a proxy rule by its unique ID.", + "description": "Get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.\n", "responses": { "200": { - "description": "Rule", + "description": "Report", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/proxyRule" + "$ref": "#\/components\/schemas\/report" } } } @@ -52001,50 +53296,57 @@ }, "deprecated": false, "x-appwrite": { - "method": "getRule", - "group": null, - "weight": 1193, + "method": "getReport", + "group": "reports", + "weight": 692, "cookies": false, "type": "", - "demo": "proxy\/get-rule.md", + "demo": "advisor\/get-report.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.read", + "scope": "reports.read", "platforms": [ - "console" + "console", + "client", + "server", + "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-report.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "ruleId", - "description": "Rule ID.", + "name": "reportId", + "description": "Report ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] }, "delete": { - "summary": "Delete rule", - "operationId": "proxyDeleteRule", + "summary": "Delete report", + "operationId": "advisorDeleteReport", "tags": [ - "proxy" + "advisor" ], - "description": "Delete a proxy rule by its unique ID.", + "description": "Delete an analyzer report by its unique ID. Nested insights and CTA metadata are removed asynchronously by the deletes worker.\n", "responses": { "204": { "description": "No content" @@ -52052,59 +53354,153 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteRule", - "group": null, - "weight": 1195, + "method": "deleteReport", + "group": "reports", + "weight": 694, "cookies": false, "type": "", - "demo": "proxy\/delete-rule.md", + "demo": "advisor\/delete-report.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "projectId:{projectId},userId:{userId}", + "scope": "reports.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/delete-report.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Report ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/reports\/{reportId}\/insights": { + "get": { + "summary": "List insights", + "operationId": "advisorListInsights", + "tags": [ + "advisor" + ], + "description": "List the insights produced under a single analyzer report. You can use the query params to filter your results further.\n", + "responses": { + "200": { + "description": "Insights List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/insightList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listInsights", + "group": "insights", + "weight": 696, + "cookies": false, + "type": "", + "demo": "advisor\/list-insights.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.write", + "scope": "insights.read", "platforms": [ - "console" + "console", + "client", + "server", + "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-insights.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "ruleId", - "description": "Rule ID.", + "name": "reportId", + "description": "Parent report ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "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: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } ] } }, - "\/proxy\/rules\/{ruleId}\/verification": { - "patch": { - "summary": "Update rule verification status", - "operationId": "proxyUpdateRuleVerification", + "\/reports\/{reportId}\/insights\/{insightId}": { + "get": { + "summary": "Get insight", + "operationId": "advisorGetInsight", "tags": [ - "proxy" + "advisor" ], - "description": "Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.", + "description": "Get an insight by its unique ID, scoped to its parent report.\n", "responses": { "200": { - "description": "Rule", + "description": "Insight", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/proxyRule" + "$ref": "#\/components\/schemas\/insight" } } } @@ -52112,38 +53508,55 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRuleVerification", - "group": null, - "weight": 1196, + "method": "getInsight", + "group": "insights", + "weight": 695, "cookies": false, "type": "", - "demo": "proxy\/update-rule-verification.md", + "demo": "advisor\/get-insight.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.write", + "scope": "insights.read", "platforms": [ - "console" + "console", + "client", + "server", + "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-insight.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "ruleId", - "description": "Rule ID.", + "name": "reportId", + "description": "Parent report ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "insightId", + "description": "Insight ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -52174,7 +53587,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 470, + "weight": 479, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -52259,7 +53672,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 903, + "weight": 922, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -52554,7 +53967,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 473, + "weight": 482, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -52604,7 +54017,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 496, + "weight": 505, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -52654,7 +54067,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 492, + "weight": 501, "cookies": false, "type": "", "demo": "sites\/list-templates.md", @@ -52786,7 +54199,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 493, + "weight": 502, "cookies": false, "type": "", "demo": "sites\/get-template.md", @@ -52846,7 +54259,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 494, + "weight": 503, "cookies": false, "type": "", "demo": "sites\/list-usage.md", @@ -52918,7 +54331,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 469, + "weight": 478, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -52978,7 +54391,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 904, + "weight": 923, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -53269,7 +54682,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 472, + "weight": 481, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -53331,7 +54744,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 479, + "weight": 488, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -53412,7 +54825,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 478, + "weight": 487, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -53507,7 +54920,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 474, + "weight": 483, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -53612,7 +55025,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 482, + "weight": 491, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -53693,7 +55106,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 475, + "weight": 484, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -53810,7 +55223,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 476, + "weight": 485, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -53909,7 +55322,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 477, + "weight": 486, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -53972,7 +55385,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 480, + "weight": 489, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -54037,7 +55450,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 481, + "weight": 490, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -54128,7 +55541,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 483, + "weight": 492, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -54200,7 +55613,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 485, + "weight": 494, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -54286,7 +55699,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 484, + "weight": 493, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -54349,7 +55762,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 486, + "weight": 495, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -54421,7 +55834,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 495, + "weight": 504, "cookies": false, "type": "", "demo": "sites\/get-usage.md", @@ -54503,7 +55916,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 489, + "weight": 498, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -54537,6 +55950,30 @@ "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "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: key, resourceType, resourceId, secret", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } ] }, @@ -54563,7 +56000,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 905, + "weight": 924, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -54605,6 +56042,11 @@ "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -54622,6 +56064,7 @@ } }, "required": [ + "variableId", "key", "value" ] @@ -54655,7 +56098,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 488, + "weight": 497, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -54725,7 +56168,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 490, + "weight": 499, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -54780,7 +56223,8 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -54794,10 +56238,7 @@ "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } } @@ -54819,7 +56260,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 491, + "weight": 500, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -54891,7 +56332,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 539, + "weight": 548, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -54977,7 +56418,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 537, + "weight": 546, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -55113,7 +56554,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 538, + "weight": 547, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -55174,7 +56615,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 540, + "weight": 549, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -55307,7 +56748,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 541, + "weight": 550, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -55370,7 +56811,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 544, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -55470,7 +56911,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 1187, + "weight": 1206, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -55573,7 +57014,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 543, + "weight": 552, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -55648,7 +57089,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 545, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -55741,7 +57182,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 546, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -55811,7 +57252,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 548, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -55892,7 +57333,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 547, + "weight": 556, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -56123,7 +57564,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 549, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -56211,7 +57652,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 551, + "weight": 560, "cookies": false, "type": "", "demo": "storage\/get-usage.md", @@ -56284,7 +57725,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 552, + "weight": 561, "cookies": false, "type": "", "demo": "storage\/get-bucket-usage.md", @@ -56367,7 +57808,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 761, + "weight": 778, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -56453,7 +57894,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 757, + "weight": 774, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -56534,7 +57975,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 828, + "weight": 847, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -56605,7 +58046,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 824, + "weight": 843, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -56680,7 +58121,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 825, + "weight": 844, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -56748,7 +58189,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 826, + "weight": 845, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -56830,7 +58271,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 827, + "weight": 846, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -56900,7 +58341,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 829, + "weight": 848, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -56989,7 +58430,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 763, + "weight": 780, "cookies": false, "type": "", "demo": "tablesdb\/list-usage.md", @@ -57088,7 +58529,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 758, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -57149,7 +58590,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 759, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -57224,7 +58665,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 760, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -57287,7 +58728,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 768, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -57386,7 +58827,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 764, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -57512,7 +58953,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 765, + "weight": 782, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -57586,7 +59027,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 766, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -57693,7 +59134,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 767, + "weight": 784, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -57769,7 +59210,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 773, + "weight": 790, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -57821,30 +59262,293 @@ "in": "path" }, { - "name": "queries", - "description": "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 columns: key, type, size, required, array, status, error", - "required": false, + "name": "queries", + "description": "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 columns: key, type, size, required, array, status, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint": { + "post": { + "summary": "Create bigint column", + "operationId": "tablesDBCreateBigIntColumn", + "tags": [ + "tablesDB" + ], + "description": "Create a bigint column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnBigInt", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBigint" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBigIntColumn", + "group": "columns", + "weight": 803, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-bigint-column.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint\/{key}": { + "patch": { + "summary": "Update bigint column", + "operationId": "tablesDBUpdateBigIntColumn", + "tags": [ + "tablesDB" + ], + "description": "Update a bigint column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnBigInt", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBigint" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateBigIntColumn", + "group": "columns", + "weight": 804, + "cookies": false, + "type": "", + "demo": "tablesdb\/update-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-bigint-column.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } } }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { @@ -57871,7 +59575,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 774, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -57985,7 +59689,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 775, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -58104,7 +59808,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 776, + "weight": 793, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -58219,7 +59923,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 777, + "weight": 794, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -58339,7 +60043,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 778, + "weight": 795, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -58454,7 +60158,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 779, + "weight": 796, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -58574,7 +60278,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 780, + "weight": 797, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -58697,7 +60401,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 781, + "weight": 798, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -58825,7 +60529,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 782, + "weight": 799, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -58954,7 +60658,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 783, + "weight": 800, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -59088,7 +60792,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 784, + "weight": 801, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -59217,7 +60921,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 785, + "weight": 802, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -59351,7 +61055,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 786, + "weight": 805, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -59465,7 +61169,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 787, + "weight": 806, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -59584,7 +61288,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 788, + "weight": 807, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -59700,7 +61404,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 789, + "weight": 808, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -59825,7 +61529,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 806, + "weight": 825, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -59944,7 +61648,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 807, + "weight": 826, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -60063,7 +61767,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 804, + "weight": 823, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -60182,7 +61886,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 805, + "weight": 824, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -60301,7 +62005,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 790, + "weight": 809, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -60417,7 +62121,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 791, + "weight": 810, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -60542,7 +62246,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 792, + "weight": 811, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -60658,7 +62362,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 793, + "weight": 812, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -60783,7 +62487,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 794, + "weight": 813, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -60923,7 +62627,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 796, + "weight": 815, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -61053,7 +62757,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 797, + "weight": 816, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -61183,7 +62887,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 802, + "weight": 821, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -61302,7 +63006,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 803, + "weight": 822, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -61421,7 +63125,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 798, + "weight": 817, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -61536,7 +63240,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 799, + "weight": 818, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -61656,7 +63360,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 800, + "weight": 819, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -61782,7 +63486,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 801, + "weight": 820, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -61990,7 +63694,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 771, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -62068,7 +63772,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 772, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -62155,7 +63859,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 795, + "weight": 814, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -62272,7 +63976,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 811, + "weight": 830, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -62371,7 +64075,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 808, + "weight": 827, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -62512,7 +64216,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 809, + "weight": 828, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -62589,7 +64293,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 810, + "weight": 829, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -62675,7 +64379,7 @@ "x-appwrite": { "method": "listTableLogs", "group": "tables", - "weight": 769, + "weight": 786, "cookies": false, "type": "", "demo": "tablesdb\/list-table-logs.md", @@ -62762,7 +64466,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 899, + "weight": 918, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -62886,7 +64590,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 812, + "weight": 831, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -63069,7 +64773,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 817, + "weight": 836, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -63201,7 +64905,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 815, + "weight": 834, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -63305,7 +65009,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 819, + "weight": 838, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -63406,7 +65110,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 813, + "weight": 832, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -63517,7 +65221,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 816, + "weight": 835, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -63668,7 +65372,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 814, + "weight": 833, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -63780,7 +65484,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 818, + "weight": 837, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -63887,7 +65591,7 @@ "x-appwrite": { "method": "listRowLogs", "group": "logs", - "weight": 821, + "weight": 840, "cookies": false, "type": "", "demo": "tablesdb\/list-row-logs.md", @@ -63984,7 +65688,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 823, + "weight": 842, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -64113,7 +65817,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 822, + "weight": 841, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -64242,7 +65946,7 @@ "x-appwrite": { "method": "getTableUsage", "group": null, - "weight": 770, + "weight": 787, "cookies": false, "type": "", "demo": "tablesdb\/get-table-usage.md", @@ -64338,7 +66042,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 762, + "weight": 779, "cookies": false, "type": "", "demo": "tablesdb\/get-usage.md", @@ -64450,7 +66154,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 520, + "weight": 529, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -64540,7 +66244,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 518, + "weight": 527, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -64628,7 +66332,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 519, + "weight": 528, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -64693,7 +66397,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 522, + "weight": 531, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -64770,7 +66474,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 521, + "weight": 530, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -64837,7 +66541,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 531, + "weight": 540, "cookies": false, "type": "", "demo": "teams\/list-logs.md", @@ -64922,7 +66626,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 527, + "weight": 536, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -65022,7 +66726,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 525, + "weight": 534, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -65139,7 +66843,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 526, + "weight": 535, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -65214,7 +66918,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 528, + "weight": 537, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -65304,7 +67008,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 1188, + "weight": 1207, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -65381,7 +67085,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 530, + "weight": 539, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -65481,7 +67185,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 523, + "weight": 532, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -65544,7 +67248,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 524, + "weight": 533, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -65628,7 +67332,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 534, + "weight": 543, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -65722,7 +67426,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 532, + "weight": 541, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -65812,7 +67516,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 533, + "weight": 542, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -65872,7 +67576,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 535, + "weight": 544, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -65943,7 +67647,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 536, + "weight": 545, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -66005,7 +67709,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 71, + "weight": 70, "cookies": false, "type": "", "demo": "users\/list.md", @@ -66091,7 +67795,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 62, + "weight": 61, "cookies": false, "type": "", "demo": "users\/create.md", @@ -66185,7 +67889,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 65, + "weight": 64, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -66274,7 +67978,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 63, + "weight": 62, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -66363,7 +68067,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 79, + "weight": 78, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -66444,7 +68148,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 103, + "weight": 102, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -66507,7 +68211,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 64, + "weight": 63, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -66596,7 +68300,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 67, + "weight": 66, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -66685,7 +68389,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 68, + "weight": 67, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -66808,7 +68512,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 69, + "weight": 68, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -66915,7 +68619,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 66, + "weight": 65, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -67024,7 +68728,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 105, + "weight": 104, "cookies": false, "type": "", "demo": "users\/get-usage.md", @@ -67097,7 +68801,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 72, + "weight": 71, "cookies": false, "type": "", "demo": "users\/get.md", @@ -67151,7 +68855,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 101, + "weight": 100, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -67214,7 +68918,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 86, + "weight": 85, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -67297,7 +69001,7 @@ "x-appwrite": { "method": "updateImpersonator", "group": "users", - "weight": 82, + "weight": 81, "cookies": false, "type": "", "demo": "users\/update-impersonator.md", @@ -67379,7 +69083,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 104, + "weight": 103, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -67464,7 +69168,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 81, + "weight": 80, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -67549,7 +69253,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 77, + "weight": 76, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -67636,7 +69340,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 76, + "weight": 75, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -67734,7 +69438,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 91, + "weight": 90, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -67869,7 +69573,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 96, + "weight": 95, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -68005,7 +69709,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 92, + "weight": 91, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -68124,7 +69828,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 93, + "weight": 92, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -68241,7 +69945,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 95, + "weight": 94, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -68358,7 +70062,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 94, + "weight": 93, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -68477,7 +70181,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 84, + "weight": 83, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -68559,7 +70263,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 85, + "weight": 84, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -68641,7 +70345,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 87, + "weight": 86, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -68724,7 +70428,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 73, + "weight": 72, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -68785,7 +70489,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 89, + "weight": 88, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -68867,7 +70571,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 75, + "weight": 74, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -68942,7 +70646,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 97, + "weight": 96, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -68999,7 +70703,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 100, + "weight": 99, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -69058,7 +70762,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 99, + "weight": 98, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -69134,7 +70838,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 80, + "weight": 79, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -69216,7 +70920,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 78, + "weight": 77, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -69301,7 +71005,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 70, + "weight": 69, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -69412,7 +71116,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 74, + "weight": 73, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -69483,7 +71187,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 90, + "weight": 89, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -69573,7 +71277,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 102, + "weight": 101, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -69646,7 +71350,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 98, + "weight": 97, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -69732,7 +71436,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 88, + "weight": 87, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -69814,7 +71518,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 83, + "weight": 82, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -69910,7 +71614,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 564, + "weight": 573, "cookies": false, "type": "", "demo": "vcs\/create-repository-detection.md", @@ -70021,7 +71725,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 561, + "weight": 570, "cookies": false, "type": "", "demo": "vcs\/list-repositories.md", @@ -70120,7 +71824,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 559, + "weight": 568, "cookies": false, "type": "", "demo": "vcs\/create-repository.md", @@ -70206,7 +71910,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 560, + "weight": 569, "cookies": false, "type": "", "demo": "vcs\/get-repository.md", @@ -70260,7 +71964,7 @@ "tags": [ "vcs" ], - "description": "Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.\n", + "description": "Get a list of branches from a GitHub repository in your installation. This endpoint supports filtering by a search term and pagination using query strings such as `Query.limit()`, `Query.offset()`, `Query.cursorAfter()`, and `Query.cursorBefore()`. It returns branch names along with the total number of matches. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.\n", "responses": { "200": { "description": "Branches List", @@ -70277,7 +71981,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 562, + "weight": 571, "cookies": false, "type": "", "demo": "vcs\/list-repository-branches.md", @@ -70320,6 +72024,30 @@ "x-example": "" }, "in": "path" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + }, + { + "name": "queries", + "description": "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, offset, cursorAfter, and cursorBefore", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" } ] } @@ -70348,7 +72076,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 563, + "weight": 572, "cookies": false, "type": "", "demo": "vcs\/get-repository-contents.md", @@ -70434,7 +72162,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 1198, + "weight": 1217, "cookies": false, "type": "", "demo": "vcs\/update-external-deployments.md", @@ -70524,7 +72252,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 557, + "weight": 566, "cookies": false, "type": "", "demo": "vcs\/list-installations.md", @@ -70610,7 +72338,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 556, + "weight": 565, "cookies": false, "type": "", "demo": "vcs\/get-installation.md", @@ -70662,7 +72390,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 558, + "weight": 567, "cookies": false, "type": "", "demo": "vcs\/delete-installation.md", @@ -70723,7 +72451,7 @@ "x-appwrite": { "method": "list", "group": "vectorsdb", - "weight": 868, + "weight": 887, "cookies": false, "type": "", "demo": "vectorsdb\/list.md", @@ -70809,7 +72537,7 @@ "x-appwrite": { "method": "create", "group": "vectorsdb", - "weight": 864, + "weight": 883, "cookies": false, "type": "", "demo": "vectorsdb\/create.md", @@ -70890,7 +72618,7 @@ "x-appwrite": { "method": "createTextEmbeddings", "group": "documents", - "weight": 890, + "weight": 909, "cookies": false, "type": "", "demo": "vectorsdb\/create-text-embeddings.md", @@ -71001,7 +72729,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 895, + "weight": 914, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -71069,7 +72797,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 891, + "weight": 910, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -71141,7 +72869,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 892, + "weight": 911, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -71206,7 +72934,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 893, + "weight": 912, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -71285,7 +73013,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 894, + "weight": 913, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -71352,7 +73080,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 896, + "weight": 915, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -71438,7 +73166,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 870, + "weight": 889, "cookies": false, "type": "", "demo": "vectorsdb\/list-usage.md", @@ -71534,7 +73262,7 @@ "x-appwrite": { "method": "get", "group": "vectorsdb", - "weight": 865, + "weight": 884, "cookies": false, "type": "", "demo": "vectorsdb\/get.md", @@ -71595,7 +73323,7 @@ "x-appwrite": { "method": "update", "group": "vectorsdb", - "weight": 866, + "weight": 885, "cookies": false, "type": "", "demo": "vectorsdb\/update.md", @@ -71673,7 +73401,7 @@ "x-appwrite": { "method": "delete", "group": "vectorsdb", - "weight": 867, + "weight": 886, "cookies": false, "type": "", "demo": "vectorsdb\/delete.md", @@ -71736,7 +73464,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 875, + "weight": 894, "cookies": false, "type": "", "demo": "vectorsdb\/list-collections.md", @@ -71832,7 +73560,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 871, + "weight": 890, "cookies": false, "type": "", "demo": "vectorsdb\/create-collection.md", @@ -71945,7 +73673,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 872, + "weight": 891, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection.md", @@ -72016,7 +73744,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 873, + "weight": 892, "cookies": false, "type": "", "demo": "vectorsdb\/update-collection.md", @@ -72123,7 +73851,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 874, + "weight": 893, "cookies": false, "type": "", "demo": "vectorsdb\/delete-collection.md", @@ -72196,7 +73924,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 885, + "weight": 904, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -72317,7 +74045,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 881, + "weight": 900, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -72493,7 +74221,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 888, + "weight": 907, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-documents.md", @@ -72621,7 +74349,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 887, + "weight": 906, "cookies": false, "type": "", "demo": "vectorsdb\/update-documents.md", @@ -72721,7 +74449,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 889, + "weight": 908, "cookies": false, "type": "", "demo": "vectorsdb\/delete-documents.md", @@ -72818,7 +74546,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 884, + "weight": 903, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -72926,7 +74654,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 883, + "weight": 902, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -73072,7 +74800,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 882, + "weight": 901, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -73179,7 +74907,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 886, + "weight": 905, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -73282,7 +75010,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 880, + "weight": 899, "cookies": false, "type": "", "demo": "vectorsdb\/list-indexes.md", @@ -73377,7 +75105,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 877, + "weight": 896, "cookies": false, "type": "", "demo": "vectorsdb\/create-index.md", @@ -73516,7 +75244,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 878, + "weight": 897, "cookies": false, "type": "", "demo": "vectorsdb\/get-index.md", @@ -73589,7 +75317,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 879, + "weight": 898, "cookies": false, "type": "", "demo": "vectorsdb\/delete-index.md", @@ -73671,7 +75399,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 876, + "weight": 895, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection-usage.md", @@ -73764,7 +75492,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 869, + "weight": 888, "cookies": false, "type": "", "demo": "vectorsdb\/get-usage.md", @@ -73873,7 +75601,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 567, + "weight": 576, "cookies": false, "type": "", "demo": "webhooks\/list.md", @@ -73947,7 +75675,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 566, + "weight": 575, "cookies": false, "type": "", "demo": "webhooks\/create.md", @@ -74063,7 +75791,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 568, + "weight": 577, "cookies": false, "type": "", "demo": "webhooks\/get.md", @@ -74123,7 +75851,7 @@ "x-appwrite": { "method": "update", "group": null, - "weight": 570, + "weight": 579, "cookies": false, "type": "", "demo": "webhooks\/update.md", @@ -74230,7 +75958,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 569, + "weight": 578, "cookies": false, "type": "", "demo": "webhooks\/delete.md", @@ -74292,7 +76020,7 @@ "x-appwrite": { "method": "updateSecret", "group": null, - "weight": 571, + "weight": 580, "cookies": false, "type": "", "demo": "webhooks\/update-secret.md", @@ -74420,6 +76148,10 @@ { "name": "messaging", "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." + }, + { + "name": "advisor", + "description": "The Advisor service surfaces actionable reports about your project resources, with CTA descriptors for one-click remediation in the console." } ], "components": { @@ -74524,6 +76256,34 @@ "documents": "" } }, + "presenceList": { + "description": "Presences List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of presences that matched your query.", + "x-example": 5, + "format": "int32" + }, + "presences": { + "type": "array", + "description": "List of presences.", + "items": { + "$ref": "#\/components\/schemas\/presence" + }, + "x-example": "" + } + }, + "required": [ + "total", + "presences" + ], + "example": { + "total": 5, + "presences": "" + } + }, "tableList": { "description": "Tables List", "type": "object", @@ -76092,6 +77852,62 @@ "embeddings": "" } }, + "insightList": { + "description": "Insights List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of insights that matched your query.", + "x-example": 5, + "format": "int32" + }, + "insights": { + "type": "array", + "description": "List of insights.", + "items": { + "$ref": "#\/components\/schemas\/insight" + }, + "x-example": "" + } + }, + "required": [ + "total", + "insights" + ], + "example": { + "total": 5, + "insights": "" + } + }, + "reportList": { + "description": "Reports List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of reports that matched your query.", + "x-example": 5, + "format": "int32" + }, + "reports": { + "type": "array", + "description": "List of reports.", + "items": { + "$ref": "#\/components\/schemas\/report" + }, + "x-example": "" + } + }, + "required": [ + "total", + "reports" + ], + "example": { + "total": 5, + "reports": "" + } + }, "database": { "description": "Database", "type": "object", @@ -76136,7 +77952,7 @@ "type": "array", "description": "Database backup policies.", "items": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/backupPolicy" }, "x-example": {} }, @@ -76144,7 +77960,7 @@ "type": "array", "description": "Database backup archives.", "items": { - "$ref": "#\/components\/schemas\/collection" + "$ref": "#\/components\/schemas\/backupArchive" }, "x-example": {} } @@ -76278,6 +78094,9 @@ { "$ref": "#\/components\/schemas\/attributeBoolean" }, + { + "$ref": "#\/components\/schemas\/attributeBigint" + }, { "$ref": "#\/components\/schemas\/attributeInteger" }, @@ -76331,6 +78150,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/components\/schemas\/attributeBoolean", + "bigint": "#\/components\/schemas\/attributeBigint", "integer": "#\/components\/schemas\/attributeInteger", "double": "#\/components\/schemas\/attributeFloat", "string": "#\/components\/schemas\/attributeString", @@ -76352,6 +78172,9 @@ "#\/components\/schemas\/attributeBoolean": { "type": "boolean" }, + "#\/components\/schemas\/attributeBigint": { + "type": "bigint" + }, "#\/components\/schemas\/attributeInteger": { "type": "integer" }, @@ -76479,6 +78302,9 @@ { "$ref": "#\/components\/schemas\/attributeBoolean" }, + { + "$ref": "#\/components\/schemas\/attributeBigint" + }, { "$ref": "#\/components\/schemas\/attributeInteger" }, @@ -76532,6 +78358,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/components\/schemas\/attributeBoolean", + "bigint": "#\/components\/schemas\/attributeBigint", "integer": "#\/components\/schemas\/attributeInteger", "double": "#\/components\/schemas\/attributeFloat", "string": "#\/components\/schemas\/attributeString", @@ -76553,6 +78380,9 @@ "#\/components\/schemas\/attributeBoolean": { "type": "boolean" }, + "#\/components\/schemas\/attributeBigint": { + "type": "bigint" + }, "#\/components\/schemas\/attributeInteger": { "type": "integer" }, @@ -76814,6 +78644,104 @@ "default": 10 } }, + "attributeBigint": { + "description": "AttributeBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int64", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "attributeFloat": { "description": "AttributeFloat", "type": "object", @@ -78911,6 +80839,9 @@ { "$ref": "#\/components\/schemas\/columnBoolean" }, + { + "$ref": "#\/components\/schemas\/columnBigint" + }, { "$ref": "#\/components\/schemas\/columnInteger" }, @@ -78964,6 +80895,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/components\/schemas\/columnBoolean", + "bigint": "#\/components\/schemas\/columnBigint", "integer": "#\/components\/schemas\/columnInteger", "double": "#\/components\/schemas\/columnFloat", "string": "#\/components\/schemas\/columnString", @@ -78985,6 +80917,9 @@ "#\/components\/schemas\/columnBoolean": { "type": "boolean" }, + "#\/components\/schemas\/columnBigint": { + "type": "bigint" + }, "#\/components\/schemas\/columnInteger": { "type": "integer" }, @@ -79112,6 +81047,9 @@ { "$ref": "#\/components\/schemas\/columnBoolean" }, + { + "$ref": "#\/components\/schemas\/columnBigint" + }, { "$ref": "#\/components\/schemas\/columnInteger" }, @@ -79165,6 +81103,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/components\/schemas\/columnBoolean", + "bigint": "#\/components\/schemas\/columnBigint", "integer": "#\/components\/schemas\/columnInteger", "double": "#\/components\/schemas\/columnFloat", "string": "#\/components\/schemas\/columnString", @@ -79186,6 +81125,9 @@ "#\/components\/schemas\/columnBoolean": { "type": "boolean" }, + "#\/components\/schemas\/columnBigint": { + "type": "bigint" + }, "#\/components\/schemas\/columnInteger": { "type": "integer" }, @@ -79447,6 +81389,104 @@ "default": 10 } }, + "columnBigint": { + "description": "ColumnBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 10, + "format": "int64", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "columnFloat": { "description": "ColumnFloat", "type": "object", @@ -81193,6 +83233,89 @@ "isAdmin": false } }, + "presence": { + "description": "Presence", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Presence ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "string", + "description": "Presence sequence ID.", + "x-example": "1", + "readOnly": true + }, + "$createdAt": { + "type": "string", + "description": "Presence creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Presence update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Presence permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "674af8f3e12a5f9ac0be" + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "online", + "nullable": true + }, + "source": { + "type": "string", + "description": "Presence source.", + "x-example": "HTTP" + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "additionalProperties": true, + "x-additional-properties-key": "metadata", + "required": [ + "$id", + "$sequence", + "$createdAt", + "$updatedAt", + "$permissions", + "userId", + "source" + ], + "example": { + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "userId": "674af8f3e12a5f9ac0be", + "status": "online", + "source": "HTTP", + "expiresAt": "2020-10-15T06:38:00.000+00:00" + } + }, "log": { "description": "Log", "type": "object", @@ -84718,213 +86841,14 @@ "description": "Project name.", "x-example": "New Project" }, - "description": { - "type": "string", - "description": "Project description.", - "x-example": "This is a new project." - }, "teamId": { "type": "string", "description": "Project team ID.", "x-example": "1592981250" }, - "logo": { - "type": "string", - "description": "Project logo file ID.", - "x-example": "5f5c451b403cb" - }, - "url": { - "type": "string", - "description": "Project website URL.", - "x-example": "5f5c451b403cb" - }, - "legalName": { - "type": "string", - "description": "Company legal name.", - "x-example": "Company LTD." - }, - "legalCountry": { - "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", - "x-example": "US" - }, - "legalState": { - "type": "string", - "description": "State name.", - "x-example": "New York" - }, - "legalCity": { - "type": "string", - "description": "City name.", - "x-example": "New York City." - }, - "legalAddress": { - "type": "string", - "description": "Company Address.", - "x-example": "620 Eighth Avenue, New York, NY 10018" - }, - "legalTaxId": { - "type": "string", - "description": "Company Tax ID.", - "x-example": "131102020" - }, - "authDuration": { - "type": "integer", - "description": "Session duration in seconds.", - "x-example": 60, - "format": "int32" - }, - "authLimit": { - "type": "integer", - "description": "Max users allowed. 0 is unlimited.", - "x-example": 100, - "format": "int32" - }, - "authSessionsLimit": { - "type": "integer", - "description": "Max sessions allowed per user. 100 maximum.", - "x-example": 10, - "format": "int32" - }, - "authPasswordHistory": { - "type": "integer", - "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", - "x-example": 5, - "format": "int32" - }, - "authPasswordDictionary": { - "type": "boolean", - "description": "Whether or not to check user's password against most commonly used passwords.", - "x-example": true - }, - "authPersonalDataCheck": { - "type": "boolean", - "description": "Whether or not to check the user password for similarity with their personal data.", - "x-example": true - }, - "authDisposableEmails": { - "type": "boolean", - "description": "Whether or not to disallow disposable email addresses during signup and email updates.", - "x-example": true - }, - "authCanonicalEmails": { - "type": "boolean", - "description": "Whether or not to require canonical email addresses during signup and email updates.", - "x-example": true - }, - "authFreeEmails": { - "type": "boolean", - "description": "Whether or not to disallow free email addresses during signup and email updates.", - "x-example": true - }, - "authMockNumbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs).", - "items": { - "$ref": "#\/components\/schemas\/mockNumber" - }, - "x-example": [ - {} - ] - }, - "authSessionAlerts": { - "type": "boolean", - "description": "Whether or not to send session alert emails to users.", - "x-example": true - }, - "authMembershipsUserName": { - "type": "boolean", - "description": "Whether or not to show user names in the teams membership response.", - "x-example": true - }, - "authMembershipsUserEmail": { - "type": "boolean", - "description": "Whether or not to show user emails in the teams membership response.", - "x-example": true - }, - "authMembershipsMfa": { - "type": "boolean", - "description": "Whether or not to show user MFA status in the teams membership response.", - "x-example": true - }, - "authMembershipsUserId": { - "type": "boolean", - "description": "Whether or not to show user IDs in the teams membership response.", - "x-example": true - }, - "authMembershipsUserPhone": { - "type": "boolean", - "description": "Whether or not to show user phone numbers in the teams membership response.", - "x-example": true - }, - "authInvalidateSessions": { - "type": "boolean", - "description": "Whether or not all existing sessions should be invalidated on password change", - "x-example": true - }, - "oAuthProviders": { - "type": "array", - "description": "List of Auth Providers.", - "items": { - "$ref": "#\/components\/schemas\/authProvider" - }, - "x-example": [ - {} - ] - }, - "platforms": { - "type": "array", - "description": "List of Platforms.", - "items": { - "anyOf": [ - { - "$ref": "#\/components\/schemas\/platformWeb" - }, - { - "$ref": "#\/components\/schemas\/platformApple" - }, - { - "$ref": "#\/components\/schemas\/platformAndroid" - }, - { - "$ref": "#\/components\/schemas\/platformWindows" - }, - { - "$ref": "#\/components\/schemas\/platformLinux" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/components\/schemas\/platformWeb", - "apple": "#\/components\/schemas\/platformApple", - "android": "#\/components\/schemas\/platformAndroid", - "windows": "#\/components\/schemas\/platformWindows", - "linux": "#\/components\/schemas\/platformLinux" - } - } - }, - "x-example": {} - }, - "webhooks": { - "type": "array", - "description": "List of Webhooks.", - "items": { - "$ref": "#\/components\/schemas\/webhook" - }, - "x-example": {} - }, - "keys": { - "type": "array", - "description": "List of API Keys.", - "items": { - "$ref": "#\/components\/schemas\/key" - }, - "x-example": {} - }, "devKeys": { "type": "array", - "description": "List of dev keys.", + "description": "Deprecated since 1.9.5: List of dev keys.", "items": { "$ref": "#\/components\/schemas\/devKey" }, @@ -85007,140 +86931,29 @@ "description": "Project status", "x-example": "active" }, - "authEmailPassword": { - "type": "boolean", - "description": "Email\/Password auth method status", - "x-example": true - }, - "authUsersAuthMagicURL": { - "type": "boolean", - "description": "Magic URL auth method status", - "x-example": true - }, - "authEmailOtp": { - "type": "boolean", - "description": "Email (OTP) auth method status", - "x-example": true - }, - "authAnonymous": { - "type": "boolean", - "description": "Anonymous auth method status", - "x-example": true - }, - "authInvites": { - "type": "boolean", - "description": "Invites auth method status", - "x-example": true - }, - "authJWT": { - "type": "boolean", - "description": "JWT auth method status", - "x-example": true - }, - "authPhone": { - "type": "boolean", - "description": "Phone auth method status", - "x-example": true - }, - "serviceStatusForAccount": { - "type": "boolean", - "description": "Account service status", - "x-example": true - }, - "serviceStatusForAvatars": { - "type": "boolean", - "description": "Avatars service status", - "x-example": true - }, - "serviceStatusForDatabases": { - "type": "boolean", - "description": "Databases (legacy) service status", - "x-example": true - }, - "serviceStatusForTablesdb": { - "type": "boolean", - "description": "TablesDB service status", - "x-example": true - }, - "serviceStatusForLocale": { - "type": "boolean", - "description": "Locale service status", - "x-example": true - }, - "serviceStatusForHealth": { - "type": "boolean", - "description": "Health service status", - "x-example": true - }, - "serviceStatusForProject": { - "type": "boolean", - "description": "Project service status", - "x-example": true - }, - "serviceStatusForStorage": { - "type": "boolean", - "description": "Storage service status", - "x-example": true - }, - "serviceStatusForTeams": { - "type": "boolean", - "description": "Teams service status", - "x-example": true - }, - "serviceStatusForUsers": { - "type": "boolean", - "description": "Users service status", - "x-example": true - }, - "serviceStatusForVcs": { - "type": "boolean", - "description": "VCS service status", - "x-example": true - }, - "serviceStatusForSites": { - "type": "boolean", - "description": "Sites service status", - "x-example": true - }, - "serviceStatusForFunctions": { - "type": "boolean", - "description": "Functions service status", - "x-example": true - }, - "serviceStatusForProxy": { - "type": "boolean", - "description": "Proxy service status", - "x-example": true - }, - "serviceStatusForGraphql": { - "type": "boolean", - "description": "GraphQL service status", - "x-example": true - }, - "serviceStatusForMigrations": { - "type": "boolean", - "description": "Migrations service status", - "x-example": true - }, - "serviceStatusForMessaging": { - "type": "boolean", - "description": "Messaging service status", - "x-example": true - }, - "protocolStatusForRest": { - "type": "boolean", - "description": "REST protocol status", - "x-example": true + "authMethods": { + "type": "array", + "description": "List of auth methods.", + "items": { + "$ref": "#\/components\/schemas\/projectAuthMethod" + }, + "x-example": {} }, - "protocolStatusForGraphql": { - "type": "boolean", - "description": "GraphQL protocol status", - "x-example": true + "services": { + "type": "array", + "description": "List of services.", + "items": { + "$ref": "#\/components\/schemas\/projectService" + }, + "x-example": {} }, - "protocolStatusForWebsocket": { - "type": "boolean", - "description": "Websocket protocol status", - "x-example": true + "protocols": { + "type": "array", + "description": "List of protocols.", + "items": { + "$ref": "#\/components\/schemas\/projectProtocol" + }, + "x-example": {} }, "region": { "type": "string", @@ -85174,37 +86987,7 @@ "$createdAt", "$updatedAt", "name", - "description", "teamId", - "logo", - "url", - "legalName", - "legalCountry", - "legalState", - "legalCity", - "legalAddress", - "legalTaxId", - "authDuration", - "authLimit", - "authSessionsLimit", - "authPasswordHistory", - "authPasswordDictionary", - "authPersonalDataCheck", - "authDisposableEmails", - "authCanonicalEmails", - "authFreeEmails", - "authMockNumbers", - "authSessionAlerts", - "authMembershipsUserName", - "authMembershipsUserEmail", - "authMembershipsMfa", - "authMembershipsUserId", - "authMembershipsUserPhone", - "authInvalidateSessions", - "oAuthProviders", - "platforms", - "webhooks", - "keys", "devKeys", "smtpEnabled", "smtpSenderName", @@ -85220,33 +87003,9 @@ "pingedAt", "labels", "status", - "authEmailPassword", - "authUsersAuthMagicURL", - "authEmailOtp", - "authAnonymous", - "authInvites", - "authJWT", - "authPhone", - "serviceStatusForAccount", - "serviceStatusForAvatars", - "serviceStatusForDatabases", - "serviceStatusForTablesdb", - "serviceStatusForLocale", - "serviceStatusForHealth", - "serviceStatusForProject", - "serviceStatusForStorage", - "serviceStatusForTeams", - "serviceStatusForUsers", - "serviceStatusForVcs", - "serviceStatusForSites", - "serviceStatusForFunctions", - "serviceStatusForProxy", - "serviceStatusForGraphql", - "serviceStatusForMigrations", - "serviceStatusForMessaging", - "protocolStatusForRest", - "protocolStatusForGraphql", - "protocolStatusForWebsocket", + "authMethods", + "services", + "protocols", "region", "billingLimits", "blocks", @@ -85257,41 +87016,7 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "New Project", - "description": "This is a new project.", "teamId": "1592981250", - "logo": "5f5c451b403cb", - "url": "5f5c451b403cb", - "legalName": "Company LTD.", - "legalCountry": "US", - "legalState": "New York", - "legalCity": "New York City.", - "legalAddress": "620 Eighth Avenue, New York, NY 10018", - "legalTaxId": "131102020", - "authDuration": 60, - "authLimit": 100, - "authSessionsLimit": 10, - "authPasswordHistory": 5, - "authPasswordDictionary": true, - "authPersonalDataCheck": true, - "authDisposableEmails": true, - "authCanonicalEmails": true, - "authFreeEmails": true, - "authMockNumbers": [ - {} - ], - "authSessionAlerts": true, - "authMembershipsUserName": true, - "authMembershipsUserEmail": true, - "authMembershipsMfa": true, - "authMembershipsUserId": true, - "authMembershipsUserPhone": true, - "authInvalidateSessions": true, - "oAuthProviders": [ - {} - ], - "platforms": {}, - "webhooks": {}, - "keys": {}, "devKeys": {}, "smtpEnabled": false, "smtpSenderName": "John Appwrite", @@ -85309,39 +87034,124 @@ "vip" ], "status": "active", - "authEmailPassword": true, - "authUsersAuthMagicURL": true, - "authEmailOtp": true, - "authAnonymous": true, - "authInvites": true, - "authJWT": true, - "authPhone": true, - "serviceStatusForAccount": true, - "serviceStatusForAvatars": true, - "serviceStatusForDatabases": true, - "serviceStatusForTablesdb": true, - "serviceStatusForLocale": true, - "serviceStatusForHealth": true, - "serviceStatusForProject": true, - "serviceStatusForStorage": true, - "serviceStatusForTeams": true, - "serviceStatusForUsers": true, - "serviceStatusForVcs": true, - "serviceStatusForSites": true, - "serviceStatusForFunctions": true, - "serviceStatusForProxy": true, - "serviceStatusForGraphql": true, - "serviceStatusForMigrations": true, - "serviceStatusForMessaging": true, - "protocolStatusForRest": true, - "protocolStatusForGraphql": true, - "protocolStatusForWebsocket": true, + "authMethods": {}, + "services": {}, + "protocols": {}, "region": "fra", "billingLimits": "", "blocks": "", "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, + "projectAuthMethod": { + "description": "ProjectAuthMethod", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Auth method ID.", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "ProjectAuthMethodId" + }, + "enabled": { + "type": "boolean", + "description": "Auth method status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "email-password", + "enabled": false + } + }, + "projectService": { + "description": "ProjectService", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Service ID.", + "x-example": "sites", + "enum": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging", + "advisor" + ], + "x-enum-name": "ProjectServiceId" + }, + "enabled": { + "type": "boolean", + "description": "Service status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "sites", + "enabled": false + } + }, + "projectProtocol": { + "description": "ProjectProtocol", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Protocol ID.", + "x-example": "graphql", + "enum": [ + "rest", + "graphql", + "websocket" + ], + "x-enum-name": "ProjectProtocolId" + }, + "enabled": { + "type": "boolean", + "description": "Protocol status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "graphql", + "enabled": false + } + }, "webhook": { "description": "Webhook", "type": "object", @@ -86083,19 +87893,38 @@ "type": "string", "description": "Google OAuth2 client secret.", "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" + }, + "prompt": { + "type": "array", + "description": "Google OAuth2 prompt values.", + "items": { + "type": "string", + "enum": [ + "none", + "consent", + "select_account" + ] + }, + "x-example": [ + "consent" + ] } }, "required": [ "$id", "enabled", "clientId", - "clientSecret" + "clientSecret", + "prompt" ], "example": { "$id": "github", "enabled": false, "clientId": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", - "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj" + "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj", + "prompt": [ + "consent" + ] } }, "oAuth2Zoom": { @@ -87124,12 +88953,12 @@ "description": "OpenID Connect authorization endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" }, - "tokenUrl": { + "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/token" }, - "userInfoUrl": { + "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" @@ -87142,8 +88971,8 @@ "clientSecret", "wellKnownURL", "authorizationURL", - "tokenUrl", - "userInfoUrl" + "tokenURL", + "userInfoURL" ], "example": { "$id": "github", @@ -87152,8 +88981,8 @@ "clientSecret": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", "wellKnownURL": "https:\/\/myoauth.com\/.well-known\/openid-configuration", "authorizationURL": "https:\/\/myoauth.com\/oauth2\/authorize", - "tokenUrl": "https:\/\/myoauth.com\/oauth2\/token", - "userInfoUrl": "https:\/\/myoauth.com\/oauth2\/userinfo" + "tokenURL": "https:\/\/myoauth.com\/oauth2\/token", + "userInfoURL": "https:\/\/myoauth.com\/oauth2\/userinfo" } }, "oAuth2Okta": { @@ -87787,51 +89616,6 @@ "userMFA": true } }, - "authProvider": { - "description": "AuthProvider", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Auth Provider.", - "x-example": "github" - }, - "name": { - "type": "string", - "description": "Auth Provider name.", - "x-example": "GitHub" - }, - "appId": { - "type": "string", - "description": "OAuth 2.0 application ID.", - "x-example": "259125845563242502" - }, - "secret": { - "type": "string", - "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Auth Provider is active and can be used to create session.", - "x-example": "" - } - }, - "required": [ - "key", - "name", - "appId", - "secret", - "enabled" - ], - "example": { - "key": "github", - "name": "GitHub", - "appId": "259125845563242502", - "secret": "", - "enabled": "" - } - }, "platformWeb": { "description": "Platform Web", "type": "object", @@ -89086,6 +90870,41 @@ "sessions": [] } }, + "usagePresence": { + "description": "UsagePresence", + "type": "object", + "properties": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "usersOnlineTotal": { + "type": "integer", + "description": "Current total number of online users.", + "x-example": 0, + "format": "int32" + }, + "presences": { + "type": "array", + "description": "Aggregated number of online users per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + } + }, + "required": [ + "range", + "usersOnlineTotal", + "presences" + ], + "example": { + "range": "30d", + "usersOnlineTotal": 0, + "presences": [] + } + }, "usageStorage": { "description": "StorageUsage", "type": "object", @@ -91068,7 +92887,7 @@ }, "deploymentResourceId": { "type": "string", - "description": "ID deployment's resource. Used if type is \"deployment\"", + "description": "ID of deployment's resource (site or function ID). Used if type is \"deployment\"", "x-example": "n3u9feiwmf" }, "deploymentVcsProviderBranch": { @@ -91078,13 +92897,12 @@ }, "status": { "type": "string", - "description": "Domain verification status. Possible values are \"created\", \"verifying\", \"verified\" and \"unverified\"", + "description": "Domain verification status. Possible values are \"unverified\", \"verifying\", \"verified\"", "x-example": "verified", "enum": [ - "created", + "unverified", "verifying", - "verified", - "unverified" + "verified" ] }, "logs": { @@ -92486,6 +94304,12 @@ "type": "string", "description": "Version of the Appwrite instance to be migrated.", "x-example": "1.4.0" + }, + "backup-policy": { + "type": "integer", + "description": "Number of backup policies to be migrated.", + "x-example": 5, + "format": "int32" } }, "required": [ @@ -92502,7 +94326,8 @@ "subscriber", "message", "size", - "version" + "version", + "backup-policy" ], "example": { "user": 20, @@ -92518,7 +94343,300 @@ "subscriber": 100, "message": 50, "size": 30000, - "version": "1.4.0" + "version": "1.4.0", + "backup-policy": 5 + } + }, + "insight": { + "description": "Insight", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Insight ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Insight creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Insight update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "reportId": { + "type": "string", + "description": "Parent report ID. Insights always belong to a report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).", + "x-example": "tablesDBIndex" + }, + "severity": { + "type": "string", + "description": "Insight severity. One of info, warning, critical.", + "x-example": "warning" + }, + "status": { + "type": "string", + "description": "Insight status. One of active, dismissed.", + "x-example": "active" + }, + "resourceType": { + "type": "string", + "description": "Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.", + "x-example": "databases" + }, + "resourceId": { + "type": "string", + "description": "ID of the resource the insight is about.", + "x-example": "main" + }, + "parentResourceType": { + "type": "string", + "description": "Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table \u2192 resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.", + "x-example": "tables" + }, + "parentResourceId": { + "type": "string", + "description": "ID of the parent resource. Empty when the resource has no parent.", + "x-example": "orders" + }, + "title": { + "type": "string", + "description": "Insight title.", + "x-example": "Missing index on collection orders" + }, + "summary": { + "type": "string", + "description": "Short markdown summary describing the insight.", + "x-example": "Queries against `orders.status` are scanning the full collection." + }, + "ctas": { + "type": "array", + "description": "List of call-to-action buttons attached to this insight.", + "items": { + "$ref": "#\/components\/schemas\/insightCTA" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the insight was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + }, + "dismissedAt": { + "type": "string", + "description": "Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + }, + "dismissedBy": { + "type": "string", + "description": "User ID that dismissed the insight. Empty when not dismissed.", + "x-example": "5e5ea5c16897e", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "reportId", + "type", + "severity", + "status", + "resourceType", + "resourceId", + "parentResourceType", + "parentResourceId", + "title", + "summary", + "ctas" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "reportId": "5e5ea5c16897e", + "type": "tablesDBIndex", + "severity": "warning", + "status": "active", + "resourceType": "databases", + "resourceId": "main", + "parentResourceType": "tables", + "parentResourceId": "orders", + "title": "Missing index on collection orders", + "summary": "Queries against `orders.status` are scanning the full collection.", + "ctas": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedBy": "5e5ea5c16897e" + } + }, + "insightCTA": { + "description": "InsightCTA", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Human-readable label for the CTA, used in UI.", + "x-example": "Create missing index" + }, + "service": { + "type": "string", + "description": "Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource \u2014 for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.", + "x-example": "tablesDB" + }, + "method": { + "type": "string", + "description": "Public API method on the chosen service the client should invoke when this CTA is triggered.", + "x-example": "createIndex" + }, + "params": { + "type": "object", + "description": "Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId\/tableId\/columns for tablesDB, databaseId\/collectionId\/attributes for the legacy Databases API).", + "x-example": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "required": [ + "label", + "service", + "method", + "params" + ], + "example": { + "label": "Create missing index", + "service": "tablesDB", + "method": "createIndex", + "params": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "report": { + "description": "Report", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Report ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Report creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Report update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "ID of the third-party app that submitted the report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.", + "x-example": "lighthouse" + }, + "title": { + "type": "string", + "description": "Short, human-readable title for the report.", + "x-example": "Lighthouse audit for https:\/\/appwrite.io\/" + }, + "summary": { + "type": "string", + "description": "Markdown summary describing the report.", + "x-example": "Performance score 78. 4 opportunities found." + }, + "targetType": { + "type": "string", + "description": "Plural noun describing what the report analyzes, e.g. databases, sites, urls.", + "x-example": "urls" + }, + "target": { + "type": "string", + "description": "Free-form target identifier (URL for lighthouse, resource ID for db).", + "x-example": "https:\/\/appwrite.io\/" + }, + "categories": { + "type": "array", + "description": "Categories covered by the report, e.g. performance, accessibility.", + "items": { + "type": "string" + }, + "x-example": [ + "performance", + "accessibility" + ] + }, + "insights": { + "type": "array", + "description": "Insights nested under this report.", + "items": { + "$ref": "#\/components\/schemas\/insight" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the report was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "type", + "title", + "summary", + "targetType", + "target", + "categories", + "insights" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "type": "lighthouse", + "title": "Lighthouse audit for https:\/\/appwrite.io\/", + "summary": "Performance score 78. 4 opportunities found.", + "targetType": "urls", + "target": "https:\/\/appwrite.io\/", + "categories": [ + "performance", + "accessibility" + ], + "insights": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00" } }, "activityEvent": { @@ -93136,7 +95254,7 @@ }, "status": { "type": "string", - "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed.", + "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.", "x-example": "completed" }, "startedAt": { diff --git a/specs/latest/open-api3-latest-server.json b/specs/latest/open-api3-latest-server.json index 3c0a17ab..bdace32d 100644 --- a/specs/latest/open-api3-latest-server.json +++ b/specs/latest/open-api3-latest-server.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "version": "1.9.3", + "version": "1.9.5", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -562,7 +562,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 166, + "weight": 165, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -635,7 +635,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 168, + "weight": 167, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -762,7 +762,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 169, + "weight": 168, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -905,7 +905,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 170, + "weight": 169, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1032,7 +1032,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 174, + "weight": 173, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1169,7 +1169,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 175, + "weight": 174, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1310,7 +1310,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 167, + "weight": 166, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1414,7 +1414,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 173, + "weight": 172, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1516,7 +1516,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 171, + "weight": 170, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1618,7 +1618,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 172, + "weight": 171, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -3772,7 +3772,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 1185, + "weight": 1204, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -3836,7 +3836,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 1186, + "weight": 1205, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -3893,7 +3893,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 177, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4023,7 +4023,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 176, + "weight": 175, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4159,7 +4159,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 180, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4221,7 +4221,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 178, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4713,7 +4713,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 179, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4799,7 +4799,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 182, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -4895,7 +4895,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 181, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -4991,7 +4991,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 183, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5746,7 +5746,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 1056, + "weight": 1073, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -5811,7 +5811,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 1057, + "weight": 1074, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -5901,7 +5901,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 1055, + "weight": 1072, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -5956,7 +5956,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 1058, + "weight": 1075, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -6020,7 +6020,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 1051, + "weight": 1068, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -6088,7 +6088,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 1052, + "weight": 1069, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -6210,7 +6210,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 1050, + "weight": 1067, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -6275,7 +6275,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 1053, + "weight": 1070, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -6368,7 +6368,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 1054, + "weight": 1071, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -6435,7 +6435,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 1061, + "weight": 1078, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -6535,7 +6535,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 1060, + "weight": 1077, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -6602,7 +6602,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 1059, + "weight": 1076, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -6666,7 +6666,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 687, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6787,7 +6787,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 683, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -6906,7 +6906,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 755, + "weight": 772, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6975,7 +6975,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 751, + "weight": 768, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -7048,7 +7048,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 752, + "weight": 769, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -7114,7 +7114,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 753, + "weight": 770, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -7194,7 +7194,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 754, + "weight": 771, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -7262,7 +7262,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 756, + "weight": 773, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -7349,7 +7349,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 684, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -7445,7 +7445,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 685, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7557,7 +7557,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 686, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7654,7 +7654,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 695, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7755,7 +7755,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 691, + "weight": 706, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -7883,7 +7883,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 692, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -7959,7 +7959,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 693, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -8068,7 +8068,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 694, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -8146,7 +8146,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 712, + "weight": 727, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -8224,21 +8224,21 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint": { "post": { - "summary": "Create boolean attribute", - "operationId": "databasesCreateBooleanAttribute", + "summary": "Create bigint attribute", + "operationId": "databasesCreateBigIntAttribute", "tags": [ "databases" ], - "description": "Create a boolean attribute.\n", + "description": "Create a bigint attribute. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/attributeBigint" } } } @@ -8246,12 +8246,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createBooleanAttribute", + "method": "createBigIntAttribute", "group": "attributes", - "weight": 713, + "weight": 740, "cookies": false, "type": "", - "demo": "databases\/create-boolean-attribute.md", + "demo": "databases\/create-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8262,10 +8262,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createBooleanColumn" + "replaceWith": "tablesDB.createBigIntColumn" }, "auth": { "Project": [], @@ -8291,7 +8291,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -8316,10 +8316,25 @@ "description": "Is attribute required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -8338,21 +8353,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint\/{key}": { "patch": { - "summary": "Update boolean attribute", - "operationId": "databasesUpdateBooleanAttribute", + "summary": "Update bigint attribute", + "operationId": "databasesUpdateBigIntAttribute", "tags": [ "databases" ], - "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a bigint attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/attributeBigint" } } } @@ -8360,12 +8375,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateBooleanAttribute", + "method": "updateBigIntAttribute", "group": "attributes", - "weight": 714, + "weight": 741, "cookies": false, "type": "", - "demo": "databases\/update-boolean-attribute.md", + "demo": "databases\/update-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8376,10 +8391,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateBooleanColumn" + "replaceWith": "tablesDB.updateBigIntColumn" }, "auth": { "Project": [], @@ -8405,7 +8420,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -8434,15 +8449,30 @@ "description": "Is attribute required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null, "x-nullable": true } @@ -8457,21 +8487,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { "post": { - "summary": "Create datetime attribute", - "operationId": "databasesCreateDatetimeAttribute", + "summary": "Create boolean attribute", + "operationId": "databasesCreateBooleanAttribute", "tags": [ "databases" ], - "description": "Create a date time attribute according to the ISO 8601 standard.", + "description": "Create a boolean attribute.\n", "responses": { "202": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeDatetime" + "$ref": "#\/components\/schemas\/attributeBoolean" } } } @@ -8479,12 +8509,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDatetimeAttribute", + "method": "createBooleanAttribute", "group": "attributes", - "weight": 715, + "weight": 728, "cookies": false, "type": "", - "demo": "databases\/create-datetime-attribute.md", + "demo": "databases\/create-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8495,10 +8525,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createDatetimeColumn" + "replaceWith": "tablesDB.createBooleanColumn" }, "auth": { "Project": [], @@ -8524,7 +8554,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -8550,10 +8580,9 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, "x-nullable": true }, "array": { @@ -8572,21 +8601,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { "patch": { - "summary": "Update datetime attribute", - "operationId": "databasesUpdateDatetimeAttribute", + "summary": "Update boolean attribute", + "operationId": "databasesUpdateBooleanAttribute", "tags": [ "databases" ], - "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeDatetime" + "$ref": "#\/components\/schemas\/attributeBoolean" } } } @@ -8594,12 +8623,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateDatetimeAttribute", + "method": "updateBooleanAttribute", "group": "attributes", - "weight": 716, + "weight": 729, "cookies": false, "type": "", - "demo": "databases\/update-datetime-attribute.md", + "demo": "databases\/update-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8610,10 +8639,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateDatetimeColumn" + "replaceWith": "tablesDB.updateBooleanColumn" }, "auth": { "Project": [], @@ -8639,7 +8668,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -8669,10 +8698,9 @@ "x-example": false }, "default": { - "type": "string", + "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "x-example": false, "x-nullable": true }, "newKey": { @@ -8692,21 +8720,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { "post": { - "summary": "Create email attribute", - "operationId": "databasesCreateEmailAttribute", + "summary": "Create datetime attribute", + "operationId": "databasesCreateDatetimeAttribute", "tags": [ "databases" ], - "description": "Create an email attribute.\n", + "description": "Create a date time attribute according to the ISO 8601 standard.", "responses": { "202": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeEmail" + "$ref": "#\/components\/schemas\/attributeDatetime" } } } @@ -8714,12 +8742,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createEmailAttribute", + "method": "createDatetimeAttribute", "group": "attributes", - "weight": 717, + "weight": 730, "cookies": false, "type": "", - "demo": "databases\/create-email-attribute.md", + "demo": "databases\/create-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8730,10 +8758,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createEmailColumn" + "replaceWith": "tablesDB.createDatetimeColumn" }, "auth": { "Project": [], @@ -8759,7 +8787,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -8786,9 +8814,9 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "email@example.com", - "format": "email", + "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -8807,21 +8835,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update email attribute", - "operationId": "databasesUpdateEmailAttribute", + "summary": "Update datetime attribute", + "operationId": "databasesUpdateDatetimeAttribute", "tags": [ "databases" ], - "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeEmail" + "$ref": "#\/components\/schemas\/attributeDatetime" } } } @@ -8829,12 +8857,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateEmailAttribute", + "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 718, + "weight": 731, "cookies": false, "type": "", - "demo": "databases\/update-email-attribute.md", + "demo": "databases\/update-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8845,10 +8873,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateEmailColumn" + "replaceWith": "tablesDB.updateDatetimeColumn" }, "auth": { "Project": [], @@ -8906,13 +8934,13 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "email@example.com", - "format": "email", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "newKey": { "type": "string", - "description": "New Attribute Key.", + "description": "New attribute key.", "x-example": null, "x-nullable": true } @@ -8927,21 +8955,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { "post": { - "summary": "Create enum attribute", - "operationId": "databasesCreateEnumAttribute", + "summary": "Create email attribute", + "operationId": "databasesCreateEmailAttribute", "tags": [ "databases" ], - "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an email attribute.\n", "responses": { "202": { - "description": "AttributeEnum", + "description": "AttributeEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeEnum" + "$ref": "#\/components\/schemas\/attributeEmail" } } } @@ -8949,12 +8977,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createEnumAttribute", + "method": "createEmailAttribute", "group": "attributes", - "weight": 719, + "weight": 732, "cookies": false, "type": "", - "demo": "databases\/create-enum-attribute.md", + "demo": "databases\/create-email-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8965,10 +8993,245 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createEnumColumn" + "replaceWith": "tablesDB.createEmailColumn" + }, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { + "patch": { + "summary": "Update email attribute", + "operationId": "databasesUpdateEmailAttribute", + "tags": [ + "databases" + ], + "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", + "responses": { + "200": { + "description": "AttributeEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeEmail" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateEmailAttribute", + "group": "attributes", + "weight": 733, + "cookies": false, + "type": "", + "demo": "databases\/update-email-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateEmailColumn" + }, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum": { + "post": { + "summary": "Create enum attribute", + "operationId": "databasesCreateEnumAttribute", + "tags": [ + "databases" + ], + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "responses": { + "202": { + "description": "AttributeEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeEnum" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "createEnumAttribute", + "group": "attributes", + "weight": 734, + "cookies": false, + "type": "", + "demo": "databases\/create-enum-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createEnumColumn" }, "auth": { "Project": [], @@ -9074,7 +9337,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 720, + "weight": 735, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -9202,7 +9465,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 721, + "weight": 736, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -9331,7 +9594,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 722, + "weight": 737, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -9465,7 +9728,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 723, + "weight": 738, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9594,7 +9857,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 724, + "weight": 739, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9728,7 +9991,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 725, + "weight": 742, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9842,7 +10105,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 726, + "weight": 743, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -9961,7 +10224,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 727, + "weight": 744, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -10077,7 +10340,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 728, + "weight": 745, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -10202,7 +10465,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 745, + "weight": 762, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -10317,7 +10580,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 746, + "weight": 763, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -10432,7 +10695,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 743, + "weight": 760, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -10547,7 +10810,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 744, + "weight": 761, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -10662,7 +10925,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 729, + "weight": 746, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -10778,7 +11041,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 730, + "weight": 747, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -10903,7 +11166,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 731, + "weight": 748, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -11019,7 +11282,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 732, + "weight": 749, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -11144,7 +11407,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 733, + "weight": 750, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -11284,7 +11547,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 734, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -11400,7 +11663,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 735, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -11526,7 +11789,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 736, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -11652,7 +11915,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 741, + "weight": 758, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -11767,7 +12030,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 742, + "weight": 759, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -11882,7 +12145,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 737, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -11997,7 +12260,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 738, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -12117,7 +12380,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 739, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -12239,7 +12502,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 740, + "weight": 757, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -12443,7 +12706,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 710, + "weight": 725, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -12521,7 +12784,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 711, + "weight": 726, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -12608,7 +12871,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 897, + "weight": 916, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -12734,7 +12997,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 698, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -12929,7 +13192,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 703, + "weight": 718, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -13068,7 +13331,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 701, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -13174,7 +13437,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 705, + "weight": 720, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -13277,7 +13540,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 699, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -13390,7 +13653,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 702, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -13548,7 +13811,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 700, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -13662,7 +13925,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 704, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -13771,7 +14034,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 709, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -13902,7 +14165,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 708, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -14033,7 +14296,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 750, + "weight": 767, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -14133,7 +14396,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 747, + "weight": 764, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -14275,7 +14538,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 748, + "weight": 765, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -14353,7 +14616,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 749, + "weight": 766, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -14440,7 +14703,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 834, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -14527,7 +14790,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 830, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -14609,7 +14872,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 862, + "weight": 881, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -14678,7 +14941,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 858, + "weight": 877, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -14751,7 +15014,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 859, + "weight": 878, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -14817,7 +15080,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 860, + "weight": 879, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -14897,7 +15160,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 861, + "weight": 880, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -14965,7 +15228,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 863, + "weight": 882, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -15051,7 +15314,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 831, + "weight": 850, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -15113,7 +15376,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 832, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -15192,7 +15455,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 833, + "weight": 852, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -15256,7 +15519,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 841, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -15353,7 +15616,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 837, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -15477,7 +15740,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 838, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -15549,7 +15812,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 839, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -15656,7 +15919,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 840, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -15730,7 +15993,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 898, + "weight": 917, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -15852,7 +16115,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 847, + "weight": 866, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -16031,7 +16294,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 852, + "weight": 871, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -16161,7 +16424,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 850, + "weight": 869, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -16262,7 +16525,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 854, + "weight": 873, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -16360,7 +16623,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 848, + "weight": 867, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -16469,7 +16732,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 851, + "weight": 870, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -16617,7 +16880,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 849, + "weight": 868, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -16725,7 +16988,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 853, + "weight": 872, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -16829,7 +17092,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 857, + "weight": 876, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -16954,7 +17217,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 856, + "weight": 875, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -17079,7 +17342,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 846, + "weight": 865, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -17175,7 +17438,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 843, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -17312,7 +17575,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 844, + "weight": 863, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -17386,7 +17649,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 845, + "weight": 864, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -17469,7 +17732,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 416, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -17555,7 +17818,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 900, + "weight": 919, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -17815,6 +18078,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -17827,8 +18092,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -17920,7 +18189,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 418, + "weight": 427, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -17971,7 +18240,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 419, + "weight": 428, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -18022,7 +18291,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 414, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -18083,7 +18352,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 901, + "weight": 920, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -18350,6 +18619,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -18362,8 +18633,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -18445,7 +18720,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 417, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -18508,7 +18783,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 422, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -18590,7 +18865,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 423, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -18686,7 +18961,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 420, + "weight": 429, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -18787,7 +19062,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 428, + "weight": 437, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -18874,7 +19149,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 425, + "weight": 434, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -18992,7 +19267,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 426, + "weight": 435, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -19091,7 +19366,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 421, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -19155,7 +19430,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 424, + "weight": 433, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -19221,7 +19496,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 427, + "weight": 436, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -19313,7 +19588,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 429, + "weight": 438, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -19386,7 +19661,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 432, + "weight": 441, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -19478,7 +19753,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 430, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -19601,7 +19876,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 431, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -19672,7 +19947,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 433, + "weight": 442, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -19748,7 +20023,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 438, + "weight": 447, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -19783,6 +20058,30 @@ "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "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: key, resourceType, resourceId, secret", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } ] }, @@ -19809,7 +20108,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 902, + "weight": 921, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -19852,6 +20151,11 @@ "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -19869,6 +20173,7 @@ } }, "required": [ + "variableId", "key", "value" ] @@ -19902,7 +20207,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 437, + "weight": 446, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -19973,7 +20278,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 439, + "weight": 448, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -20029,7 +20334,8 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -20043,10 +20349,7 @@ "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } } @@ -20068,7 +20371,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 440, + "weight": 449, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -20141,7 +20444,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 117, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -20197,7 +20500,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 116, + "weight": 115, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -20253,7 +20556,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 443, + "weight": 452, "cookies": false, "type": "", "demo": "health\/get.md", @@ -20305,7 +20608,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 452, + "weight": 461, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -20357,7 +20660,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 446, + "weight": 455, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -20409,7 +20712,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 449, + "weight": 458, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -20472,7 +20775,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 1044, + "weight": 1061, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -20548,7 +20851,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 445, + "weight": 454, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -20600,7 +20903,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 447, + "weight": 456, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -20652,7 +20955,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 453, + "weight": 462, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -20717,7 +21020,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 1040, + "weight": 1057, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -20782,7 +21085,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 1039, + "weight": 1056, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -20847,7 +21150,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 457, + "weight": 466, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -20912,7 +21215,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 1041, + "weight": 1058, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -20977,7 +21280,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 456, + "weight": 465, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -21042,7 +21345,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 458, + "weight": 467, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -21118,7 +21421,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 459, + "weight": 468, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -21183,7 +21486,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 466, + "weight": 475, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -21275,7 +21578,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 463, + "weight": 472, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -21340,7 +21643,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 455, + "weight": 464, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -21405,7 +21708,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 460, + "weight": 469, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -21470,7 +21773,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 461, + "weight": 470, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -21535,7 +21838,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 462, + "weight": 471, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -21600,7 +21903,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 1042, + "weight": 1059, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -21665,7 +21968,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 464, + "weight": 473, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -21730,7 +22033,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 465, + "weight": 474, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -21795,7 +22098,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 1043, + "weight": 1060, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -21860,7 +22163,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 454, + "weight": 463, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -21925,7 +22228,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 451, + "weight": 460, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -21977,7 +22280,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 450, + "weight": 459, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -22029,7 +22332,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 448, + "weight": 457, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -22529,7 +22832,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 158, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -22618,7 +22921,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 155, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -22766,7 +23069,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 162, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -22926,7 +23229,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 157, + "weight": 156, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -23106,7 +23409,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 164, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -23306,7 +23609,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 156, + "weight": 155, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -23491,7 +23794,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 163, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -23682,7 +23985,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 161, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -23737,7 +24040,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 165, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -23801,7 +24104,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 159, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -23889,7 +24192,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 160, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -23977,7 +24280,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 129, + "weight": 128, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -24066,7 +24369,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 128, + "weight": 127, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -24248,7 +24551,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 142, + "weight": 141, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -24432,7 +24735,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 127, + "weight": 126, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -24587,7 +24890,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 141, + "weight": 140, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -24743,7 +25046,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 118, + "weight": 117, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -24864,7 +25167,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 132, + "weight": 131, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -24987,7 +25290,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 122, + "weight": 121, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -25085,7 +25388,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 136, + "weight": 135, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -25186,7 +25489,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 120, + "weight": 119, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -25296,7 +25599,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 134, + "weight": 133, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -25408,7 +25711,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 119, + "weight": 118, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -25518,7 +25821,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 133, + "weight": 132, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -25630,7 +25933,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 121, + "weight": 120, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -25867,7 +26170,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 135, + "weight": 134, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -26103,7 +26406,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 123, + "weight": 122, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -26202,7 +26505,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 137, + "weight": 136, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -26303,7 +26606,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 124, + "weight": 123, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -26402,7 +26705,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 138, + "weight": 137, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -26503,7 +26806,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 125, + "weight": 124, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -26602,7 +26905,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 139, + "weight": 138, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -26703,7 +27006,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 126, + "weight": 125, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -26802,7 +27105,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 140, + "weight": 139, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -26903,7 +27206,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 131, + "weight": 130, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -26958,7 +27261,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 143, + "weight": 142, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -27022,7 +27325,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 130, + "weight": 129, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -27110,7 +27413,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 152, + "weight": 151, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -27198,7 +27501,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 145, + "weight": 144, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -27285,7 +27588,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 144, + "weight": 143, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -27370,7 +27673,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 147, + "weight": 146, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -27432,7 +27735,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 148, + "weight": 147, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -27513,7 +27816,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 149, + "weight": 148, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -27577,7 +27880,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 146, + "weight": 145, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -27665,7 +27968,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 151, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -27762,7 +28065,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 150, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -27855,7 +28158,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 153, + "weight": 152, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -27920,7 +28223,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 154, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -27974,33 +28277,42 @@ ] } }, - "\/project": { - "delete": { - "summary": "Delete project", - "operationId": "projectDelete", + "\/presences": { + "get": { + "summary": "List presences", + "operationId": "presencesList", "tags": [ - "project" + "presences" ], - "description": "Delete a project.", + "description": "List presence logs.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Presences List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/presenceList" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": null, - "weight": 1088, + "method": "list", + "group": "presences", + "weight": 419, "cookies": false, "type": "", - "demo": "project\/delete.md", + "demo": "presences\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.read", "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, @@ -28013,26 +28325,66 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" } ] } }, - "\/project\/auth-methods\/{methodId}": { - "patch": { - "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", - "operationId": "projectUpdateAuthMethod", + "\/presences\/{presenceId}": { + "get": { + "summary": "Get presence", + "operationId": "presencesGet", "tags": [ - "project" + "presences" ], - "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", + "description": "Get a presence log by its unique ID.", "responses": { "200": { - "description": "Project", + "description": "Presence", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/presence" } } } @@ -28040,18 +28392,20 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAuthMethod", - "group": null, - "weight": 1137, + "method": "get", + "group": "presences", + "weight": 418, "cookies": false, "type": "", - "demo": "project\/update-auth-method.md", + "demo": "presences\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.read", "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, @@ -28064,68 +28418,38 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "methodId", - "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "name": "presenceId", + "description": "Presence unique ID.", "required": true, "schema": { "type": "string", - "x-example": "email-password", - "enum": [ - "email-password", - "magic-url", - "email-otp", - "anonymous", - "invites", - "jwt", - "phone" - ], - "x-enum-name": null, - "x-enum-keys": [] + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Auth method status.", - "x-example": false - } - }, - "required": [ - "enabled" - ] - } - } - } - } - } - }, - "\/project\/auth\/canonical-emails": { - "patch": { - "summary": "Update project auth canonical emails", - "operationId": "projectUpdateCanonicalEmails", + ] + }, + "put": { + "summary": "Upsert presence", + "operationId": "presencesUpsert", "tags": [ - "project" + "presences" ], - "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", + "description": "Create or update a presence log by its unique ID.", "responses": { "200": { - "description": "Project", + "description": "Presence", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/presence" } } } @@ -28133,31 +28457,75 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateCanonicalEmails", - "group": "auth", - "weight": 1182, + "method": "upsert", + "group": "presences", + "weight": 416, "cookies": false, "type": "", - "demo": "project\/update-canonical-emails.md", + "demo": "presences\/upsert.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.write", "platforms": [ - "console", - "server" + "client" ], "packaging": false, "public": true, + "methods": [ + { + "name": "upsert", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "presenceId", + "userId", + "status", + "permissions", + "expiresAt", + "metadata" + ], + "required": [ + "presenceId", + "userId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/presence" + } + ], + "description": "", + "demo": "presences\/upsert.md", + "public": true + } + ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -28166,36 +28534,61 @@ "schema": { "type": "object", "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to require canonical email addresses during signup and email updates.", - "x-example": false + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "x-example": "{}" } }, "required": [ - "enabled" + "status" ] } } } } - } - }, - "\/project\/auth\/disposable-emails": { + }, "patch": { - "summary": "Update project auth disposable emails", - "operationId": "projectUpdateDisposableEmails", + "summary": "Update presence", + "operationId": "presencesUpdate", "tags": [ - "project" + "presences" ], - "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", + "description": "Update a presence log by its unique ID.", "responses": { "200": { - "description": "Project", + "description": "Presence", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/presence" } } } @@ -28203,31 +28596,75 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDisposableEmails", - "group": "auth", - "weight": 1183, + "method": "update", + "group": "presences", + "weight": 420, "cookies": false, "type": "", - "demo": "project\/update-disposable-emails.md", + "demo": "presences\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.write", "platforms": [ - "console", - "server" + "client" ], "packaging": false, "public": true, + "methods": [ + { + "name": "updatePresence", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "presenceId", + "userId", + "status", + "expiresAt", + "metadata", + "permissions", + "purge" + ], + "required": [ + "presenceId", + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/presence" + } + ], + "description": "", + "demo": "presences\/update-presence.md", + "public": true + } + ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -28236,34 +28673,123 @@ "schema": { "type": "object", "properties": { - "enabled": { + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "", + "x-nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "x-example": "{}", + "x-nullable": true + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "purge": { "type": "boolean", - "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "description": "When true, purge cached responses used by list presences endpoint.", "x-example": false } - }, - "required": [ - "enabled" - ] + } } } } } + }, + "delete": { + "summary": "Delete presence", + "operationId": "presencesDelete", + "tags": [ + "presences" + ], + "description": "Delete a presence log by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "presences", + "weight": 421, + "cookies": false, + "type": "", + "demo": "presences\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] } }, - "\/project\/auth\/free-emails": { - "patch": { - "summary": "Update project auth free emails", - "operationId": "projectUpdateFreeEmails", + "\/project": { + "get": { + "summary": "Get project", + "operationId": "projectGet", "tags": [ "project" ], - "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", + "description": "Get a project.", "responses": { "200": { "description": "Project", "content": { - "application\/json": { + "": { "schema": { "$ref": "#\/components\/schemas\/project" } @@ -28273,12 +28799,105 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateFreeEmails", - "group": "auth", - "weight": 1184, + "method": "get", + "group": null, + "weight": 1107, "cookies": false, "type": "", - "demo": "project\/update-free-emails.md", + "demo": "project\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + }, + "delete": { + "summary": "Delete project", + "operationId": "projectDelete", + "tags": [ + "project" + ], + "description": "Delete a project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 1106, + "cookies": false, + "type": "", + "demo": "project\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, + "\/project\/auth-methods\/{methodId}": { + "patch": { + "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", + "operationId": "projectUpdateAuthMethod", + "tags": [ + "project" + ], + "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAuthMethod", + "group": null, + "weight": 1156, + "cookies": false, + "type": "", + "demo": "project\/update-auth-method.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -28300,6 +28919,29 @@ "Key": [] } ], + "parameters": [ + { + "name": "methodId", + "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "required": true, + "schema": { + "type": "string", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "ProjectAuthMethodId", + "x-enum-keys": [] + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { @@ -28308,7 +28950,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Set whether or not to block free email addresses during signup and email updates.", + "description": "Auth method status.", "x-example": false } }, @@ -28345,7 +28987,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1104, + "weight": 1123, "cookies": false, "type": "", "demo": "project\/list-keys.md", @@ -28420,7 +29062,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1102, + "weight": 1121, "cookies": false, "type": "", "demo": "project\/create-key.md", @@ -28532,6 +29174,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -28544,8 +29188,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -28556,7 +29204,7 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, @@ -28603,7 +29251,7 @@ "x-appwrite": { "method": "createEphemeralKey", "group": "keys", - "weight": 1103, + "weight": 1122, "cookies": false, "type": "", "demo": "project\/create-ephemeral-key.md", @@ -28705,6 +29353,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -28717,8 +29367,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -28729,14 +29383,14 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, "duration": { "type": "integer", "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", - "x-example": 1, + "x-example": "600", "format": "int32" } }, @@ -28774,7 +29428,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1105, + "weight": 1124, "cookies": false, "type": "", "demo": "project\/get-key.md", @@ -28835,7 +29489,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1107, + "weight": 1126, "cookies": false, "type": "", "demo": "project\/update-key.md", @@ -28954,6 +29608,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -28966,8 +29622,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -28978,7 +29638,7 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, @@ -29015,7 +29675,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1106, + "weight": 1125, "cookies": false, "type": "", "demo": "project\/delete-key.md", @@ -29078,7 +29738,7 @@ "x-appwrite": { "method": "updateLabels", "group": null, - "weight": 1089, + "weight": 1108, "cookies": false, "type": "", "demo": "project\/update-labels.md", @@ -29151,7 +29811,7 @@ "x-appwrite": { "method": "listMockPhones", "group": "mocks", - "weight": 1122, + "weight": 1141, "cookies": false, "type": "", "demo": "project\/list-mock-phones.md", @@ -29226,7 +29886,7 @@ "x-appwrite": { "method": "createMockPhone", "group": "mocks", - "weight": 1121, + "weight": 1140, "cookies": false, "type": "", "demo": "project\/create-mock-phone.md", @@ -29303,7 +29963,7 @@ "x-appwrite": { "method": "getMockPhone", "group": "mocks", - "weight": 1123, + "weight": 1142, "cookies": false, "type": "", "demo": "project\/get-mock-phone.md", @@ -29365,7 +30025,7 @@ "x-appwrite": { "method": "updateMockPhone", "group": "mocks", - "weight": 1124, + "weight": 1143, "cookies": false, "type": "", "demo": "project\/update-mock-phone.md", @@ -29439,7 +30099,7 @@ "x-appwrite": { "method": "deleteMockPhone", "group": "mocks", - "weight": 1125, + "weight": 1144, "cookies": false, "type": "", "demo": "project\/delete-mock-phone.md", @@ -29503,7 +30163,7 @@ "x-appwrite": { "method": "listOAuth2Providers", "group": "oauth2", - "weight": 1138, + "weight": 1157, "cookies": false, "type": "", "demo": "project\/list-o-auth-2-providers.md", @@ -29527,6 +30187,32 @@ "Project": [], "Key": [] } + ], + "parameters": [ + { + "name": "queries", + "description": "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", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } ] } }, @@ -29554,7 +30240,7 @@ "x-appwrite": { "method": "updateOAuth2Amazon", "group": "oauth2", - "weight": 1165, + "weight": 1184, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-amazon.md", @@ -29634,7 +30320,7 @@ "x-appwrite": { "method": "updateOAuth2Apple", "group": "oauth2", - "weight": 1180, + "weight": 1199, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-apple.md", @@ -29726,7 +30412,7 @@ "x-appwrite": { "method": "updateOAuth2Auth0", "group": "oauth2", - "weight": 1174, + "weight": 1193, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-auth-0.md", @@ -29812,7 +30498,7 @@ "x-appwrite": { "method": "updateOAuth2Authentik", "group": "oauth2", - "weight": 1173, + "weight": 1192, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-authentik.md", @@ -29898,7 +30584,7 @@ "x-appwrite": { "method": "updateOAuth2Autodesk", "group": "oauth2", - "weight": 1148, + "weight": 1167, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-autodesk.md", @@ -29978,7 +30664,7 @@ "x-appwrite": { "method": "updateOAuth2Bitbucket", "group": "oauth2", - "weight": 1145, + "weight": 1164, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-bitbucket.md", @@ -30058,7 +30744,7 @@ "x-appwrite": { "method": "updateOAuth2Bitly", "group": "oauth2", - "weight": 1146, + "weight": 1165, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-bitly.md", @@ -30138,7 +30824,7 @@ "x-appwrite": { "method": "updateOAuth2Box", "group": "oauth2", - "weight": 1147, + "weight": 1166, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-box.md", @@ -30218,7 +30904,7 @@ "x-appwrite": { "method": "updateOAuth2Dailymotion", "group": "oauth2", - "weight": 1144, + "weight": 1163, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-dailymotion.md", @@ -30298,7 +30984,7 @@ "x-appwrite": { "method": "updateOAuth2Discord", "group": "oauth2", - "weight": 1141, + "weight": 1160, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-discord.md", @@ -30378,7 +31064,7 @@ "x-appwrite": { "method": "updateOAuth2Disqus", "group": "oauth2", - "weight": 1164, + "weight": 1183, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-disqus.md", @@ -30458,7 +31144,7 @@ "x-appwrite": { "method": "updateOAuth2Dropbox", "group": "oauth2", - "weight": 1143, + "weight": 1162, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-dropbox.md", @@ -30538,7 +31224,7 @@ "x-appwrite": { "method": "updateOAuth2Etsy", "group": "oauth2", - "weight": 1166, + "weight": 1185, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-etsy.md", @@ -30618,7 +31304,7 @@ "x-appwrite": { "method": "updateOAuth2Facebook", "group": "oauth2", - "weight": 1167, + "weight": 1186, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-facebook.md", @@ -30698,7 +31384,7 @@ "x-appwrite": { "method": "updateOAuth2Figma", "group": "oauth2", - "weight": 1142, + "weight": 1161, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-figma.md", @@ -30778,7 +31464,7 @@ "x-appwrite": { "method": "updateOAuth2FusionAuth", "group": "oauth2", - "weight": 1175, + "weight": 1194, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-fusion-auth.md", @@ -30864,7 +31550,7 @@ "x-appwrite": { "method": "updateOAuth2GitHub", "group": "oauth2", - "weight": 1140, + "weight": 1159, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-git-hub.md", @@ -30944,7 +31630,7 @@ "x-appwrite": { "method": "updateOAuth2Gitlab", "group": "oauth2", - "weight": 1172, + "weight": 1191, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-gitlab.md", @@ -31031,7 +31717,7 @@ "x-appwrite": { "method": "updateOAuth2Google", "group": "oauth2", - "weight": 1149, + "weight": 1168, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-google.md", @@ -31074,6 +31760,22 @@ "x-example": "", "x-nullable": true }, + "prompt": { + "type": "array", + "description": "Array of Google OAuth2 prompt values. If \"none\" is included, it must be the only element. \"none\" means: don't display any authentication or consent screens. Must not be specified with other values. \"consent\" means: prompt the user for consent. \"select_account\" means: prompt the user to select an account.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "none", + "consent", + "select_account" + ], + "x-enum-name": "ProjectOAuth2GooglePrompt", + "x-enum-keys": [] + }, + "x-nullable": true + }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", @@ -31111,7 +31813,7 @@ "x-appwrite": { "method": "updateOAuth2Keycloak", "group": "oauth2", - "weight": 1176, + "weight": 1195, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-keycloak.md", @@ -31203,7 +31905,7 @@ "x-appwrite": { "method": "updateOAuth2Kick", "group": "oauth2", - "weight": 1179, + "weight": 1198, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-kick.md", @@ -31283,7 +31985,7 @@ "x-appwrite": { "method": "updateOAuth2Linkedin", "group": "oauth2", - "weight": 1163, + "weight": 1182, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-linkedin.md", @@ -31363,7 +32065,7 @@ "x-appwrite": { "method": "updateOAuth2Microsoft", "group": "oauth2", - "weight": 1181, + "weight": 1200, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-microsoft.md", @@ -31449,7 +32151,7 @@ "x-appwrite": { "method": "updateOAuth2Notion", "group": "oauth2", - "weight": 1160, + "weight": 1179, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-notion.md", @@ -31529,7 +32231,7 @@ "x-appwrite": { "method": "updateOAuth2Oidc", "group": "oauth2", - "weight": 1177, + "weight": 1196, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-oidc.md", @@ -31586,14 +32288,14 @@ "format": "url", "x-nullable": true }, - "tokenUrl": { + "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", "x-example": "https:\/\/example.com", "format": "url", "x-nullable": true }, - "userInfoUrl": { + "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", "x-example": "https:\/\/example.com", @@ -31637,7 +32339,7 @@ "x-appwrite": { "method": "updateOAuth2Okta", "group": "oauth2", - "weight": 1178, + "weight": 1197, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-okta.md", @@ -31729,7 +32431,7 @@ "x-appwrite": { "method": "updateOAuth2Paypal", "group": "oauth2", - "weight": 1170, + "weight": 1189, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-paypal.md", @@ -31809,7 +32511,7 @@ "x-appwrite": { "method": "updateOAuth2PaypalSandbox", "group": "oauth2", - "weight": 1171, + "weight": 1190, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-paypal-sandbox.md", @@ -31889,7 +32591,7 @@ "x-appwrite": { "method": "updateOAuth2Podio", "group": "oauth2", - "weight": 1159, + "weight": 1178, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-podio.md", @@ -31969,7 +32671,7 @@ "x-appwrite": { "method": "updateOAuth2Salesforce", "group": "oauth2", - "weight": 1161, + "weight": 1180, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-salesforce.md", @@ -32049,7 +32751,7 @@ "x-appwrite": { "method": "updateOAuth2Slack", "group": "oauth2", - "weight": 1158, + "weight": 1177, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-slack.md", @@ -32129,7 +32831,7 @@ "x-appwrite": { "method": "updateOAuth2Spotify", "group": "oauth2", - "weight": 1157, + "weight": 1176, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-spotify.md", @@ -32209,7 +32911,7 @@ "x-appwrite": { "method": "updateOAuth2Stripe", "group": "oauth2", - "weight": 1156, + "weight": 1175, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-stripe.md", @@ -32289,7 +32991,7 @@ "x-appwrite": { "method": "updateOAuth2Tradeshift", "group": "oauth2", - "weight": 1168, + "weight": 1187, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-tradeshift.md", @@ -32369,7 +33071,7 @@ "x-appwrite": { "method": "updateOAuth2TradeshiftSandbox", "group": "oauth2", - "weight": 1169, + "weight": 1188, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-tradeshift-sandbox.md", @@ -32449,7 +33151,7 @@ "x-appwrite": { "method": "updateOAuth2Twitch", "group": "oauth2", - "weight": 1155, + "weight": 1174, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-twitch.md", @@ -32529,7 +33231,7 @@ "x-appwrite": { "method": "updateOAuth2WordPress", "group": "oauth2", - "weight": 1154, + "weight": 1173, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-word-press.md", @@ -32609,7 +33311,7 @@ "x-appwrite": { "method": "updateOAuth2X", "group": "oauth2", - "weight": 1153, + "weight": 1172, "cookies": false, "type": "", "demo": "project\/update-o-auth-2x.md", @@ -32689,7 +33391,7 @@ "x-appwrite": { "method": "updateOAuth2Yahoo", "group": "oauth2", - "weight": 1162, + "weight": 1181, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-yahoo.md", @@ -32769,7 +33471,7 @@ "x-appwrite": { "method": "updateOAuth2Yandex", "group": "oauth2", - "weight": 1152, + "weight": 1171, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-yandex.md", @@ -32849,7 +33551,7 @@ "x-appwrite": { "method": "updateOAuth2Zoho", "group": "oauth2", - "weight": 1151, + "weight": 1170, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-zoho.md", @@ -32929,7 +33631,7 @@ "x-appwrite": { "method": "updateOAuth2Zoom", "group": "oauth2", - "weight": 1150, + "weight": 1169, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-zoom.md", @@ -32985,7 +33687,7 @@ } } }, - "\/project\/oauth2\/{provider}": { + "\/project\/oauth2\/{providerId}": { "get": { "summary": "Get project OAuth2 provider", "operationId": "projectGetOAuth2Provider", @@ -33177,7 +33879,7 @@ "x-appwrite": { "method": "getOAuth2Provider", "group": "oauth2", - "weight": 1139, + "weight": 1158, "cookies": false, "type": "", "demo": "project\/get-o-auth-2-provider.md", @@ -33204,12 +33906,61 @@ ], "parameters": [ { - "name": "provider", + "name": "providerId", "description": "OAuth2 provider key. For example: github, google, apple.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "amazon", + "enum": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom", + "githubImagine", + "googleImagine" + ], + "x-enum-name": "ProjectOAuthProviderId", + "x-enum-keys": [] }, "in": "path" } @@ -33240,7 +33991,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 1120, + "weight": 1139, "cookies": false, "type": "", "demo": "project\/list-platforms.md", @@ -33317,7 +34068,7 @@ "x-appwrite": { "method": "createAndroidPlatform", "group": "platforms", - "weight": 1116, + "weight": 1135, "cookies": false, "type": "", "demo": "project\/create-android-platform.md", @@ -33399,7 +34150,7 @@ "x-appwrite": { "method": "updateAndroidPlatform", "group": "platforms", - "weight": 1111, + "weight": 1130, "cookies": false, "type": "", "demo": "project\/update-android-platform.md", @@ -33487,7 +34238,7 @@ "x-appwrite": { "method": "createApplePlatform", "group": "platforms", - "weight": 1115, + "weight": 1134, "cookies": false, "type": "", "demo": "project\/create-apple-platform.md", @@ -33569,7 +34320,7 @@ "x-appwrite": { "method": "updateApplePlatform", "group": "platforms", - "weight": 1110, + "weight": 1129, "cookies": false, "type": "", "demo": "project\/update-apple-platform.md", @@ -33657,7 +34408,7 @@ "x-appwrite": { "method": "createLinuxPlatform", "group": "platforms", - "weight": 1118, + "weight": 1137, "cookies": false, "type": "", "demo": "project\/create-linux-platform.md", @@ -33739,7 +34490,7 @@ "x-appwrite": { "method": "updateLinuxPlatform", "group": "platforms", - "weight": 1113, + "weight": 1132, "cookies": false, "type": "", "demo": "project\/update-linux-platform.md", @@ -33827,7 +34578,7 @@ "x-appwrite": { "method": "createWebPlatform", "group": "platforms", - "weight": 1114, + "weight": 1133, "cookies": false, "type": "", "demo": "project\/create-web-platform.md", @@ -33909,7 +34660,7 @@ "x-appwrite": { "method": "updateWebPlatform", "group": "platforms", - "weight": 1109, + "weight": 1128, "cookies": false, "type": "", "demo": "project\/update-web-platform.md", @@ -33997,7 +34748,7 @@ "x-appwrite": { "method": "createWindowsPlatform", "group": "platforms", - "weight": 1117, + "weight": 1136, "cookies": false, "type": "", "demo": "project\/create-windows-platform.md", @@ -34079,7 +34830,7 @@ "x-appwrite": { "method": "updateWindowsPlatform", "group": "platforms", - "weight": 1112, + "weight": 1131, "cookies": false, "type": "", "demo": "project\/update-windows-platform.md", @@ -34193,7 +34944,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 1119, + "weight": 1138, "cookies": false, "type": "", "demo": "project\/get-platform.md", @@ -34247,7 +34998,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 1108, + "weight": 1127, "cookies": false, "type": "", "demo": "project\/delete-platform.md", @@ -34310,7 +35061,7 @@ "x-appwrite": { "method": "listPolicies", "group": "policies", - "weight": 1126, + "weight": 1145, "cookies": false, "type": "", "demo": "project\/list-policies.md", @@ -34366,14 +35117,14 @@ ] } }, - "\/project\/policies\/membership-privacy": { + "\/project\/policies\/deny-aliased-email": { "patch": { - "summary": "Update membership privacy policy", - "operationId": "projectUpdateMembershipPrivacyPolicy", + "summary": "Update deny aliased email policy", + "operationId": "projectUpdateDenyAliasedEmailPolicy", "tags": [ "project" ], - "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", + "description": "Configures if aliased emails such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.", "responses": { "200": { "description": "Project", @@ -34388,12 +35139,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipPrivacyPolicy", + "method": "updateDenyAliasedEmailPolicy", "group": "policies", - "weight": 1128, + "weight": 1201, "cookies": false, "type": "", - "demo": "project\/update-membership-privacy-policy.md", + "demo": "project\/update-deny-aliased-email-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34424,46 +35175,102 @@ "schema": { "type": "object", "properties": { - "userId": { - "type": "boolean", - "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", - "x-example": false - }, - "userEmail": { - "type": "boolean", - "description": "Set to true if you want make user email visible to all team members, or false to hide it.", - "x-example": false - }, - "userPhone": { - "type": "boolean", - "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", - "x-example": false - }, - "userName": { + "enabled": { "type": "boolean", - "description": "Set to true if you want make user name visible to all team members, or false to hide it.", + "description": "Set whether or not to block aliased emails during signup and email updates.", "x-example": false - }, - "userMFA": { + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/policies\/deny-disposable-email": { + "patch": { + "summary": "Update deny disposable email policy", + "operationId": "projectUpdateDenyDisposableEmailPolicy", + "tags": [ + "project" + ], + "description": "Configures if disposable emails from known temporary domains are denied during new users sign-ups and email updates.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDenyDisposableEmailPolicy", + "group": "policies", + "weight": 1202, + "cookies": false, + "type": "", + "demo": "project\/update-deny-disposable-email-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { "type": "boolean", - "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "description": "Set whether or not to block disposable email addresses during signup and email updates.", "x-example": false } - } + }, + "required": [ + "enabled" + ] } } } } } }, - "\/project\/policies\/password-dictionary": { + "\/project\/policies\/deny-free-email": { "patch": { - "summary": "Update password dictionary policy", - "operationId": "projectUpdatePasswordDictionaryPolicy", + "summary": "Update deny free email policy", + "operationId": "projectUpdateDenyFreeEmailPolicy", "tags": [ "project" ], - "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "description": "Configures if emails from free providers such as Gmail or Yahoo are denied during new users sign-ups and email updates.", "responses": { "200": { "description": "Project", @@ -34478,12 +35285,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordDictionaryPolicy", + "method": "updateDenyFreeEmailPolicy", "group": "policies", - "weight": 1129, + "weight": 1203, "cookies": false, "type": "", - "demo": "project\/update-password-dictionary-policy.md", + "demo": "project\/update-deny-free-email-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34516,7 +35323,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "description": "Set whether or not to block free email addresses during signup and email updates.", "x-example": false } }, @@ -34529,14 +35336,14 @@ } } }, - "\/project\/policies\/password-history": { + "\/project\/policies\/membership-privacy": { "patch": { - "summary": "Update password history policy", - "operationId": "projectUpdatePasswordHistoryPolicy", + "summary": "Update membership privacy policy", + "operationId": "projectUpdateMembershipPrivacyPolicy", "tags": [ "project" ], - "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", + "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", "responses": { "200": { "description": "Project", @@ -34551,12 +35358,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordHistoryPolicy", + "method": "updateMembershipPrivacyPolicy", "group": "policies", - "weight": 1130, + "weight": 1147, "cookies": false, "type": "", - "demo": "project\/update-password-history-policy.md", + "demo": "project\/update-membership-privacy-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34587,16 +35394,104 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", - "x-example": 1, - "format": "int32", - "x-nullable": true + "userId": { + "type": "boolean", + "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", + "x-example": false + }, + "userEmail": { + "type": "boolean", + "description": "Set to true if you want make user email visible to all team members, or false to hide it.", + "x-example": false + }, + "userPhone": { + "type": "boolean", + "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", + "x-example": false + }, + "userName": { + "type": "boolean", + "description": "Set to true if you want make user name visible to all team members, or false to hide it.", + "x-example": false + }, + "userMFA": { + "type": "boolean", + "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "x-example": false + } + } + } + } + } + } + } + }, + "\/project\/policies\/password-dictionary": { + "patch": { + "summary": "Update password dictionary policy", + "operationId": "projectUpdatePasswordDictionaryPolicy", + "tags": [ + "project" + ], + "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordDictionaryPolicy", + "group": "policies", + "weight": 1148, + "cookies": false, + "type": "", + "demo": "project\/update-password-dictionary-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "x-example": false } }, "required": [ - "total" + "enabled" ] } } @@ -34604,14 +35499,14 @@ } } }, - "\/project\/policies\/password-personal-data": { + "\/project\/policies\/password-history": { "patch": { - "summary": "Update password personal data policy", - "operationId": "projectUpdatePasswordPersonalDataPolicy", + "summary": "Update password history policy", + "operationId": "projectUpdatePasswordHistoryPolicy", "tags": [ "project" ], - "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", + "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", "responses": { "200": { "description": "Project", @@ -34626,12 +35521,87 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordPersonalDataPolicy", + "method": "updatePasswordHistoryPolicy", "group": "policies", - "weight": 1131, + "weight": 1149, "cookies": false, "type": "", - "demo": "project\/update-password-personal-data-policy.md", + "demo": "project\/update-password-history-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", + "x-example": 1, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "total" + ] + } + } + } + } + } + }, + "\/project\/policies\/password-personal-data": { + "patch": { + "summary": "Update password personal data policy", + "operationId": "projectUpdatePasswordPersonalDataPolicy", + "tags": [ + "project" + ], + "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordPersonalDataPolicy", + "group": "policies", + "weight": 1150, + "cookies": false, + "type": "", + "demo": "project\/update-password-personal-data-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34701,7 +35671,7 @@ "x-appwrite": { "method": "updateSessionAlertPolicy", "group": "policies", - "weight": 1132, + "weight": 1151, "cookies": false, "type": "", "demo": "project\/update-session-alert-policy.md", @@ -34774,7 +35744,7 @@ "x-appwrite": { "method": "updateSessionDurationPolicy", "group": "policies", - "weight": 1133, + "weight": 1152, "cookies": false, "type": "", "demo": "project\/update-session-duration-policy.md", @@ -34848,7 +35818,7 @@ "x-appwrite": { "method": "updateSessionInvalidationPolicy", "group": "policies", - "weight": 1134, + "weight": 1153, "cookies": false, "type": "", "demo": "project\/update-session-invalidation-policy.md", @@ -34921,7 +35891,7 @@ "x-appwrite": { "method": "updateSessionLimitPolicy", "group": "policies", - "weight": 1135, + "weight": 1154, "cookies": false, "type": "", "demo": "project\/update-session-limit-policy.md", @@ -34996,7 +35966,7 @@ "x-appwrite": { "method": "updateUserLimitPolicy", "group": "policies", - "weight": 1136, + "weight": 1155, "cookies": false, "type": "", "demo": "project\/update-user-limit-policy.md", @@ -35113,7 +36083,7 @@ "x-appwrite": { "method": "getPolicy", "group": "policies", - "weight": 1127, + "weight": 1146, "cookies": false, "type": "", "demo": "project\/get-policy.md", @@ -35160,7 +36130,7 @@ "user-limit", "membership-privacy" ], - "x-enum-name": null, + "x-enum-name": "ProjectPolicyId", "x-enum-keys": [] }, "in": "path" @@ -35192,7 +36162,7 @@ "x-appwrite": { "method": "updateProtocol", "group": null, - "weight": 1090, + "weight": 1109, "cookies": false, "type": "", "demo": "project\/update-protocol.md", @@ -35230,7 +36200,7 @@ "graphql", "websocket" ], - "x-enum-name": null, + "x-enum-name": "ProjectProtocolId", "x-enum-keys": [] }, "in": "path" @@ -35281,7 +36251,7 @@ "x-appwrite": { "method": "updateService", "group": null, - "weight": 1091, + "weight": 1110, "cookies": false, "type": "", "demo": "project\/update-service.md", @@ -35309,7 +36279,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "schema": { "type": "string", @@ -35331,9 +36301,10 @@ "proxy", "graphql", "migrations", - "messaging" + "messaging", + "advisor" ], - "x-enum-name": null, + "x-enum-name": "ProjectServiceId", "x-enum-keys": [] }, "in": "path" @@ -35384,7 +36355,7 @@ "x-appwrite": { "method": "updateSMTP", "group": "smtp", - "weight": 1092, + "weight": 1111, "cookies": false, "type": "", "demo": "project\/update-smtp.md", @@ -35474,7 +36445,7 @@ "tls", "ssl" ], - "x-enum-name": null, + "x-enum-name": "ProjectSMTPSecure", "x-enum-keys": [], "x-nullable": true }, @@ -35508,7 +36479,7 @@ "x-appwrite": { "method": "createSMTPTest", "group": "smtp", - "weight": 1093, + "weight": 1112, "cookies": false, "type": "", "demo": "project\/create-smtp-test.md", @@ -35581,7 +36552,7 @@ "x-appwrite": { "method": "listEmailTemplates", "group": "templates", - "weight": 1094, + "weight": 1113, "cookies": false, "type": "", "demo": "project\/list-email-templates.md", @@ -35656,7 +36627,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 1096, + "weight": 1115, "cookies": false, "type": "", "demo": "project\/update-email-template.md", @@ -35700,7 +36671,7 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "EmailTemplateType", + "x-enum-name": "ProjectEmailTemplateId", "x-enum-keys": [] }, "locale": { @@ -35840,7 +36811,7 @@ "zh-tw", "zu" ], - "x-enum-name": "EmailTemplateLocale", + "x-enum-name": "ProjectEmailTemplateLocale", "x-enum-keys": [] }, "subject": { @@ -35915,7 +36886,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 1095, + "weight": 1114, "cookies": false, "type": "", "demo": "project\/get-email-template.md", @@ -35957,7 +36928,7 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "EmailTemplateType", + "x-enum-name": "ProjectEmailTemplateId", "x-enum-keys": [] }, "in": "path" @@ -36102,7 +37073,7 @@ "zh-tw", "zu" ], - "x-enum-name": "EmailTemplateLocale", + "x-enum-name": "ProjectEmailTemplateLocale", "x-enum-keys": [], "default": "" }, @@ -36135,7 +37106,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 1098, + "weight": 1117, "cookies": false, "type": "", "demo": "project\/list-variables.md", @@ -36186,21 +37157,1003 @@ "in": "query" } ] - }, - "post": { - "summary": "Create project variable", - "operationId": "projectCreateVariable", + }, + "post": { + "summary": "Create project variable", + "operationId": "projectCreateVariable", + "tags": [ + "project" + ], + "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "responses": { + "201": { + "description": "Variable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variable" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createVariable", + "group": "variables", + "weight": 1116, + "cookies": false, + "type": "", + "demo": "project\/create-variable.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "variableId": { + "type": "string", + "description": "Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "" + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "x-example": false + } + }, + "required": [ + "variableId", + "key", + "value" + ] + } + } + } + } + } + }, + "\/project\/variables\/{variableId}": { + "get": { + "summary": "Get project variable", + "operationId": "projectGetVariable", + "tags": [ + "project" + ], + "description": "Get a variable by its unique ID. ", + "responses": { + "200": { + "description": "Variable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variable" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getVariable", + "group": "variables", + "weight": 1118, + "cookies": false, + "type": "", + "demo": "project\/get-variable.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update project variable", + "operationId": "projectUpdateVariable", + "tags": [ + "project" + ], + "description": "Update variable by its unique ID.", + "responses": { + "200": { + "description": "Variable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variable" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateVariable", + "group": "variables", + "weight": 1120, + "cookies": false, + "type": "", + "demo": "project\/update-variable.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "x-example": "", + "x-nullable": true + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete project variable", + "operationId": "projectDeleteVariable", + "tags": [ + "project" + ], + "description": "Delete a variable by its unique ID. ", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteVariable", + "group": "variables", + "weight": 1119, + "cookies": false, + "type": "", + "demo": "project\/delete-variable.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/proxy\/rules": { + "get": { + "summary": "List rules", + "operationId": "proxyListRules", + "tags": [ + "proxy" + ], + "description": "Get a list of all the proxy rules. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rule List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/proxyRuleList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listRules", + "group": "rules", + "weight": 1213, + "cookies": false, + "type": "", + "demo": "proxy\/list-rules.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/proxy\/rules\/api": { + "post": { + "summary": "Create API rule", + "operationId": "proxyCreateAPIRule", + "tags": [ + "proxy" + ], + "description": "Create a new proxy rule for serving Appwrite's API on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", + "responses": { + "201": { + "description": "Rule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/proxyRule" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createAPIRule", + "group": "rules", + "weight": 1208, + "cookies": false, + "type": "", + "demo": "proxy\/create-api-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": null + } + }, + "required": [ + "domain" + ] + } + } + } + } + } + }, + "\/proxy\/rules\/function": { + "post": { + "summary": "Create function rule", + "operationId": "proxyCreateFunctionRule", + "tags": [ + "proxy" + ], + "description": "Create a new proxy rule for executing Appwrite Function on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", + "responses": { + "201": { + "description": "Rule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/proxyRule" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createFunctionRule", + "group": "rules", + "weight": 1210, + "cookies": false, + "type": "", + "demo": "proxy\/create-function-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": null + }, + "functionId": { + "type": "string", + "description": "ID of function to be executed.", + "x-example": "" + }, + "branch": { + "type": "string", + "description": "Name of VCS branch to deploy changes automatically", + "x-example": "" + } + }, + "required": [ + "domain", + "functionId" + ] + } + } + } + } + } + }, + "\/proxy\/rules\/redirect": { + "post": { + "summary": "Create Redirect rule", + "operationId": "proxyCreateRedirectRule", + "tags": [ + "proxy" + ], + "description": "Create a new proxy rule for to redirect from custom domain to another domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", + "responses": { + "201": { + "description": "Rule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/proxyRule" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createRedirectRule", + "group": "rules", + "weight": 1211, + "cookies": false, + "type": "", + "demo": "proxy\/create-redirect-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": null + }, + "url": { + "type": "string", + "description": "Target URL of redirection", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "statusCode": { + "type": "string", + "description": "Status code of redirection", + "x-example": "301", + "enum": [ + "301", + "302", + "307", + "308" + ], + "x-enum-name": null, + "x-enum-keys": [ + "Moved Permanently 301", + "Found 302", + "Temporary Redirect 307", + "Permanent Redirect 308" + ] + }, + "resourceId": { + "type": "string", + "description": "ID of parent resource.", + "x-example": "" + }, + "resourceType": { + "type": "string", + "description": "Type of parent resource.", + "x-example": "site", + "enum": [ + "site", + "function" + ], + "x-enum-name": "ProxyResourceType", + "x-enum-keys": [ + "Site", + "Function" + ] + } + }, + "required": [ + "domain", + "url", + "statusCode", + "resourceId", + "resourceType" + ] + } + } + } + } + } + }, + "\/proxy\/rules\/site": { + "post": { + "summary": "Create site rule", + "operationId": "proxyCreateSiteRule", + "tags": [ + "proxy" + ], + "description": "Create a new proxy rule for serving Appwrite Site on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", + "responses": { + "201": { + "description": "Rule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/proxyRule" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSiteRule", + "group": "rules", + "weight": 1209, + "cookies": false, + "type": "", + "demo": "proxy\/create-site-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": null + }, + "siteId": { + "type": "string", + "description": "ID of site to be executed.", + "x-example": "" + }, + "branch": { + "type": "string", + "description": "Name of VCS branch to deploy changes automatically", + "x-example": "" + } + }, + "required": [ + "domain", + "siteId" + ] + } + } + } + } + } + }, + "\/proxy\/rules\/{ruleId}": { + "get": { + "summary": "Get rule", + "operationId": "proxyGetRule", + "tags": [ + "proxy" + ], + "description": "Get a proxy rule by its unique ID.", + "responses": { + "200": { + "description": "Rule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/proxyRule" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getRule", + "group": "rules", + "weight": 1212, + "cookies": false, + "type": "", + "demo": "proxy\/get-rule.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "ruleId", + "description": "Rule ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete rule", + "operationId": "proxyDeleteRule", + "tags": [ + "proxy" + ], + "description": "Delete a proxy rule by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteRule", + "group": "rules", + "weight": 1214, + "cookies": false, + "type": "", + "demo": "proxy\/delete-rule.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "ruleId", + "description": "Rule ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/proxy\/rules\/{ruleId}\/status": { + "patch": { + "summary": "Update rule status", + "operationId": "proxyUpdateRuleStatus", + "tags": [ + "proxy" + ], + "description": "If not succeeded yet, retry verification process of a proxy rule domain. This endpoint triggers domain verification by checking DNS records. If verification is successful, a TLS certificate will be automatically provisioned for the domain asynchronously in the background.", + "responses": { + "200": { + "description": "Rule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/proxyRule" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateRuleStatus", + "group": "rules", + "weight": 1215, + "cookies": false, + "type": "", + "demo": "proxy\/update-rule-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "ruleId", + "description": "Rule ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/reports": { + "get": { + "summary": "List reports", + "operationId": "advisorListReports", + "tags": [ + "advisor" + ], + "description": "Get a list of all the project's analyzer reports. You can use the query params to filter your results.\n", + "responses": { + "200": { + "description": "Reports List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/reportList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listReports", + "group": "reports", + "weight": 693, + "cookies": false, + "type": "", + "demo": "advisor\/list-reports.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-reports.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "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: appId, type, targetType, target, analyzedAt", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/reports\/{reportId}": { + "get": { + "summary": "Get report", + "operationId": "advisorGetReport", "tags": [ - "project" + "advisor" ], - "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "description": "Get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.\n", "responses": { - "201": { - "description": "Variable", + "200": { + "description": "Report", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/report" } } } @@ -36208,109 +38161,82 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 1097, + "method": "getReport", + "group": "reports", + "weight": 692, "cookies": false, "type": "", - "demo": "project\/create-variable.md", + "demo": "advisor\/get-report.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "reports.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-report.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "variableId": { - "type": "string", - "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "key": { - "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "" - }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "" - }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "x-example": false - } - }, - "required": [ - "variableId", - "key", - "value" - ] - } - } + "parameters": [ + { + "name": "reportId", + "description": "Report ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - } - } - }, - "\/project\/variables\/{variableId}": { - "get": { - "summary": "Get project variable", - "operationId": "projectGetVariable", + ] + }, + "delete": { + "summary": "Delete report", + "operationId": "advisorDeleteReport", "tags": [ - "project" + "advisor" ], - "description": "Get a variable by its unique ID. ", + "description": "Delete an analyzer report by its unique ID. Nested insights and CTA metadata are removed asynchronously by the deletes worker.\n", "responses": { - "200": { - "description": "Variable", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/variable" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 1099, + "method": "deleteReport", + "group": "reports", + "weight": 694, "cookies": false, "type": "", - "demo": "project\/get-variable.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "demo": "advisor\/delete-report.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "projectId:{projectId},userId:{userId}", + "scope": "reports.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/delete-report.md", "auth": { "Project": [], "Key": [] @@ -36324,31 +38250,33 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", + "name": "reportId", + "description": "Report ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] - }, - "put": { - "summary": "Update project variable", - "operationId": "projectUpdateVariable", + } + }, + "\/reports\/{reportId}\/insights": { + "get": { + "summary": "List insights", + "operationId": "advisorListInsights", "tags": [ - "project" + "advisor" ], - "description": "Update variable by its unique ID.", + "description": "List the insights produced under a single analyzer report. You can use the query params to filter your results further.\n", "responses": { "200": { - "description": "Variable", + "description": "Insights List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/insightList" } } } @@ -36356,124 +38284,148 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 1101, + "method": "listInsights", + "group": "insights", + "weight": 696, "cookies": false, "type": "", - "demo": "project\/update-variable.md", + "demo": "advisor\/list-insights.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "insights.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-insights.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", + "name": "reportId", + "description": "Parent report ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "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: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } + ] + } + }, + "\/reports\/{reportId}\/insights\/{insightId}": { + "get": { + "summary": "Get insight", + "operationId": "advisorGetInsight", + "tags": [ + "advisor" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "", - "x-nullable": true - }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "", - "x-nullable": true - }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "x-example": false, - "x-nullable": true - } + "description": "Get an insight by its unique ID, scoped to its parent report.\n", + "responses": { + "200": { + "description": "Insight", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/insight" } } } } - } - }, - "delete": { - "summary": "Delete project variable", - "operationId": "projectDeleteVariable", - "tags": [ - "project" - ], - "description": "Delete a variable by its unique ID. ", - "responses": { - "204": { - "description": "No content" - } }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 1100, + "method": "getInsight", + "group": "insights", + "weight": 695, "cookies": false, "type": "", - "demo": "project\/delete-variable.md", + "demo": "advisor\/get-insight.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "insights.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-insight.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", + "name": "reportId", + "description": "Parent report ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "insightId", + "description": "Insight ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -36504,7 +38456,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 470, + "weight": 479, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -36590,7 +38542,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 903, + "weight": 922, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -36886,7 +38838,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 473, + "weight": 482, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -36937,7 +38889,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 496, + "weight": 505, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -36988,7 +38940,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 469, + "weight": 478, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -37049,7 +39001,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 904, + "weight": 923, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -37341,7 +39293,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 472, + "weight": 481, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -37404,7 +39356,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 479, + "weight": 488, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -37486,7 +39438,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 478, + "weight": 487, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -37582,7 +39534,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 474, + "weight": 483, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -37688,7 +39640,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 482, + "weight": 491, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -37770,7 +39722,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 475, + "weight": 484, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -37888,7 +39840,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 476, + "weight": 485, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -37988,7 +39940,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 477, + "weight": 486, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -38052,7 +40004,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 480, + "weight": 489, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -38118,7 +40070,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 481, + "weight": 490, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -38210,7 +40162,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 483, + "weight": 492, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -38247,33 +40199,257 @@ "in": "path" }, { - "name": "deploymentId", - "description": "Deployment ID.", + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/sites\/{siteId}\/logs": { + "get": { + "summary": "List logs", + "operationId": "sitesListLogs", + "tags": [ + "sites" + ], + "description": "Get a list of all site logs. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Executions List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/executionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listLogs", + "group": "logs", + "weight": 494, + "cookies": false, + "type": "", + "demo": "sites\/list-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "log.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "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", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/sites\/{siteId}\/logs\/{logId}": { + "get": { + "summary": "Get log", + "operationId": "sitesGetLog", + "tags": [ + "sites" + ], + "description": "Get a site request log by its unique ID.", + "responses": { + "200": { + "description": "Execution", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/execution" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getLog", + "group": "logs", + "weight": 493, + "cookies": false, + "type": "", + "demo": "sites\/get-log.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "log.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "logId", + "description": "Log ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete log", + "operationId": "sitesDeleteLog", + "tags": [ + "sites" + ], + "description": "Delete a site log by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteLog", + "group": "logs", + "weight": 495, + "cookies": false, + "type": "", + "demo": "sites\/delete-log.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "log.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "logId", + "description": "Log ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/sites\/{siteId}\/logs": { + "\/sites\/{siteId}\/variables": { "get": { - "summary": "List logs", - "operationId": "sitesListLogs", + "summary": "List variables", + "operationId": "sitesListVariables", "tags": [ "sites" ], - "description": "Get a list of all site logs. You can use the query params to filter your results.", + "description": "Get a list of all variables of a specific site.", "responses": { "200": { - "description": "Executions List", + "description": "Variables List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/executionList" + "$ref": "#\/components\/schemas\/variableList" } } } @@ -38281,16 +40457,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 485, + "method": "listVariables", + "group": "variables", + "weight": 498, "cookies": false, "type": "", - "demo": "sites\/list-logs.md", + "demo": "sites\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "sites.read", "platforms": [ "console", "server" @@ -38311,7 +40487,7 @@ "parameters": [ { "name": "siteId", - "description": "Site ID.", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", @@ -38321,7 +40497,7 @@ }, { "name": "queries", - "description": "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", + "description": "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: key, resourceType, resourceId, secret", "required": false, "schema": { "type": "array", @@ -38344,206 +40520,6 @@ "in": "query" } ] - } - }, - "\/sites\/{siteId}\/logs\/{logId}": { - "get": { - "summary": "Get log", - "operationId": "sitesGetLog", - "tags": [ - "sites" - ], - "description": "Get a site request log by its unique ID.", - "responses": { - "200": { - "description": "Execution", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/execution" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getLog", - "group": "logs", - "weight": 484, - "cookies": false, - "type": "", - "demo": "sites\/get-log.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete log", - "operationId": "sitesDeleteLog", - "tags": [ - "sites" - ], - "description": "Delete a site log by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteLog", - "group": "logs", - "weight": 486, - "cookies": false, - "type": "", - "demo": "sites\/delete-log.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/variables": { - "get": { - "summary": "List variables", - "operationId": "sitesListVariables", - "tags": [ - "sites" - ], - "description": "Get a list of all variables of a specific site.", - "responses": { - "200": { - "description": "Variables List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/variableList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 489, - "cookies": false, - "type": "", - "demo": "sites\/list-variables.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] }, "post": { "summary": "Create variable", @@ -38568,7 +40544,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 905, + "weight": 924, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -38611,6 +40587,11 @@ "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -38628,6 +40609,7 @@ } }, "required": [ + "variableId", "key", "value" ] @@ -38661,7 +40643,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 488, + "weight": 497, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -38732,7 +40714,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 490, + "weight": 499, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -38788,7 +40770,8 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -38802,10 +40785,7 @@ "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } } @@ -38827,7 +40807,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 491, + "weight": 500, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -38900,7 +40880,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 539, + "weight": 548, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -38987,7 +40967,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 537, + "weight": 546, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -39124,7 +41104,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 538, + "weight": 547, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -39186,7 +41166,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 540, + "weight": 549, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -39320,7 +41300,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 541, + "weight": 550, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -39384,7 +41364,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 544, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -39485,7 +41465,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 1187, + "weight": 1206, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -39589,7 +41569,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 543, + "weight": 552, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -39665,7 +41645,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 545, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -39759,7 +41739,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 546, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -39830,7 +41810,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 548, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -39912,7 +41892,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 547, + "weight": 556, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -40144,7 +42124,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 549, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -40233,7 +42213,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 761, + "weight": 778, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -40320,7 +42300,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 757, + "weight": 774, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -40402,7 +42382,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 828, + "weight": 847, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -40474,7 +42454,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 824, + "weight": 843, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -40550,7 +42530,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 825, + "weight": 844, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -40619,7 +42599,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 826, + "weight": 845, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -40702,7 +42682,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 827, + "weight": 846, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -40773,7 +42753,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 829, + "weight": 848, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -40863,7 +42843,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 758, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -40925,7 +42905,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 759, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -41001,7 +42981,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 760, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -41065,7 +43045,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 768, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -41165,7 +43145,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 764, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -41292,7 +43272,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 765, + "weight": 782, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -41367,7 +43347,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 766, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -41475,7 +43455,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 767, + "weight": 784, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -41552,7 +43532,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 773, + "weight": 790, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -41605,30 +43585,295 @@ "in": "path" }, { - "name": "queries", - "description": "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 columns: key, type, size, required, array, status, error", - "required": false, + "name": "queries", + "description": "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 columns: key, type, size, required, array, status, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint": { + "post": { + "summary": "Create bigint column", + "operationId": "tablesDBCreateBigIntColumn", + "tags": [ + "tablesDB" + ], + "description": "Create a bigint column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnBigInt", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBigint" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBigIntColumn", + "group": "columns", + "weight": 803, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-bigint-column.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint\/{key}": { + "patch": { + "summary": "Update bigint column", + "operationId": "tablesDBUpdateBigIntColumn", + "tags": [ + "tablesDB" + ], + "description": "Update a bigint column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnBigInt", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBigint" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateBigIntColumn", + "group": "columns", + "weight": 804, + "cookies": false, + "type": "", + "demo": "tablesdb\/update-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-bigint-column.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } } }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { @@ -41655,7 +43900,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 774, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -41770,7 +44015,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 775, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -41890,7 +44135,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 776, + "weight": 793, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -42006,7 +44251,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 777, + "weight": 794, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -42127,7 +44372,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 778, + "weight": 795, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -42243,7 +44488,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 779, + "weight": 796, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -42364,7 +44609,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 780, + "weight": 797, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -42488,7 +44733,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 781, + "weight": 798, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -42617,7 +44862,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 782, + "weight": 799, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -42747,7 +44992,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 783, + "weight": 800, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -42882,7 +45127,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 784, + "weight": 801, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -43012,7 +45257,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 785, + "weight": 802, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -43147,7 +45392,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 786, + "weight": 805, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -43262,7 +45507,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 787, + "weight": 806, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -43382,7 +45627,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 788, + "weight": 807, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -43499,7 +45744,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 789, + "weight": 808, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -43625,7 +45870,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 806, + "weight": 825, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -43745,7 +45990,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 807, + "weight": 826, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -43865,7 +46110,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 804, + "weight": 823, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -43985,7 +46230,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 805, + "weight": 824, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -44105,7 +46350,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 790, + "weight": 809, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -44222,7 +46467,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 791, + "weight": 810, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -44348,7 +46593,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 792, + "weight": 811, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -44465,7 +46710,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 793, + "weight": 812, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -44591,7 +46836,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 794, + "weight": 813, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -44732,7 +46977,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 796, + "weight": 815, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -44863,7 +47108,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 797, + "weight": 816, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -44994,7 +47239,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 802, + "weight": 821, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -45114,7 +47359,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 803, + "weight": 822, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -45234,7 +47479,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 798, + "weight": 817, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -45350,7 +47595,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 799, + "weight": 818, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -45471,7 +47716,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 800, + "weight": 819, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -45598,7 +47843,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 801, + "weight": 820, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -45807,7 +48052,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 771, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -45886,7 +48131,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 772, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -45974,7 +48219,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 795, + "weight": 814, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -46092,7 +48337,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 811, + "weight": 830, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -46192,7 +48437,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 808, + "weight": 827, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -46334,7 +48579,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 809, + "weight": 828, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -46412,7 +48657,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 810, + "weight": 829, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -46499,7 +48744,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 899, + "weight": 918, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -46624,7 +48869,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 812, + "weight": 831, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -46810,7 +49055,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 817, + "weight": 836, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -46944,7 +49189,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 815, + "weight": 834, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -47049,7 +49294,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 819, + "weight": 838, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -47151,7 +49396,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 813, + "weight": 832, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -47263,7 +49508,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 816, + "weight": 835, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -47416,7 +49661,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 814, + "weight": 833, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -47529,7 +49774,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 818, + "weight": 837, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -47637,7 +49882,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 823, + "weight": 842, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -47767,7 +50012,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 822, + "weight": 841, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -47897,7 +50142,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 520, + "weight": 529, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -47988,7 +50233,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 518, + "weight": 527, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -48077,7 +50322,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 519, + "weight": 528, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -48143,7 +50388,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 522, + "weight": 531, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -48221,7 +50466,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 521, + "weight": 530, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -48289,7 +50534,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 527, + "weight": 536, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -48390,7 +50635,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 525, + "weight": 534, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -48508,7 +50753,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 526, + "weight": 535, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -48584,7 +50829,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 528, + "weight": 537, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -48675,7 +50920,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 1188, + "weight": 1207, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -48753,7 +50998,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 530, + "weight": 539, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -48854,7 +51099,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 523, + "weight": 532, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -48918,7 +51163,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 524, + "weight": 533, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -49003,7 +51248,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 534, + "weight": 543, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -49098,7 +51343,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 532, + "weight": 541, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -49189,7 +51434,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 533, + "weight": 542, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -49250,7 +51495,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 535, + "weight": 544, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -49322,7 +51567,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 536, + "weight": 545, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -49385,7 +51630,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 71, + "weight": 70, "cookies": false, "type": "", "demo": "users\/list.md", @@ -49472,7 +51717,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 62, + "weight": 61, "cookies": false, "type": "", "demo": "users\/create.md", @@ -49567,7 +51812,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 65, + "weight": 64, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -49657,7 +51902,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 63, + "weight": 62, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -49747,7 +51992,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 79, + "weight": 78, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -49829,7 +52074,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 103, + "weight": 102, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -49893,7 +52138,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 64, + "weight": 63, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -49983,7 +52228,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 67, + "weight": 66, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -50073,7 +52318,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 68, + "weight": 67, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -50197,7 +52442,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 69, + "weight": 68, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -50305,7 +52550,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 66, + "weight": 65, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -50415,7 +52660,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 72, + "weight": 71, "cookies": false, "type": "", "demo": "users\/get.md", @@ -50470,7 +52715,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 101, + "weight": 100, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -50534,7 +52779,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 86, + "weight": 85, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -50618,7 +52863,7 @@ "x-appwrite": { "method": "updateImpersonator", "group": "users", - "weight": 82, + "weight": 81, "cookies": false, "type": "", "demo": "users\/update-impersonator.md", @@ -50701,7 +52946,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 104, + "weight": 103, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -50787,7 +53032,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 81, + "weight": 80, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -50873,7 +53118,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 77, + "weight": 76, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -50961,7 +53206,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 76, + "weight": 75, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -51060,7 +53305,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 91, + "weight": 90, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -51198,7 +53443,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 96, + "weight": 95, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -51337,7 +53582,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 92, + "weight": 91, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -51459,7 +53704,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 93, + "weight": 92, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -51579,7 +53824,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 95, + "weight": 94, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -51699,7 +53944,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 94, + "weight": 93, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -51821,7 +54066,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 84, + "weight": 83, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -51904,7 +54149,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 85, + "weight": 84, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -51987,7 +54232,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 87, + "weight": 86, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -52071,7 +54316,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 73, + "weight": 72, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -52133,7 +54378,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 89, + "weight": 88, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -52216,7 +54461,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 75, + "weight": 74, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -52292,7 +54537,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 97, + "weight": 96, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -52350,7 +54595,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 100, + "weight": 99, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -52410,7 +54655,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 99, + "weight": 98, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -52487,7 +54732,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 80, + "weight": 79, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -52570,7 +54815,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 78, + "weight": 77, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -52656,7 +54901,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 70, + "weight": 69, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -52768,7 +55013,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 74, + "weight": 73, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -52840,7 +55085,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 90, + "weight": 89, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -52931,7 +55176,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 102, + "weight": 101, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -53005,7 +55250,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 98, + "weight": 97, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -53092,7 +55337,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 88, + "weight": 87, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -53175,7 +55420,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 83, + "weight": 82, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -53258,7 +55503,7 @@ "x-appwrite": { "method": "list", "group": "vectorsdb", - "weight": 868, + "weight": 887, "cookies": false, "type": "", "demo": "vectorsdb\/list.md", @@ -53345,7 +55590,7 @@ "x-appwrite": { "method": "create", "group": "vectorsdb", - "weight": 864, + "weight": 883, "cookies": false, "type": "", "demo": "vectorsdb\/create.md", @@ -53427,7 +55672,7 @@ "x-appwrite": { "method": "createTextEmbeddings", "group": "documents", - "weight": 890, + "weight": 909, "cookies": false, "type": "", "demo": "vectorsdb\/create-text-embeddings.md", @@ -53540,7 +55785,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 895, + "weight": 914, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -53609,7 +55854,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 891, + "weight": 910, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -53682,7 +55927,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 892, + "weight": 911, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -53748,7 +55993,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 893, + "weight": 912, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -53828,7 +56073,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 894, + "weight": 913, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -53896,7 +56141,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 896, + "weight": 915, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -53983,7 +56228,7 @@ "x-appwrite": { "method": "get", "group": "vectorsdb", - "weight": 865, + "weight": 884, "cookies": false, "type": "", "demo": "vectorsdb\/get.md", @@ -54045,7 +56290,7 @@ "x-appwrite": { "method": "update", "group": "vectorsdb", - "weight": 866, + "weight": 885, "cookies": false, "type": "", "demo": "vectorsdb\/update.md", @@ -54124,7 +56369,7 @@ "x-appwrite": { "method": "delete", "group": "vectorsdb", - "weight": 867, + "weight": 886, "cookies": false, "type": "", "demo": "vectorsdb\/delete.md", @@ -54188,7 +56433,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 875, + "weight": 894, "cookies": false, "type": "", "demo": "vectorsdb\/list-collections.md", @@ -54285,7 +56530,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 871, + "weight": 890, "cookies": false, "type": "", "demo": "vectorsdb\/create-collection.md", @@ -54399,7 +56644,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 872, + "weight": 891, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection.md", @@ -54471,7 +56716,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 873, + "weight": 892, "cookies": false, "type": "", "demo": "vectorsdb\/update-collection.md", @@ -54579,7 +56824,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 874, + "weight": 893, "cookies": false, "type": "", "demo": "vectorsdb\/delete-collection.md", @@ -54653,7 +56898,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 885, + "weight": 904, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -54775,7 +57020,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 881, + "weight": 900, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -54954,7 +57199,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 888, + "weight": 907, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-documents.md", @@ -55084,7 +57329,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 887, + "weight": 906, "cookies": false, "type": "", "demo": "vectorsdb\/update-documents.md", @@ -55185,7 +57430,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 889, + "weight": 908, "cookies": false, "type": "", "demo": "vectorsdb\/delete-documents.md", @@ -55283,7 +57528,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 884, + "weight": 903, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -55392,7 +57637,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 883, + "weight": 902, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -55540,7 +57785,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 882, + "weight": 901, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -55648,7 +57893,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 886, + "weight": 905, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -55752,7 +57997,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 880, + "weight": 899, "cookies": false, "type": "", "demo": "vectorsdb\/list-indexes.md", @@ -55848,7 +58093,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 877, + "weight": 896, "cookies": false, "type": "", "demo": "vectorsdb\/create-index.md", @@ -55988,7 +58233,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 878, + "weight": 897, "cookies": false, "type": "", "demo": "vectorsdb\/get-index.md", @@ -56062,7 +58307,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 879, + "weight": 898, "cookies": false, "type": "", "demo": "vectorsdb\/delete-index.md", @@ -56145,7 +58390,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 567, + "weight": 576, "cookies": false, "type": "", "demo": "webhooks\/list.md", @@ -56220,7 +58465,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 566, + "weight": 575, "cookies": false, "type": "", "demo": "webhooks\/create.md", @@ -56337,7 +58582,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 568, + "weight": 577, "cookies": false, "type": "", "demo": "webhooks\/get.md", @@ -56398,7 +58643,7 @@ "x-appwrite": { "method": "update", "group": null, - "weight": 570, + "weight": 579, "cookies": false, "type": "", "demo": "webhooks\/update.md", @@ -56506,7 +58751,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 569, + "weight": 578, "cookies": false, "type": "", "demo": "webhooks\/delete.md", @@ -56569,7 +58814,7 @@ "x-appwrite": { "method": "updateSecret", "group": null, - "weight": 571, + "weight": 580, "cookies": false, "type": "", "demo": "webhooks\/update-secret.md", @@ -56698,6 +58943,10 @@ { "name": "messaging", "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." + }, + { + "name": "advisor", + "description": "The Advisor service surfaces actionable reports about your project resources, with CTA descriptors for one-click remediation in the console." } ], "components": { @@ -56802,6 +59051,34 @@ "documents": "" } }, + "presenceList": { + "description": "Presences List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of presences that matched your query.", + "x-example": 5, + "format": "int32" + }, + "presences": { + "type": "array", + "description": "List of presences.", + "items": { + "$ref": "#\/components\/schemas\/presence" + }, + "x-example": "" + } + }, + "required": [ + "total", + "presences" + ], + "example": { + "total": 5, + "presences": "" + } + }, "tableList": { "description": "Tables List", "type": "object", @@ -57740,6 +60017,34 @@ "statuses": "" } }, + "proxyRuleList": { + "description": "Rule List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rules that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rules": { + "type": "array", + "description": "List of rules.", + "items": { + "$ref": "#\/components\/schemas\/proxyRule" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rules" + ], + "example": { + "total": 5, + "rules": "" + } + }, "localeCodeList": { "description": "Locale codes list", "type": "object", @@ -58020,6 +60325,62 @@ "embeddings": "" } }, + "insightList": { + "description": "Insights List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of insights that matched your query.", + "x-example": 5, + "format": "int32" + }, + "insights": { + "type": "array", + "description": "List of insights.", + "items": { + "$ref": "#\/components\/schemas\/insight" + }, + "x-example": "" + } + }, + "required": [ + "total", + "insights" + ], + "example": { + "total": 5, + "insights": "" + } + }, + "reportList": { + "description": "Reports List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of reports that matched your query.", + "x-example": 5, + "format": "int32" + }, + "reports": { + "type": "array", + "description": "List of reports.", + "items": { + "$ref": "#\/components\/schemas\/report" + }, + "x-example": "" + } + }, + "required": [ + "total", + "reports" + ], + "example": { + "total": 5, + "reports": "" + } + }, "database": { "description": "Database", "type": "object", @@ -58064,7 +60425,7 @@ "type": "array", "description": "Database backup policies.", "items": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/backupPolicy" }, "x-example": {} }, @@ -58072,7 +60433,7 @@ "type": "array", "description": "Database backup archives.", "items": { - "$ref": "#\/components\/schemas\/collection" + "$ref": "#\/components\/schemas\/backupArchive" }, "x-example": {} } @@ -58206,6 +60567,9 @@ { "$ref": "#\/components\/schemas\/attributeBoolean" }, + { + "$ref": "#\/components\/schemas\/attributeBigint" + }, { "$ref": "#\/components\/schemas\/attributeInteger" }, @@ -58259,6 +60623,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/components\/schemas\/attributeBoolean", + "bigint": "#\/components\/schemas\/attributeBigint", "integer": "#\/components\/schemas\/attributeInteger", "double": "#\/components\/schemas\/attributeFloat", "string": "#\/components\/schemas\/attributeString", @@ -58280,6 +60645,9 @@ "#\/components\/schemas\/attributeBoolean": { "type": "boolean" }, + "#\/components\/schemas\/attributeBigint": { + "type": "bigint" + }, "#\/components\/schemas\/attributeInteger": { "type": "integer" }, @@ -58407,6 +60775,9 @@ { "$ref": "#\/components\/schemas\/attributeBoolean" }, + { + "$ref": "#\/components\/schemas\/attributeBigint" + }, { "$ref": "#\/components\/schemas\/attributeInteger" }, @@ -58460,6 +60831,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/components\/schemas\/attributeBoolean", + "bigint": "#\/components\/schemas\/attributeBigint", "integer": "#\/components\/schemas\/attributeInteger", "double": "#\/components\/schemas\/attributeFloat", "string": "#\/components\/schemas\/attributeString", @@ -58481,6 +60853,9 @@ "#\/components\/schemas\/attributeBoolean": { "type": "boolean" }, + "#\/components\/schemas\/attributeBigint": { + "type": "bigint" + }, "#\/components\/schemas\/attributeInteger": { "type": "integer" }, @@ -58742,6 +61117,104 @@ "default": 10 } }, + "attributeBigint": { + "description": "AttributeBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int64", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "attributeFloat": { "description": "AttributeFloat", "type": "object", @@ -60500,6 +62973,9 @@ { "$ref": "#\/components\/schemas\/columnBoolean" }, + { + "$ref": "#\/components\/schemas\/columnBigint" + }, { "$ref": "#\/components\/schemas\/columnInteger" }, @@ -60553,6 +63029,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/components\/schemas\/columnBoolean", + "bigint": "#\/components\/schemas\/columnBigint", "integer": "#\/components\/schemas\/columnInteger", "double": "#\/components\/schemas\/columnFloat", "string": "#\/components\/schemas\/columnString", @@ -60574,6 +63051,9 @@ "#\/components\/schemas\/columnBoolean": { "type": "boolean" }, + "#\/components\/schemas\/columnBigint": { + "type": "bigint" + }, "#\/components\/schemas\/columnInteger": { "type": "integer" }, @@ -60701,6 +63181,9 @@ { "$ref": "#\/components\/schemas\/columnBoolean" }, + { + "$ref": "#\/components\/schemas\/columnBigint" + }, { "$ref": "#\/components\/schemas\/columnInteger" }, @@ -60754,6 +63237,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/components\/schemas\/columnBoolean", + "bigint": "#\/components\/schemas\/columnBigint", "integer": "#\/components\/schemas\/columnInteger", "double": "#\/components\/schemas\/columnFloat", "string": "#\/components\/schemas\/columnString", @@ -60775,6 +63259,9 @@ "#\/components\/schemas\/columnBoolean": { "type": "boolean" }, + "#\/components\/schemas\/columnBigint": { + "type": "bigint" + }, "#\/components\/schemas\/columnInteger": { "type": "integer" }, @@ -61036,6 +63523,104 @@ "default": 10 } }, + "columnBigint": { + "description": "ColumnBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 10, + "format": "int64", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "columnFloat": { "description": "ColumnFloat", "type": "object", @@ -62782,6 +65367,89 @@ "isAdmin": false } }, + "presence": { + "description": "Presence", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Presence ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "string", + "description": "Presence sequence ID.", + "x-example": "1", + "readOnly": true + }, + "$createdAt": { + "type": "string", + "description": "Presence creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Presence update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Presence permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "674af8f3e12a5f9ac0be" + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "online", + "nullable": true + }, + "source": { + "type": "string", + "description": "Presence source.", + "x-example": "HTTP" + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "additionalProperties": true, + "x-additional-properties-key": "metadata", + "required": [ + "$id", + "$sequence", + "$createdAt", + "$updatedAt", + "$permissions", + "userId", + "source" + ], + "example": { + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "userId": "674af8f3e12a5f9ac0be", + "status": "online", + "source": "HTTP", + "expiresAt": "2020-10-15T06:38:00.000+00:00" + } + }, "log": { "description": "Log", "type": "object", @@ -65364,213 +68032,14 @@ "description": "Project name.", "x-example": "New Project" }, - "description": { - "type": "string", - "description": "Project description.", - "x-example": "This is a new project." - }, "teamId": { "type": "string", "description": "Project team ID.", "x-example": "1592981250" }, - "logo": { - "type": "string", - "description": "Project logo file ID.", - "x-example": "5f5c451b403cb" - }, - "url": { - "type": "string", - "description": "Project website URL.", - "x-example": "5f5c451b403cb" - }, - "legalName": { - "type": "string", - "description": "Company legal name.", - "x-example": "Company LTD." - }, - "legalCountry": { - "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", - "x-example": "US" - }, - "legalState": { - "type": "string", - "description": "State name.", - "x-example": "New York" - }, - "legalCity": { - "type": "string", - "description": "City name.", - "x-example": "New York City." - }, - "legalAddress": { - "type": "string", - "description": "Company Address.", - "x-example": "620 Eighth Avenue, New York, NY 10018" - }, - "legalTaxId": { - "type": "string", - "description": "Company Tax ID.", - "x-example": "131102020" - }, - "authDuration": { - "type": "integer", - "description": "Session duration in seconds.", - "x-example": 60, - "format": "int32" - }, - "authLimit": { - "type": "integer", - "description": "Max users allowed. 0 is unlimited.", - "x-example": 100, - "format": "int32" - }, - "authSessionsLimit": { - "type": "integer", - "description": "Max sessions allowed per user. 100 maximum.", - "x-example": 10, - "format": "int32" - }, - "authPasswordHistory": { - "type": "integer", - "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", - "x-example": 5, - "format": "int32" - }, - "authPasswordDictionary": { - "type": "boolean", - "description": "Whether or not to check user's password against most commonly used passwords.", - "x-example": true - }, - "authPersonalDataCheck": { - "type": "boolean", - "description": "Whether or not to check the user password for similarity with their personal data.", - "x-example": true - }, - "authDisposableEmails": { - "type": "boolean", - "description": "Whether or not to disallow disposable email addresses during signup and email updates.", - "x-example": true - }, - "authCanonicalEmails": { - "type": "boolean", - "description": "Whether or not to require canonical email addresses during signup and email updates.", - "x-example": true - }, - "authFreeEmails": { - "type": "boolean", - "description": "Whether or not to disallow free email addresses during signup and email updates.", - "x-example": true - }, - "authMockNumbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs).", - "items": { - "$ref": "#\/components\/schemas\/mockNumber" - }, - "x-example": [ - {} - ] - }, - "authSessionAlerts": { - "type": "boolean", - "description": "Whether or not to send session alert emails to users.", - "x-example": true - }, - "authMembershipsUserName": { - "type": "boolean", - "description": "Whether or not to show user names in the teams membership response.", - "x-example": true - }, - "authMembershipsUserEmail": { - "type": "boolean", - "description": "Whether or not to show user emails in the teams membership response.", - "x-example": true - }, - "authMembershipsMfa": { - "type": "boolean", - "description": "Whether or not to show user MFA status in the teams membership response.", - "x-example": true - }, - "authMembershipsUserId": { - "type": "boolean", - "description": "Whether or not to show user IDs in the teams membership response.", - "x-example": true - }, - "authMembershipsUserPhone": { - "type": "boolean", - "description": "Whether or not to show user phone numbers in the teams membership response.", - "x-example": true - }, - "authInvalidateSessions": { - "type": "boolean", - "description": "Whether or not all existing sessions should be invalidated on password change", - "x-example": true - }, - "oAuthProviders": { - "type": "array", - "description": "List of Auth Providers.", - "items": { - "$ref": "#\/components\/schemas\/authProvider" - }, - "x-example": [ - {} - ] - }, - "platforms": { - "type": "array", - "description": "List of Platforms.", - "items": { - "anyOf": [ - { - "$ref": "#\/components\/schemas\/platformWeb" - }, - { - "$ref": "#\/components\/schemas\/platformApple" - }, - { - "$ref": "#\/components\/schemas\/platformAndroid" - }, - { - "$ref": "#\/components\/schemas\/platformWindows" - }, - { - "$ref": "#\/components\/schemas\/platformLinux" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/components\/schemas\/platformWeb", - "apple": "#\/components\/schemas\/platformApple", - "android": "#\/components\/schemas\/platformAndroid", - "windows": "#\/components\/schemas\/platformWindows", - "linux": "#\/components\/schemas\/platformLinux" - } - } - }, - "x-example": {} - }, - "webhooks": { - "type": "array", - "description": "List of Webhooks.", - "items": { - "$ref": "#\/components\/schemas\/webhook" - }, - "x-example": {} - }, - "keys": { - "type": "array", - "description": "List of API Keys.", - "items": { - "$ref": "#\/components\/schemas\/key" - }, - "x-example": {} - }, "devKeys": { "type": "array", - "description": "List of dev keys.", + "description": "Deprecated since 1.9.5: List of dev keys.", "items": { "$ref": "#\/components\/schemas\/devKey" }, @@ -65653,140 +68122,29 @@ "description": "Project status", "x-example": "active" }, - "authEmailPassword": { - "type": "boolean", - "description": "Email\/Password auth method status", - "x-example": true - }, - "authUsersAuthMagicURL": { - "type": "boolean", - "description": "Magic URL auth method status", - "x-example": true - }, - "authEmailOtp": { - "type": "boolean", - "description": "Email (OTP) auth method status", - "x-example": true - }, - "authAnonymous": { - "type": "boolean", - "description": "Anonymous auth method status", - "x-example": true - }, - "authInvites": { - "type": "boolean", - "description": "Invites auth method status", - "x-example": true - }, - "authJWT": { - "type": "boolean", - "description": "JWT auth method status", - "x-example": true - }, - "authPhone": { - "type": "boolean", - "description": "Phone auth method status", - "x-example": true - }, - "serviceStatusForAccount": { - "type": "boolean", - "description": "Account service status", - "x-example": true - }, - "serviceStatusForAvatars": { - "type": "boolean", - "description": "Avatars service status", - "x-example": true - }, - "serviceStatusForDatabases": { - "type": "boolean", - "description": "Databases (legacy) service status", - "x-example": true - }, - "serviceStatusForTablesdb": { - "type": "boolean", - "description": "TablesDB service status", - "x-example": true - }, - "serviceStatusForLocale": { - "type": "boolean", - "description": "Locale service status", - "x-example": true - }, - "serviceStatusForHealth": { - "type": "boolean", - "description": "Health service status", - "x-example": true - }, - "serviceStatusForProject": { - "type": "boolean", - "description": "Project service status", - "x-example": true - }, - "serviceStatusForStorage": { - "type": "boolean", - "description": "Storage service status", - "x-example": true - }, - "serviceStatusForTeams": { - "type": "boolean", - "description": "Teams service status", - "x-example": true - }, - "serviceStatusForUsers": { - "type": "boolean", - "description": "Users service status", - "x-example": true - }, - "serviceStatusForVcs": { - "type": "boolean", - "description": "VCS service status", - "x-example": true - }, - "serviceStatusForSites": { - "type": "boolean", - "description": "Sites service status", - "x-example": true - }, - "serviceStatusForFunctions": { - "type": "boolean", - "description": "Functions service status", - "x-example": true - }, - "serviceStatusForProxy": { - "type": "boolean", - "description": "Proxy service status", - "x-example": true - }, - "serviceStatusForGraphql": { - "type": "boolean", - "description": "GraphQL service status", - "x-example": true - }, - "serviceStatusForMigrations": { - "type": "boolean", - "description": "Migrations service status", - "x-example": true - }, - "serviceStatusForMessaging": { - "type": "boolean", - "description": "Messaging service status", - "x-example": true - }, - "protocolStatusForRest": { - "type": "boolean", - "description": "REST protocol status", - "x-example": true + "authMethods": { + "type": "array", + "description": "List of auth methods.", + "items": { + "$ref": "#\/components\/schemas\/projectAuthMethod" + }, + "x-example": {} }, - "protocolStatusForGraphql": { - "type": "boolean", - "description": "GraphQL protocol status", - "x-example": true + "services": { + "type": "array", + "description": "List of services.", + "items": { + "$ref": "#\/components\/schemas\/projectService" + }, + "x-example": {} }, - "protocolStatusForWebsocket": { - "type": "boolean", - "description": "Websocket protocol status", - "x-example": true + "protocols": { + "type": "array", + "description": "List of protocols.", + "items": { + "$ref": "#\/components\/schemas\/projectProtocol" + }, + "x-example": {} }, "region": { "type": "string", @@ -65820,37 +68178,7 @@ "$createdAt", "$updatedAt", "name", - "description", "teamId", - "logo", - "url", - "legalName", - "legalCountry", - "legalState", - "legalCity", - "legalAddress", - "legalTaxId", - "authDuration", - "authLimit", - "authSessionsLimit", - "authPasswordHistory", - "authPasswordDictionary", - "authPersonalDataCheck", - "authDisposableEmails", - "authCanonicalEmails", - "authFreeEmails", - "authMockNumbers", - "authSessionAlerts", - "authMembershipsUserName", - "authMembershipsUserEmail", - "authMembershipsMfa", - "authMembershipsUserId", - "authMembershipsUserPhone", - "authInvalidateSessions", - "oAuthProviders", - "platforms", - "webhooks", - "keys", "devKeys", "smtpEnabled", "smtpSenderName", @@ -65866,33 +68194,9 @@ "pingedAt", "labels", "status", - "authEmailPassword", - "authUsersAuthMagicURL", - "authEmailOtp", - "authAnonymous", - "authInvites", - "authJWT", - "authPhone", - "serviceStatusForAccount", - "serviceStatusForAvatars", - "serviceStatusForDatabases", - "serviceStatusForTablesdb", - "serviceStatusForLocale", - "serviceStatusForHealth", - "serviceStatusForProject", - "serviceStatusForStorage", - "serviceStatusForTeams", - "serviceStatusForUsers", - "serviceStatusForVcs", - "serviceStatusForSites", - "serviceStatusForFunctions", - "serviceStatusForProxy", - "serviceStatusForGraphql", - "serviceStatusForMigrations", - "serviceStatusForMessaging", - "protocolStatusForRest", - "protocolStatusForGraphql", - "protocolStatusForWebsocket", + "authMethods", + "services", + "protocols", "region", "billingLimits", "blocks", @@ -65903,41 +68207,7 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "New Project", - "description": "This is a new project.", "teamId": "1592981250", - "logo": "5f5c451b403cb", - "url": "5f5c451b403cb", - "legalName": "Company LTD.", - "legalCountry": "US", - "legalState": "New York", - "legalCity": "New York City.", - "legalAddress": "620 Eighth Avenue, New York, NY 10018", - "legalTaxId": "131102020", - "authDuration": 60, - "authLimit": 100, - "authSessionsLimit": 10, - "authPasswordHistory": 5, - "authPasswordDictionary": true, - "authPersonalDataCheck": true, - "authDisposableEmails": true, - "authCanonicalEmails": true, - "authFreeEmails": true, - "authMockNumbers": [ - {} - ], - "authSessionAlerts": true, - "authMembershipsUserName": true, - "authMembershipsUserEmail": true, - "authMembershipsMfa": true, - "authMembershipsUserId": true, - "authMembershipsUserPhone": true, - "authInvalidateSessions": true, - "oAuthProviders": [ - {} - ], - "platforms": {}, - "webhooks": {}, - "keys": {}, "devKeys": {}, "smtpEnabled": false, "smtpSenderName": "John Appwrite", @@ -65955,39 +68225,124 @@ "vip" ], "status": "active", - "authEmailPassword": true, - "authUsersAuthMagicURL": true, - "authEmailOtp": true, - "authAnonymous": true, - "authInvites": true, - "authJWT": true, - "authPhone": true, - "serviceStatusForAccount": true, - "serviceStatusForAvatars": true, - "serviceStatusForDatabases": true, - "serviceStatusForTablesdb": true, - "serviceStatusForLocale": true, - "serviceStatusForHealth": true, - "serviceStatusForProject": true, - "serviceStatusForStorage": true, - "serviceStatusForTeams": true, - "serviceStatusForUsers": true, - "serviceStatusForVcs": true, - "serviceStatusForSites": true, - "serviceStatusForFunctions": true, - "serviceStatusForProxy": true, - "serviceStatusForGraphql": true, - "serviceStatusForMigrations": true, - "serviceStatusForMessaging": true, - "protocolStatusForRest": true, - "protocolStatusForGraphql": true, - "protocolStatusForWebsocket": true, + "authMethods": {}, + "services": {}, + "protocols": {}, "region": "fra", "billingLimits": "", "blocks": "", "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, + "projectAuthMethod": { + "description": "ProjectAuthMethod", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Auth method ID.", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "ProjectAuthMethodId" + }, + "enabled": { + "type": "boolean", + "description": "Auth method status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "email-password", + "enabled": false + } + }, + "projectService": { + "description": "ProjectService", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Service ID.", + "x-example": "sites", + "enum": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging", + "advisor" + ], + "x-enum-name": "ProjectServiceId" + }, + "enabled": { + "type": "boolean", + "description": "Service status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "sites", + "enabled": false + } + }, + "projectProtocol": { + "description": "ProjectProtocol", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Protocol ID.", + "x-example": "graphql", + "enum": [ + "rest", + "graphql", + "websocket" + ], + "x-enum-name": "ProjectProtocolId" + }, + "enabled": { + "type": "boolean", + "description": "Protocol status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "graphql", + "enabled": false + } + }, "webhook": { "description": "Webhook", "type": "object", @@ -66729,19 +69084,38 @@ "type": "string", "description": "Google OAuth2 client secret.", "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" + }, + "prompt": { + "type": "array", + "description": "Google OAuth2 prompt values.", + "items": { + "type": "string", + "enum": [ + "none", + "consent", + "select_account" + ] + }, + "x-example": [ + "consent" + ] } }, "required": [ "$id", "enabled", "clientId", - "clientSecret" + "clientSecret", + "prompt" ], "example": { "$id": "github", "enabled": false, "clientId": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", - "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj" + "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj", + "prompt": [ + "consent" + ] } }, "oAuth2Zoom": { @@ -67770,12 +70144,12 @@ "description": "OpenID Connect authorization endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" }, - "tokenUrl": { + "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/token" }, - "userInfoUrl": { + "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" @@ -67788,8 +70162,8 @@ "clientSecret", "wellKnownURL", "authorizationURL", - "tokenUrl", - "userInfoUrl" + "tokenURL", + "userInfoURL" ], "example": { "$id": "github", @@ -67798,8 +70172,8 @@ "clientSecret": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", "wellKnownURL": "https:\/\/myoauth.com\/.well-known\/openid-configuration", "authorizationURL": "https:\/\/myoauth.com\/oauth2\/authorize", - "tokenUrl": "https:\/\/myoauth.com\/oauth2\/token", - "userInfoUrl": "https:\/\/myoauth.com\/oauth2\/userinfo" + "tokenURL": "https:\/\/myoauth.com\/oauth2\/token", + "userInfoURL": "https:\/\/myoauth.com\/oauth2\/userinfo" } }, "oAuth2Okta": { @@ -68433,51 +70807,6 @@ "userMFA": true } }, - "authProvider": { - "description": "AuthProvider", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Auth Provider.", - "x-example": "github" - }, - "name": { - "type": "string", - "description": "Auth Provider name.", - "x-example": "GitHub" - }, - "appId": { - "type": "string", - "description": "OAuth 2.0 application ID.", - "x-example": "259125845563242502" - }, - "secret": { - "type": "string", - "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Auth Provider is active and can be used to create session.", - "x-example": "" - } - }, - "required": [ - "key", - "name", - "appId", - "secret", - "enabled" - ], - "example": { - "key": "github", - "name": "GitHub", - "appId": "259125845563242502", - "secret": "", - "enabled": "" - } - }, "platformWeb": { "description": "Platform Web", "type": "object", @@ -69304,6 +71633,131 @@ "slug": "s-1vcpu-512mb" } }, + "proxyRule": { + "description": "Rule", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Rule ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Rule creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Rule update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": "appwrite.company.com" + }, + "type": { + "type": "string", + "description": "Action definition for the rule. Possible values are \"api\", \"deployment\", or \"redirect\"", + "x-example": "deployment" + }, + "trigger": { + "type": "string", + "description": "Defines how the rule was created. Possible values are \"manual\" or \"deployment\"", + "x-example": "manual" + }, + "redirectUrl": { + "type": "string", + "description": "URL to redirect to. Used if type is \"redirect\"", + "x-example": "https:\/\/appwrite.io\/docs" + }, + "redirectStatusCode": { + "type": "integer", + "description": "Status code to apply during redirect. Used if type is \"redirect\"", + "x-example": 301, + "format": "int32" + }, + "deploymentId": { + "type": "string", + "description": "ID of deployment. Used if type is \"deployment\"", + "x-example": "n3u9feiwmf" + }, + "deploymentResourceType": { + "type": "string", + "description": "Type of deployment. Possible values are \"function\", \"site\". Used if rule's type is \"deployment\".", + "x-example": "function", + "enum": [ + "function", + "site" + ], + "nullable": true + }, + "deploymentResourceId": { + "type": "string", + "description": "ID of deployment's resource (site or function ID). Used if type is \"deployment\"", + "x-example": "n3u9feiwmf" + }, + "deploymentVcsProviderBranch": { + "type": "string", + "description": "Name of Git branch that updates rule. Used if type is \"deployment\"", + "x-example": "main" + }, + "status": { + "type": "string", + "description": "Domain verification status. Possible values are \"unverified\", \"verifying\", \"verified\"", + "x-example": "verified", + "enum": [ + "unverified", + "verifying", + "verified" + ] + }, + "logs": { + "type": "string", + "description": "Logs from rule verification or certificate generation. Certificate generation logs are prioritized if both are available.", + "x-example": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record." + }, + "renewAt": { + "type": "string", + "description": "Certificate auto-renewal date in ISO 8601 format.", + "x-example": "datetime" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "domain", + "type", + "trigger", + "redirectUrl", + "redirectStatusCode", + "deploymentId", + "deploymentResourceId", + "deploymentVcsProviderBranch", + "status", + "logs", + "renewAt" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "domain": "appwrite.company.com", + "type": "deployment", + "trigger": "manual", + "redirectUrl": "https:\/\/appwrite.io\/docs", + "redirectStatusCode": 301, + "deploymentId": "n3u9feiwmf", + "deploymentResourceType": "function", + "deploymentResourceId": "n3u9feiwmf", + "deploymentVcsProviderBranch": "main", + "status": "verified", + "logs": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record.", + "renewAt": "datetime" + } + }, "emailTemplate": { "description": "EmailTemplate", "type": "object", @@ -70012,6 +72466,298 @@ "expired": false } }, + "insight": { + "description": "Insight", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Insight ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Insight creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Insight update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "reportId": { + "type": "string", + "description": "Parent report ID. Insights always belong to a report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).", + "x-example": "tablesDBIndex" + }, + "severity": { + "type": "string", + "description": "Insight severity. One of info, warning, critical.", + "x-example": "warning" + }, + "status": { + "type": "string", + "description": "Insight status. One of active, dismissed.", + "x-example": "active" + }, + "resourceType": { + "type": "string", + "description": "Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.", + "x-example": "databases" + }, + "resourceId": { + "type": "string", + "description": "ID of the resource the insight is about.", + "x-example": "main" + }, + "parentResourceType": { + "type": "string", + "description": "Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table \u2192 resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.", + "x-example": "tables" + }, + "parentResourceId": { + "type": "string", + "description": "ID of the parent resource. Empty when the resource has no parent.", + "x-example": "orders" + }, + "title": { + "type": "string", + "description": "Insight title.", + "x-example": "Missing index on collection orders" + }, + "summary": { + "type": "string", + "description": "Short markdown summary describing the insight.", + "x-example": "Queries against `orders.status` are scanning the full collection." + }, + "ctas": { + "type": "array", + "description": "List of call-to-action buttons attached to this insight.", + "items": { + "$ref": "#\/components\/schemas\/insightCTA" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the insight was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + }, + "dismissedAt": { + "type": "string", + "description": "Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + }, + "dismissedBy": { + "type": "string", + "description": "User ID that dismissed the insight. Empty when not dismissed.", + "x-example": "5e5ea5c16897e", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "reportId", + "type", + "severity", + "status", + "resourceType", + "resourceId", + "parentResourceType", + "parentResourceId", + "title", + "summary", + "ctas" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "reportId": "5e5ea5c16897e", + "type": "tablesDBIndex", + "severity": "warning", + "status": "active", + "resourceType": "databases", + "resourceId": "main", + "parentResourceType": "tables", + "parentResourceId": "orders", + "title": "Missing index on collection orders", + "summary": "Queries against `orders.status` are scanning the full collection.", + "ctas": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedBy": "5e5ea5c16897e" + } + }, + "insightCTA": { + "description": "InsightCTA", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Human-readable label for the CTA, used in UI.", + "x-example": "Create missing index" + }, + "service": { + "type": "string", + "description": "Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource \u2014 for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.", + "x-example": "tablesDB" + }, + "method": { + "type": "string", + "description": "Public API method on the chosen service the client should invoke when this CTA is triggered.", + "x-example": "createIndex" + }, + "params": { + "type": "object", + "description": "Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId\/tableId\/columns for tablesDB, databaseId\/collectionId\/attributes for the legacy Databases API).", + "x-example": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "required": [ + "label", + "service", + "method", + "params" + ], + "example": { + "label": "Create missing index", + "service": "tablesDB", + "method": "createIndex", + "params": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "report": { + "description": "Report", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Report ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Report creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Report update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "ID of the third-party app that submitted the report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.", + "x-example": "lighthouse" + }, + "title": { + "type": "string", + "description": "Short, human-readable title for the report.", + "x-example": "Lighthouse audit for https:\/\/appwrite.io\/" + }, + "summary": { + "type": "string", + "description": "Markdown summary describing the report.", + "x-example": "Performance score 78. 4 opportunities found." + }, + "targetType": { + "type": "string", + "description": "Plural noun describing what the report analyzes, e.g. databases, sites, urls.", + "x-example": "urls" + }, + "target": { + "type": "string", + "description": "Free-form target identifier (URL for lighthouse, resource ID for db).", + "x-example": "https:\/\/appwrite.io\/" + }, + "categories": { + "type": "array", + "description": "Categories covered by the report, e.g. performance, accessibility.", + "items": { + "type": "string" + }, + "x-example": [ + "performance", + "accessibility" + ] + }, + "insights": { + "type": "array", + "description": "Insights nested under this report.", + "items": { + "$ref": "#\/components\/schemas\/insight" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the report was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "type", + "title", + "summary", + "targetType", + "target", + "categories", + "insights" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "type": "lighthouse", + "title": "Lighthouse audit for https:\/\/appwrite.io\/", + "summary": "Performance score 78. 4 opportunities found.", + "targetType": "urls", + "target": "https:\/\/appwrite.io\/", + "categories": [ + "performance", + "accessibility" + ], + "insights": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00" + } + }, "activityEvent": { "description": "ActivityEvent", "type": "object", @@ -70278,7 +73024,7 @@ }, "status": { "type": "string", - "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed.", + "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.", "x-example": "completed" }, "startedAt": { diff --git a/specs/latest/swagger2-latest-client.json b/specs/latest/swagger2-latest-client.json index 0464410c..75895aeb 100644 --- a/specs/latest/swagger2-latest-client.json +++ b/specs/latest/swagger2-latest-client.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.9.3", + "version": "1.9.5", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -636,7 +636,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 166, + "weight": 165, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -711,7 +711,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 168, + "weight": 167, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -835,7 +835,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 169, + "weight": 168, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -976,7 +976,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 170, + "weight": 169, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1100,7 +1100,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 174, + "weight": 173, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1237,7 +1237,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 175, + "weight": 174, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1377,7 +1377,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 167, + "weight": 166, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1478,7 +1478,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 173, + "weight": 172, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1579,7 +1579,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 171, + "weight": 170, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1680,7 +1680,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 172, + "weight": 171, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -4235,7 +4235,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 177, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4361,7 +4361,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 176, + "weight": 175, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4493,7 +4493,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 180, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4557,7 +4557,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 178, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -5045,7 +5045,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 179, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -5129,7 +5129,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 182, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5221,7 +5221,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 181, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5313,7 +5313,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 183, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -6026,7 +6026,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 755, + "weight": 772, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6093,7 +6093,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 751, + "weight": 768, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6164,7 +6164,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 752, + "weight": 769, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6227,7 +6227,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 753, + "weight": 770, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6306,7 +6306,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 754, + "weight": 771, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6371,7 +6371,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 756, + "weight": 773, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6452,7 +6452,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 897, + "weight": 916, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6566,7 +6566,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 698, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6725,7 +6725,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 699, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6828,7 +6828,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 702, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6979,7 +6979,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 700, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -7089,7 +7089,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 704, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7190,7 +7190,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 709, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7313,7 +7313,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 708, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7434,7 +7434,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 862, + "weight": 881, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -7501,7 +7501,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 858, + "weight": 877, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -7572,7 +7572,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 859, + "weight": 878, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -7635,7 +7635,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 860, + "weight": 879, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -7714,7 +7714,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 861, + "weight": 880, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -7779,7 +7779,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 863, + "weight": 882, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -7859,7 +7859,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 898, + "weight": 917, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -7969,7 +7969,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 847, + "weight": 866, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -8144,7 +8144,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 848, + "weight": 867, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -8243,7 +8243,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 851, + "weight": 870, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -8384,7 +8384,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 849, + "weight": 868, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -8488,7 +8488,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 853, + "weight": 872, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -8584,7 +8584,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 857, + "weight": 876, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -8701,7 +8701,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 856, + "weight": 875, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -8816,7 +8816,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 432, + "weight": 441, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -8902,7 +8902,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 430, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -9024,7 +9024,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 431, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -9099,7 +9099,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 117, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -9174,7 +9174,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 116, + "weight": 115, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -9673,7 +9673,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 150, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -9758,7 +9758,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 154, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -9805,46 +9805,45 @@ ] } }, - "\/storage\/buckets\/{bucketId}\/files": { + "\/presences": { "get": { - "summary": "List files", - "operationId": "storageListFiles", + "summary": "List presences", + "operationId": "presencesList", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "presences" ], - "description": "Get a list of all the user files. You can use the query params to filter your results.", + "description": "List presence logs.", "responses": { "200": { - "description": "Files List", + "description": "Presences List", "schema": { - "$ref": "#\/definitions\/fileList" + "$ref": "#\/definitions\/presenceList" } } }, "deprecated": false, "x-appwrite": { - "method": "listFiles", - "group": "files", - "weight": 544, + "method": "list", + "group": "presences", + "weight": 419, "cookies": false, "type": "", - "demo": "storage\/list-files.md", + "demo": "presences\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "presences.read", "platforms": [ "console", - "client", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [] } @@ -9857,17 +9856,9 @@ } ], "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "description": "Array of query strings generated using the Query class provided by the SDK.", "required": false, "type": "array", "collectionFormat": "multi", @@ -9877,15 +9868,6 @@ "default": [], "in": "query" }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -9894,141 +9876,59 @@ "x-example": false, "default": true, "in": "query" - } - ] - }, - "post": { - "summary": "Create file", - "operationId": "storageCreateFile", - "consumes": [ - "multipart\/form-data" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "storage" - ], - "description": "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.\n\nLarger 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.\n\nWhen 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.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", - "responses": { - "201": { - "description": "File", - "schema": { - "$ref": "#\/definitions\/file" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createFile", - "group": "files", - "weight": 1187, - "cookies": false, - "type": "upload", - "demo": "storage\/create-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", - "scope": "files.write", - "platforms": [ - "console", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "required": true, - "x-upload-id": true, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "file", - "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "required": true, - "type": "file", - "in": "formData" }, { - "name": "permissions", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "x-example": "[\"read(\"any\")\"]", - "in": "formData" + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "\/presences\/{presenceId}": { "get": { - "summary": "Get file", - "operationId": "storageGetFile", + "summary": "Get presence", + "operationId": "presencesGet", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "presences" ], - "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", + "description": "Get a presence log by its unique ID.", "responses": { "200": { - "description": "File", + "description": "Presence", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/presence" } } }, "deprecated": false, "x-appwrite": { - "method": "getFile", - "group": "files", - "weight": 543, + "method": "get", + "group": "presences", + "weight": 418, "cookies": false, "type": "", - "demo": "storage\/get-file.md", + "demo": "presences\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "presences.read", "platforms": [ "console", - "client", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [] } @@ -10042,26 +9942,18 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", + "name": "presenceId", + "description": "Presence unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, "put": { - "summary": "Update file", - "operationId": "storageUpdateFile", + "summary": "Upsert presence", + "operationId": "presencesUpsert", "consumes": [ "application\/json" ], @@ -10069,37 +9961,64 @@ "application\/json" ], "tags": [ - "storage" + "presences" ], - "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", + "description": "Create or update a presence log by its unique ID.", "responses": { "200": { - "description": "File", + "description": "Presence", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/presence" } } }, "deprecated": false, "x-appwrite": { - "method": "updateFile", - "group": "files", - "weight": 545, + "method": "upsert", + "group": "presences", + "weight": 416, "cookies": false, "type": "", - "demo": "storage\/update-file.md", + "demo": "presences\/upsert.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.write", + "scope": "presences.write", "platforms": [ - "console", - "client", - "server" + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", + "methods": [ + { + "name": "upsert", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "presenceId", + "status", + "permissions", + "expiresAt", + "metadata" + ], + "required": [ + "presenceId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/presence" + } + ], + "description": "", + "demo": "presences\/upsert.md", + "public": true + } + ], "auth": { "Project": [] } @@ -10107,25 +10026,16 @@ "security": [ { "Project": [], - "Session": [], - "JWT": [] + "Session": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", + "name": "presenceId", + "description": "Presence unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -10134,15 +10044,884 @@ "schema": { "type": "object", "properties": { - "name": { + "userId": { "type": "string", - "description": "File name.", + "description": "User ID.", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "default": null, + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "default": [], + "x-example": "{}" + } + }, + "required": [ + "status" + ] + } + } + ] + }, + "patch": { + "summary": "Update presence", + "operationId": "presencesUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "presences" + ], + "description": "Update a presence log by its unique ID.", + "responses": { + "200": { + "description": "Presence", + "schema": { + "$ref": "#\/definitions\/presence" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": "presences", + "weight": 420, + "cookies": false, + "type": "", + "demo": "presences\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "client" + ], + "packaging": false, + "public": true, + "methods": [ + { + "name": "update", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "presenceId", + "status", + "expiresAt", + "metadata", + "permissions", + "purge" + ], + "required": [ + "presenceId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/presence" + } + ], + "description": "", + "demo": "presences\/update.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "default": {}, + "x-example": "{}", + "x-nullable": true + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "purge": { + "type": "boolean", + "description": "When true, purge cached responses used by list presences endpoint.", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete presence", + "operationId": "presencesDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "presences" + ], + "description": "Delete a presence log by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "presences", + "weight": 421, + "cookies": false, + "type": "", + "demo": "presences\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/reports": { + "get": { + "summary": "List reports", + "operationId": "advisorListReports", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "Get a list of all the project's analyzer reports. You can use the query params to filter your results.\n", + "responses": { + "200": { + "description": "Reports List", + "schema": { + "$ref": "#\/definitions\/reportList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listReports", + "group": "reports", + "weight": 693, + "cookies": false, + "type": "", + "demo": "advisor\/list-reports.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-reports.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "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: appId, type, targetType, target, analyzedAt", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/reports\/{reportId}": { + "get": { + "summary": "Get report", + "operationId": "advisorGetReport", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "Get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.\n", + "responses": { + "200": { + "description": "Report", + "schema": { + "$ref": "#\/definitions\/report" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getReport", + "group": "reports", + "weight": 692, + "cookies": false, + "type": "", + "demo": "advisor\/get-report.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-report.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/reports\/{reportId}\/insights": { + "get": { + "summary": "List insights", + "operationId": "advisorListInsights", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "List the insights produced under a single analyzer report. You can use the query params to filter your results further.\n", + "responses": { + "200": { + "description": "Insights List", + "schema": { + "$ref": "#\/definitions\/insightList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listInsights", + "group": "insights", + "weight": 696, + "cookies": false, + "type": "", + "demo": "advisor\/list-insights.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "insights.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-insights.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Parent report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "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: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/reports\/{reportId}\/insights\/{insightId}": { + "get": { + "summary": "Get insight", + "operationId": "advisorGetInsight", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "Get an insight by its unique ID, scoped to its parent report.\n", + "responses": { + "200": { + "description": "Insight", + "schema": { + "$ref": "#\/definitions\/insight" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getInsight", + "group": "insights", + "weight": 695, + "cookies": false, + "type": "", + "demo": "advisor\/get-insight.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "insights.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-insight.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Parent report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "insightId", + "description": "Insight ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files": { + "get": { + "summary": "List files", + "operationId": "storageListFiles", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "storage" + ], + "description": "Get a list of all the user files. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Files List", + "schema": { + "$ref": "#\/definitions\/fileList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listFiles", + "group": "files", + "weight": 553, + "cookies": false, + "type": "", + "demo": "storage\/list-files.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "files.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create file", + "operationId": "storageCreateFile", + "consumes": [ + "multipart\/form-data" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "storage" + ], + "description": "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.\n\nLarger 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.\n\nWhen 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.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "responses": { + "201": { + "description": "File", + "schema": { + "$ref": "#\/definitions\/file" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createFile", + "group": "files", + "weight": 1206, + "cookies": false, + "type": "upload", + "demo": "storage\/create-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", + "scope": "files.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "required": true, + "x-upload-id": true, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "file", + "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", + "required": true, + "type": "file", + "in": "formData" + }, + { + "name": "permissions", + "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "x-example": "[\"read(\"any\")\"]", + "in": "formData" + } + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "get": { + "summary": "Get file", + "operationId": "storageGetFile", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "storage" + ], + "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", + "responses": { + "200": { + "description": "File", + "schema": { + "$ref": "#\/definitions\/file" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getFile", + "group": "files", + "weight": 552, + "cookies": false, + "type": "", + "demo": "storage\/get-file.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "files.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update file", + "operationId": "storageUpdateFile", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "storage" + ], + "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", + "responses": { + "200": { + "description": "File", + "schema": { + "$ref": "#\/definitions\/file" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateFile", + "group": "files", + "weight": 554, + "cookies": false, + "type": "", + "demo": "storage\/update-file.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "files.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Bucket unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "File name.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, "x-example": "[\"read(\"any\")\"]", "x-nullable": true, @@ -10175,7 +10954,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 546, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -10246,7 +11025,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 548, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -10326,7 +11105,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 547, + "weight": 556, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -10534,7 +11313,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 549, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -10614,7 +11393,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 828, + "weight": 847, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -10684,7 +11463,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 824, + "weight": 843, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -10758,7 +11537,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 825, + "weight": 844, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -10824,7 +11603,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 826, + "weight": 845, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -10906,7 +11685,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 827, + "weight": 846, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -10974,7 +11753,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 829, + "weight": 848, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -11058,7 +11837,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 899, + "weight": 918, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -11171,7 +11950,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 812, + "weight": 831, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -11325,7 +12104,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 813, + "weight": 832, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -11427,7 +12206,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 816, + "weight": 835, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -11573,7 +12352,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 814, + "weight": 833, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -11682,7 +12461,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 818, + "weight": 837, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -11782,7 +12561,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 823, + "weight": 842, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -11904,7 +12683,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 822, + "weight": 841, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -12024,7 +12803,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 520, + "weight": 529, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -12109,7 +12888,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 518, + "weight": 527, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -12200,7 +12979,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 519, + "weight": 528, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -12263,7 +13042,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 522, + "weight": 531, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -12339,7 +13118,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 521, + "weight": 530, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -12402,7 +13181,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 527, + "weight": 536, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -12495,7 +13274,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 525, + "weight": 534, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -12612,7 +13391,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 526, + "weight": 535, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -12683,7 +13462,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 528, + "weight": 537, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -12770,7 +13549,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 1188, + "weight": 1207, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -12843,7 +13622,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 530, + "weight": 539, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -12939,7 +13718,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 523, + "weight": 532, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -13002,7 +13781,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 524, + "weight": 533, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -13083,7 +13862,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 895, + "weight": 914, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -13150,7 +13929,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 891, + "weight": 910, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -13221,7 +14000,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 892, + "weight": 911, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -13284,7 +14063,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 893, + "weight": 912, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -13363,7 +14142,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 894, + "weight": 913, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -13428,7 +14207,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 896, + "weight": 915, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -13509,7 +14288,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 885, + "weight": 904, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -13619,7 +14398,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 881, + "weight": 900, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -13767,7 +14546,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 884, + "weight": 903, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -13866,7 +14645,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 883, + "weight": 902, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -14007,7 +14786,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 882, + "weight": 901, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -14111,7 +14890,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 886, + "weight": 905, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -14318,7 +15097,36 @@ ], "example": { "total": 5, - "documents": "" + "documents": "" + } + }, + "presenceList": { + "description": "Presences List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of presences that matched your query.", + "x-example": 5, + "format": "int32" + }, + "presences": { + "type": "array", + "description": "List of presences.", + "items": { + "type": "object", + "$ref": "#\/definitions\/presence" + }, + "x-example": "" + } + }, + "required": [ + "total", + "presences" + ], + "example": { + "total": 5, + "presences": "" } }, "sessionList": { @@ -14727,6 +15535,64 @@ "transactions": "" } }, + "insightList": { + "description": "Insights List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of insights that matched your query.", + "x-example": 5, + "format": "int32" + }, + "insights": { + "type": "array", + "description": "List of insights.", + "items": { + "type": "object", + "$ref": "#\/definitions\/insight" + }, + "x-example": "" + } + }, + "required": [ + "total", + "insights" + ], + "example": { + "total": 5, + "insights": "" + } + }, + "reportList": { + "description": "Reports List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of reports that matched your query.", + "x-example": 5, + "format": "int32" + }, + "reports": { + "type": "array", + "description": "List of reports.", + "items": { + "type": "object", + "$ref": "#\/definitions\/report" + }, + "x-example": "" + } + }, + "required": [ + "total", + "reports" + ], + "example": { + "total": 5, + "reports": "" + } + }, "row": { "description": "Row", "type": "object", @@ -14872,6 +15738,89 @@ "isAdmin": false } }, + "presence": { + "description": "Presence", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Presence ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "string", + "description": "Presence sequence ID.", + "x-example": "1", + "readOnly": true + }, + "$createdAt": { + "type": "string", + "description": "Presence creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Presence update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Presence permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "674af8f3e12a5f9ac0be" + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "online", + "x-nullable": true + }, + "source": { + "type": "string", + "description": "Presence source.", + "x-example": "HTTP" + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "additionalProperties": true, + "x-additional-properties-key": "metadata", + "required": [ + "$id", + "$sequence", + "$createdAt", + "$updatedAt", + "$permissions", + "userId", + "source" + ], + "example": { + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "userId": "674af8f3e12a5f9ac0be", + "status": "online", + "source": "HTTP", + "expiresAt": "2020-10-15T06:38:00.000+00:00" + } + }, "log": { "description": "Log", "type": "object", @@ -16920,6 +17869,301 @@ "identifier": "token", "expired": false } + }, + "insight": { + "description": "Insight", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Insight ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Insight creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Insight update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "reportId": { + "type": "string", + "description": "Parent report ID. Insights always belong to a report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).", + "x-example": "tablesDBIndex" + }, + "severity": { + "type": "string", + "description": "Insight severity. One of info, warning, critical.", + "x-example": "warning" + }, + "status": { + "type": "string", + "description": "Insight status. One of active, dismissed.", + "x-example": "active" + }, + "resourceType": { + "type": "string", + "description": "Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.", + "x-example": "databases" + }, + "resourceId": { + "type": "string", + "description": "ID of the resource the insight is about.", + "x-example": "main" + }, + "parentResourceType": { + "type": "string", + "description": "Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table \u2192 resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.", + "x-example": "tables" + }, + "parentResourceId": { + "type": "string", + "description": "ID of the parent resource. Empty when the resource has no parent.", + "x-example": "orders" + }, + "title": { + "type": "string", + "description": "Insight title.", + "x-example": "Missing index on collection orders" + }, + "summary": { + "type": "string", + "description": "Short markdown summary describing the insight.", + "x-example": "Queries against `orders.status` are scanning the full collection." + }, + "ctas": { + "type": "array", + "description": "List of call-to-action buttons attached to this insight.", + "items": { + "type": "object", + "$ref": "#\/definitions\/insightCTA" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the insight was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + }, + "dismissedAt": { + "type": "string", + "description": "Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + }, + "dismissedBy": { + "type": "string", + "description": "User ID that dismissed the insight. Empty when not dismissed.", + "x-example": "5e5ea5c16897e", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "reportId", + "type", + "severity", + "status", + "resourceType", + "resourceId", + "parentResourceType", + "parentResourceId", + "title", + "summary", + "ctas" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "reportId": "5e5ea5c16897e", + "type": "tablesDBIndex", + "severity": "warning", + "status": "active", + "resourceType": "databases", + "resourceId": "main", + "parentResourceType": "tables", + "parentResourceId": "orders", + "title": "Missing index on collection orders", + "summary": "Queries against `orders.status` are scanning the full collection.", + "ctas": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedBy": "5e5ea5c16897e" + } + }, + "insightCTA": { + "description": "InsightCTA", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Human-readable label for the CTA, used in UI.", + "x-example": "Create missing index" + }, + "service": { + "type": "string", + "description": "Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource \u2014 for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.", + "x-example": "tablesDB" + }, + "method": { + "type": "string", + "description": "Public API method on the chosen service the client should invoke when this CTA is triggered.", + "x-example": "createIndex" + }, + "params": { + "type": "object", + "additionalProperties": true, + "description": "Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId\/tableId\/columns for tablesDB, databaseId\/collectionId\/attributes for the legacy Databases API).", + "x-example": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "required": [ + "label", + "service", + "method", + "params" + ], + "example": { + "label": "Create missing index", + "service": "tablesDB", + "method": "createIndex", + "params": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "report": { + "description": "Report", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Report ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Report creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Report update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "ID of the third-party app that submitted the report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.", + "x-example": "lighthouse" + }, + "title": { + "type": "string", + "description": "Short, human-readable title for the report.", + "x-example": "Lighthouse audit for https:\/\/appwrite.io\/" + }, + "summary": { + "type": "string", + "description": "Markdown summary describing the report.", + "x-example": "Performance score 78. 4 opportunities found." + }, + "targetType": { + "type": "string", + "description": "Plural noun describing what the report analyzes, e.g. databases, sites, urls.", + "x-example": "urls" + }, + "target": { + "type": "string", + "description": "Free-form target identifier (URL for lighthouse, resource ID for db).", + "x-example": "https:\/\/appwrite.io\/" + }, + "categories": { + "type": "array", + "description": "Categories covered by the report, e.g. performance, accessibility.", + "items": { + "type": "string" + }, + "x-example": [ + "performance", + "accessibility" + ] + }, + "insights": { + "type": "array", + "description": "Insights nested under this report.", + "items": { + "type": "object", + "$ref": "#\/definitions\/insight" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the report was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "type", + "title", + "summary", + "targetType", + "target", + "categories", + "insights" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "type": "lighthouse", + "title": "Lighthouse audit for https:\/\/appwrite.io\/", + "summary": "Performance score 78. 4 opportunities found.", + "targetType": "urls", + "target": "https:\/\/appwrite.io\/", + "categories": [ + "performance", + "accessibility" + ], + "insights": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00" + } } }, "externalDocs": { diff --git a/specs/latest/swagger2-latest-console.json b/specs/latest/swagger2-latest-console.json index ce980b3d..dbd52e28 100644 --- a/specs/latest/swagger2-latest-console.json +++ b/specs/latest/swagger2-latest-console.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.9.3", + "version": "1.9.5", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -333,7 +333,7 @@ "x-appwrite": { "method": "listBillingAddresses", "group": null, - "weight": 1076, + "weight": 1094, "cookies": false, "type": "", "demo": "account\/list-billing-addresses.md", @@ -396,7 +396,7 @@ "x-appwrite": { "method": "createBillingAddress", "group": null, - "weight": 1074, + "weight": 1092, "cookies": false, "type": "", "demo": "account\/create-billing-address.md", @@ -497,7 +497,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 1075, + "weight": 1093, "cookies": false, "type": "", "demo": "account\/get-billing-address.md", @@ -556,7 +556,7 @@ "x-appwrite": { "method": "updateBillingAddress", "group": null, - "weight": 1077, + "weight": 1095, "cookies": false, "type": "", "demo": "account\/update-billing-address.md", @@ -662,7 +662,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 1078, + "weight": 1096, "cookies": false, "type": "", "demo": "account\/delete-billing-address.md", @@ -721,7 +721,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 1080, + "weight": 1098, "cookies": false, "type": "", "demo": "account\/get-coupon.md", @@ -1000,7 +1000,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 1079, + "weight": 1097, "cookies": false, "type": "", "demo": "account\/list-invoices.md", @@ -1136,7 +1136,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1062, + "weight": 1080, "cookies": false, "type": "", "demo": "account\/list-keys.md", @@ -1195,7 +1195,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1063, + "weight": 1081, "cookies": false, "type": "", "demo": "account\/create-key.md", @@ -1288,7 +1288,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1066, + "weight": 1084, "cookies": false, "type": "", "demo": "account\/get-key.md", @@ -1346,7 +1346,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1065, + "weight": 1083, "cookies": false, "type": "", "demo": "account\/update-key.md", @@ -1444,7 +1444,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1064, + "weight": 1082, "cookies": false, "type": "", "demo": "account\/delete-key.md", @@ -1580,7 +1580,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 166, + "weight": 165, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -1655,7 +1655,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 168, + "weight": 167, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -1779,7 +1779,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 169, + "weight": 168, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -1920,7 +1920,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 170, + "weight": 169, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -2044,7 +2044,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 174, + "weight": 173, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -2181,7 +2181,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 175, + "weight": 174, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -2321,7 +2321,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 167, + "weight": 166, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -2422,7 +2422,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 173, + "weight": 172, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -2523,7 +2523,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 171, + "weight": 170, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -2624,7 +2624,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 172, + "weight": 171, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2882,7 +2882,7 @@ "x-appwrite": { "method": "listPaymentMethods", "group": null, - "weight": 1069, + "weight": 1087, "cookies": false, "type": "", "demo": "account\/list-payment-methods.md", @@ -2945,7 +2945,7 @@ "x-appwrite": { "method": "createPaymentMethod", "group": null, - "weight": 1067, + "weight": 1085, "cookies": false, "type": "", "demo": "account\/create-payment-method.md", @@ -2994,7 +2994,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 1068, + "weight": 1086, "cookies": false, "type": "", "demo": "account\/get-payment-method.md", @@ -3053,7 +3053,7 @@ "x-appwrite": { "method": "updatePaymentMethod", "group": null, - "weight": 1070, + "weight": 1088, "cookies": false, "type": "", "demo": "account\/update-payment-method.md", @@ -3142,7 +3142,7 @@ "x-appwrite": { "method": "deletePaymentMethod", "group": null, - "weight": 1073, + "weight": 1091, "cookies": false, "type": "", "demo": "account\/delete-payment-method.md", @@ -3203,7 +3203,7 @@ "x-appwrite": { "method": "updatePaymentMethodProvider", "group": null, - "weight": 1071, + "weight": 1089, "cookies": false, "type": "", "demo": "account\/update-payment-method-provider.md", @@ -3296,7 +3296,7 @@ "x-appwrite": { "method": "updatePaymentMethodMandateOptions", "group": null, - "weight": 1072, + "weight": 1090, "cookies": false, "type": "", "demo": "account\/update-payment-method-mandate-options.md", @@ -5652,7 +5652,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 1185, + "weight": 1204, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -5713,7 +5713,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 1186, + "weight": 1205, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -5774,7 +5774,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 177, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -5901,7 +5901,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 176, + "weight": 175, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -6034,7 +6034,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 180, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -6099,7 +6099,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 178, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -6588,7 +6588,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 179, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -6673,7 +6673,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 182, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -6766,7 +6766,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 181, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -6859,7 +6859,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 183, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -7573,7 +7573,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 1056, + "weight": 1073, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -7638,7 +7638,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 1057, + "weight": 1074, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -7729,7 +7729,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 1055, + "weight": 1072, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -7787,7 +7787,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 1058, + "weight": 1075, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -7848,7 +7848,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 1051, + "weight": 1068, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -7916,7 +7916,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 1052, + "weight": 1069, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -8044,7 +8044,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 1050, + "weight": 1067, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -8108,7 +8108,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 1053, + "weight": 1070, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -8206,7 +8206,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 1054, + "weight": 1071, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -8272,7 +8272,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 1061, + "weight": 1078, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -8375,7 +8375,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 1060, + "weight": 1077, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -8440,7 +8440,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 1059, + "weight": 1076, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -8503,7 +8503,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 500, + "weight": 509, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -8572,7 +8572,7 @@ "x-appwrite": { "method": "getCampaign", "group": null, - "weight": 912, + "weight": 931, "cookies": false, "type": "", "demo": "console\/get-campaign.md", @@ -8631,7 +8631,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 909, + "weight": 928, "cookies": false, "type": "", "demo": "console\/get-coupon.md", @@ -8690,7 +8690,7 @@ "x-appwrite": { "method": "listOAuth2Providers", "group": "console", - "weight": 498, + "weight": 507, "cookies": false, "type": "", "demo": "console\/list-o-auth-2-providers.md", @@ -8738,7 +8738,7 @@ "x-appwrite": { "method": "getPlans", "group": null, - "weight": 907, + "weight": 926, "cookies": false, "type": "", "demo": "console\/get-plans.md", @@ -8804,7 +8804,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 908, + "weight": 927, "cookies": false, "type": "", "demo": "console\/get-plan.md", @@ -8863,7 +8863,7 @@ "x-appwrite": { "method": "getProgram", "group": null, - "weight": 910, + "weight": 929, "cookies": false, "type": "", "demo": "console\/get-program.md", @@ -8924,7 +8924,7 @@ "x-appwrite": { "method": "createProgramMembership", "group": null, - "weight": 911, + "weight": 930, "cookies": false, "type": "", "demo": "console\/create-program-membership.md", @@ -8983,7 +8983,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 906, + "weight": 925, "cookies": false, "type": "", "demo": "console\/list-regions.md", @@ -9027,7 +9027,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 501, + "weight": 510, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -9098,7 +9098,7 @@ "x-appwrite": { "method": "listProjectScopes", "group": "console", - "weight": 499, + "weight": 508, "cookies": false, "type": "", "demo": "console\/list-project-scopes.md", @@ -9148,7 +9148,7 @@ "x-appwrite": { "method": "createSource", "group": null, - "weight": 913, + "weight": 932, "cookies": false, "type": "", "demo": "console\/create-source.md", @@ -9244,7 +9244,7 @@ "x-appwrite": { "method": "suggestColumns", "group": null, - "weight": 914, + "weight": 933, "cookies": false, "type": "", "demo": "console\/suggest-columns.md", @@ -9339,7 +9339,7 @@ "x-appwrite": { "method": "suggestIndexes", "group": null, - "weight": 915, + "weight": 934, "cookies": false, "type": "", "demo": "console\/suggest-indexes.md", @@ -9413,7 +9413,7 @@ "tags": [ "console" ], - "description": "Suggest valid Appwrite query JSON objects for a supported list resource from free-text user intent. The endpoint picks a validator based on `type` \u2014 for system resources it uses the static validator and its allowed attributes, and for user-owned table rows it loads the table schema and validates against those attributes at request time. The returned queries are guaranteed to parse and pass the relevant queries validator.\n", + "description": "Suggest valid Appwrite query JSON objects for a supported list resource from free-text user intent. The endpoint picks a validator based on `resource` \u2014 for system resources it uses the static validator and its allowed attributes, and for user-owned table rows it loads the table schema and validates against those attributes at request time. The returned queries are guaranteed to parse and pass the relevant queries validator.\n", "responses": { "200": { "description": "Any", @@ -9426,7 +9426,7 @@ "x-appwrite": { "method": "suggestQueries", "group": null, - "weight": 916, + "weight": 935, "cookies": false, "type": "", "demo": "console\/suggest-queries.md", @@ -9451,8 +9451,8 @@ ], "parameters": [ { - "name": "type", - "description": "Resource list type to generate queries for.", + "name": "resource", + "description": "Resource to generate queries for.", "required": true, "type": "string", "x-example": "activities", @@ -9485,6 +9485,8 @@ "repositories", "vcscomments", "vcscommentlocks", + "reports", + "insights", "users", "cache", "tokens", @@ -9528,10 +9530,86 @@ "resourcetokens", "transactions", "transactionlogs", + "presencelogs", + "stats" + ], + "x-enum-name": "QuerySuggestionResource", + "x-enum-keys": [ + "activities", + "activity_events", + "archives", + "credits", + "dns_records", + "domains", + "invoices", + "payment_methods", + "policies", + "projects", + "restorations", + "team_aggregations", + "teams", + "databases", + "tables", + "rows", + "schedules", + "platforms", + "keys", + "dev_keys", + "webhooks", + "certificates", + "realtime", + "rules", + "installations", + "repositories", + "vcs_comments", + "vcs_comment_locks", + "reports", + "insights", + "users", + "cache", + "tokens", + "authenticators", + "challenges", + "sessions", + "identities", + "memberships", + "buckets", + "providers", + "messages", + "topics", + "subscribers", + "targets", + "companies", + "billing_addresses", + "billing_aggregations", + "billing_aggregation_resources", + "billing_team_project_aggregations", + "billing_team_aggregations_v2", + "billing_team_aggregation_resources", + "billing_invoices_v2", + "billing_addons", + "alerts", + "payments", + "billing_discounts", + "sources", + "deals", + "blocks", + "threats", + "feedbacks", + "sh_installations", + "attributes", + "indexes", + "functions", + "sites", + "deployments", + "executions", + "variables", + "migrations", + "resource_tokens", + "transactions", + "transaction_logs", "stats" ], - "x-enum-name": null, - "x-enum-keys": [], "in": "query" }, { @@ -9544,7 +9622,7 @@ }, { "name": "databaseId", - "description": "Database ID. Required when type is `tables` or `rows`.", + "description": "Database ID. Required when resource is `tables` or `rows`.", "required": false, "type": "string", "x-example": "", @@ -9552,7 +9630,7 @@ }, { "name": "tableId", - "description": "Table ID. Required when type is `rows`.", + "description": "Table ID. Required when resource is `rows`.", "required": false, "type": "string", "x-example": "", @@ -9585,7 +9663,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 497, + "weight": 506, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -9633,7 +9711,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 687, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -9749,7 +9827,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 683, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -9869,7 +9947,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 755, + "weight": 772, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -9937,7 +10015,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 751, + "weight": 768, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -10009,7 +10087,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 752, + "weight": 769, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -10073,7 +10151,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 753, + "weight": 770, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -10153,7 +10231,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 754, + "weight": 771, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -10219,7 +10297,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 756, + "weight": 773, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -10301,7 +10379,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 690, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -10403,7 +10481,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 684, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -10497,7 +10575,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 685, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -10609,7 +10687,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 686, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -10702,7 +10780,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 695, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -10797,7 +10875,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 691, + "weight": 706, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -10927,7 +11005,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 692, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -11000,7 +11078,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 693, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -11111,7 +11189,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 694, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -11184,7 +11262,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 712, + "weight": 727, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -11254,10 +11332,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint": { "post": { - "summary": "Create boolean attribute", - "operationId": "databasesCreateBooleanAttribute", + "summary": "Create bigint attribute", + "operationId": "databasesCreateBigIntAttribute", "consumes": [ "application\/json" ], @@ -11267,23 +11345,23 @@ "tags": [ "databases" ], - "description": "Create a boolean attribute.\n", + "description": "Create a bigint attribute. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "schema": { - "$ref": "#\/definitions\/attributeBoolean" + "$ref": "#\/definitions\/attributeBigint" } } }, "deprecated": true, "x-appwrite": { - "method": "createBooleanAttribute", + "method": "createBigIntAttribute", "group": "attributes", - "weight": 713, + "weight": 740, "cookies": false, "type": "", - "demo": "databases\/create-boolean-attribute.md", + "demo": "databases\/create-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11294,10 +11372,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createBooleanColumn" + "replaceWith": "tablesDB.createBigIntColumn" }, "auth": { "Project": [] @@ -11320,7 +11398,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -11344,11 +11422,28 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", "default": null, - "x-example": false, + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -11367,10 +11462,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint\/{key}": { "patch": { - "summary": "Update boolean attribute", - "operationId": "databasesUpdateBooleanAttribute", + "summary": "Update bigint attribute", + "operationId": "databasesUpdateBigIntAttribute", "consumes": [ "application\/json" ], @@ -11380,23 +11475,23 @@ "tags": [ "databases" ], - "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a bigint attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "schema": { - "$ref": "#\/definitions\/attributeBoolean" + "$ref": "#\/definitions\/attributeBigint" } } }, "deprecated": true, "x-appwrite": { - "method": "updateBooleanAttribute", + "method": "updateBigIntAttribute", "group": "attributes", - "weight": 714, + "weight": 741, "cookies": false, "type": "", - "demo": "databases\/update-boolean-attribute.md", + "demo": "databases\/update-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11407,10 +11502,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateBooleanColumn" + "replaceWith": "tablesDB.updateBigIntColumn" }, "auth": { "Project": [] @@ -11433,7 +11528,252 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "post": { + "summary": "Create boolean attribute", + "operationId": "databasesCreateBooleanAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Create a boolean attribute.\n", + "responses": { + "202": { + "description": "AttributeBoolean", + "schema": { + "$ref": "#\/definitions\/attributeBoolean" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "createBooleanAttribute", + "group": "attributes", + "weight": 728, + "cookies": false, + "type": "", + "demo": "databases\/create-boolean-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createBooleanColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "default": null, + "x-example": false, + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "patch": { + "summary": "Update boolean attribute", + "operationId": "databasesUpdateBooleanAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "responses": { + "200": { + "description": "AttributeBoolean", + "schema": { + "$ref": "#\/definitions\/attributeBoolean" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateBooleanAttribute", + "group": "attributes", + "weight": 729, + "cookies": false, + "type": "", + "demo": "databases\/update-boolean-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateBooleanColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -11508,7 +11848,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 715, + "weight": 730, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -11622,7 +11962,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 716, + "weight": 731, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -11738,7 +12078,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 717, + "weight": 732, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -11852,7 +12192,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 718, + "weight": 733, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -11968,7 +12308,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 719, + "weight": 734, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -12091,7 +12431,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 720, + "weight": 735, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -12216,7 +12556,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 721, + "weight": 736, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -12346,7 +12686,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 722, + "weight": 737, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -12478,7 +12818,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 723, + "weight": 738, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -12608,7 +12948,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 724, + "weight": 739, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -12740,7 +13080,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 725, + "weight": 742, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -12853,7 +13193,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 726, + "weight": 743, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -12968,7 +13308,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 727, + "weight": 744, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -13075,7 +13415,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 728, + "weight": 745, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -13189,7 +13529,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 745, + "weight": 762, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -13304,7 +13644,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 746, + "weight": 763, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -13415,7 +13755,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 743, + "weight": 760, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -13530,7 +13870,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 744, + "weight": 761, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -13641,7 +13981,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 729, + "weight": 746, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -13748,7 +14088,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 730, + "weight": 747, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -13862,7 +14202,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 731, + "weight": 748, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -13969,7 +14309,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 732, + "weight": 749, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -14083,7 +14423,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 733, + "weight": 750, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -14224,7 +14564,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 734, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -14335,7 +14675,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 735, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -14462,7 +14802,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 736, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -14585,7 +14925,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 741, + "weight": 758, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -14700,7 +15040,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 742, + "weight": 759, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -14811,7 +15151,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 737, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -14925,7 +15265,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 738, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -15041,7 +15381,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 739, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -15164,7 +15504,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 740, + "weight": 757, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -15363,7 +15703,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 710, + "weight": 725, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -15438,7 +15778,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 711, + "weight": 726, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -15518,7 +15858,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 897, + "weight": 916, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -15633,7 +15973,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 698, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -15825,7 +16165,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 703, + "weight": 718, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -15960,7 +16300,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 701, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -16064,7 +16404,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 705, + "weight": 720, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -16162,7 +16502,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 699, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -16266,7 +16606,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 702, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -16418,7 +16758,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 700, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -16529,7 +16869,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 704, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -16629,7 +16969,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 707, + "weight": 722, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -16722,7 +17062,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 709, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -16846,7 +17186,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 708, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -16968,7 +17308,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 750, + "weight": 767, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -17062,7 +17402,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 747, + "weight": 764, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -17202,7 +17542,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 748, + "weight": 765, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -17277,7 +17617,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 749, + "weight": 766, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -17357,7 +17697,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 696, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -17440,7 +17780,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 697, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -17531,7 +17871,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 688, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -17636,7 +17976,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 689, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -17749,7 +18089,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 834, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -17832,7 +18172,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 830, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -17916,7 +18256,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 862, + "weight": 881, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -17984,7 +18324,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 858, + "weight": 877, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -18056,7 +18396,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 859, + "weight": 878, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -18120,7 +18460,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 860, + "weight": 879, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -18200,7 +18540,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 861, + "weight": 880, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -18264,7 +18604,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 836, + "weight": 855, "cookies": false, "type": "", "demo": "documentsdb\/list-usage.md", @@ -18358,7 +18698,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 831, + "weight": 850, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -18419,7 +18759,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 832, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -18499,7 +18839,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 833, + "weight": 852, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -18560,7 +18900,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 841, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -18651,7 +18991,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 837, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -18777,7 +19117,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 838, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -18846,7 +19186,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 839, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -18955,7 +19295,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 840, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -19024,7 +19364,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 898, + "weight": 917, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -19135,7 +19475,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 847, + "weight": 866, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -19311,7 +19651,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 852, + "weight": 871, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -19437,7 +19777,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 850, + "weight": 869, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -19536,7 +19876,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 854, + "weight": 873, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -19629,7 +19969,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 848, + "weight": 867, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -19729,7 +20069,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 851, + "weight": 870, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -19871,7 +20211,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 849, + "weight": 868, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -19976,7 +20316,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 853, + "weight": 872, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -20073,7 +20413,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 857, + "weight": 876, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -20191,7 +20531,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 856, + "weight": 875, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -20307,7 +20647,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 846, + "weight": 865, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -20397,7 +20737,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 843, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -20532,7 +20872,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 844, + "weight": 863, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -20603,7 +20943,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 845, + "weight": 864, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -20679,7 +21019,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 842, + "weight": 861, "cookies": false, "type": "", "demo": "documentsdb\/get-collection-usage.md", @@ -20766,7 +21106,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 835, + "weight": 854, "cookies": false, "type": "", "demo": "documentsdb\/get-usage.md", @@ -20871,7 +21211,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 922, + "weight": 941, "cookies": false, "type": "", "demo": "domains\/list.md", @@ -20942,7 +21282,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 917, + "weight": 936, "cookies": false, "type": "", "demo": "domains\/create.md", @@ -21017,7 +21357,7 @@ "x-appwrite": { "method": "getPrice", "group": null, - "weight": 920, + "weight": 939, "cookies": false, "type": "", "demo": "domains\/get-price.md", @@ -21102,7 +21442,7 @@ "x-appwrite": { "method": "createPurchase", "group": null, - "weight": 967, + "weight": 986, "cookies": false, "type": "", "demo": "domains\/create-purchase.md", @@ -21248,7 +21588,7 @@ "x-appwrite": { "method": "updatePurchase", "group": null, - "weight": 968, + "weight": 987, "cookies": false, "type": "", "demo": "domains\/update-purchase.md", @@ -21324,7 +21664,7 @@ "x-appwrite": { "method": "listSuggestions", "group": null, - "weight": 966, + "weight": 985, "cookies": false, "type": "", "demo": "domains\/list-suggestions.md", @@ -21434,7 +21774,7 @@ "x-appwrite": { "method": "createTransferIn", "group": null, - "weight": 927, + "weight": 946, "cookies": false, "type": "", "demo": "domains\/create-transfer-in.md", @@ -21531,7 +21871,7 @@ "x-appwrite": { "method": "updateTransferIn", "group": null, - "weight": 928, + "weight": 947, "cookies": false, "type": "", "demo": "domains\/update-transfer-in.md", @@ -21609,7 +21949,7 @@ "x-appwrite": { "method": "createTransferOut", "group": null, - "weight": 929, + "weight": 948, "cookies": false, "type": "", "demo": "domains\/create-transfer-out.md", @@ -21684,7 +22024,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 919, + "weight": 938, "cookies": false, "type": "", "demo": "domains\/get.md", @@ -21739,7 +22079,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 918, + "weight": 937, "cookies": false, "type": "", "demo": "domains\/delete.md", @@ -21799,7 +22139,7 @@ "x-appwrite": { "method": "updateAutoRenewal", "group": null, - "weight": 923, + "weight": 942, "cookies": false, "type": "", "demo": "domains\/update-auto-renewal.md", @@ -21877,7 +22217,7 @@ "x-appwrite": { "method": "updateNameservers", "group": null, - "weight": 924, + "weight": 943, "cookies": false, "type": "", "demo": "domains\/update-nameservers.md", @@ -21935,7 +22275,7 @@ "x-appwrite": { "method": "getPresetGoogleWorkspace", "group": null, - "weight": 955, + "weight": 974, "cookies": false, "type": "", "demo": "domains\/get-preset-google-workspace.md", @@ -21993,7 +22333,7 @@ "x-appwrite": { "method": "createPresetGoogleWorkspace", "group": null, - "weight": 954, + "weight": 973, "cookies": false, "type": "", "demo": "domains\/create-preset-google-workspace.md", @@ -22051,7 +22391,7 @@ "x-appwrite": { "method": "getPresetICloud", "group": null, - "weight": 965, + "weight": 984, "cookies": false, "type": "", "demo": "domains\/get-preset-i-cloud.md", @@ -22109,7 +22449,7 @@ "x-appwrite": { "method": "createPresetICloud", "group": null, - "weight": 964, + "weight": 983, "cookies": false, "type": "", "demo": "domains\/create-preset-i-cloud.md", @@ -22167,7 +22507,7 @@ "x-appwrite": { "method": "getPresetMailgun", "group": null, - "weight": 957, + "weight": 976, "cookies": false, "type": "", "demo": "domains\/get-preset-mailgun.md", @@ -22225,7 +22565,7 @@ "x-appwrite": { "method": "createPresetMailgun", "group": null, - "weight": 956, + "weight": 975, "cookies": false, "type": "", "demo": "domains\/create-preset-mailgun.md", @@ -22283,7 +22623,7 @@ "x-appwrite": { "method": "getPresetOutlook", "group": null, - "weight": 963, + "weight": 982, "cookies": false, "type": "", "demo": "domains\/get-preset-outlook.md", @@ -22341,7 +22681,7 @@ "x-appwrite": { "method": "createPresetOutlook", "group": null, - "weight": 962, + "weight": 981, "cookies": false, "type": "", "demo": "domains\/create-preset-outlook.md", @@ -22399,7 +22739,7 @@ "x-appwrite": { "method": "getPresetProtonMail", "group": null, - "weight": 961, + "weight": 980, "cookies": false, "type": "", "demo": "domains\/get-preset-proton-mail.md", @@ -22457,7 +22797,7 @@ "x-appwrite": { "method": "createPresetProtonMail", "group": null, - "weight": 960, + "weight": 979, "cookies": false, "type": "", "demo": "domains\/create-preset-proton-mail.md", @@ -22515,7 +22855,7 @@ "x-appwrite": { "method": "getPresetZoho", "group": null, - "weight": 959, + "weight": 978, "cookies": false, "type": "", "demo": "domains\/get-preset-zoho.md", @@ -22573,7 +22913,7 @@ "x-appwrite": { "method": "createPresetZoho", "group": null, - "weight": 958, + "weight": 977, "cookies": false, "type": "", "demo": "domains\/create-preset-zoho.md", @@ -22631,7 +22971,7 @@ "x-appwrite": { "method": "listRecords", "group": null, - "weight": 953, + "weight": 972, "cookies": false, "type": "", "demo": "domains\/list-records.md", @@ -22703,7 +23043,7 @@ "x-appwrite": { "method": "createRecordA", "group": null, - "weight": 931, + "weight": 950, "cookies": false, "type": "", "demo": "domains\/create-record-a.md", @@ -22802,7 +23142,7 @@ "x-appwrite": { "method": "updateRecordA", "group": null, - "weight": 932, + "weight": 951, "cookies": false, "type": "", "demo": "domains\/update-record-a.md", @@ -22909,7 +23249,7 @@ "x-appwrite": { "method": "createRecordAAAA", "group": null, - "weight": 933, + "weight": 952, "cookies": false, "type": "", "demo": "domains\/create-record-aaaa.md", @@ -23008,7 +23348,7 @@ "x-appwrite": { "method": "updateRecordAAAA", "group": null, - "weight": 934, + "weight": 953, "cookies": false, "type": "", "demo": "domains\/update-record-aaaa.md", @@ -23115,7 +23455,7 @@ "x-appwrite": { "method": "createRecordAlias", "group": null, - "weight": 935, + "weight": 954, "cookies": false, "type": "", "demo": "domains\/create-record-alias.md", @@ -23214,7 +23554,7 @@ "x-appwrite": { "method": "updateRecordAlias", "group": null, - "weight": 936, + "weight": 955, "cookies": false, "type": "", "demo": "domains\/update-record-alias.md", @@ -23321,7 +23661,7 @@ "x-appwrite": { "method": "createRecordCAA", "group": null, - "weight": 937, + "weight": 956, "cookies": false, "type": "", "demo": "domains\/create-record-caa.md", @@ -23420,7 +23760,7 @@ "x-appwrite": { "method": "updateRecordCAA", "group": null, - "weight": 938, + "weight": 957, "cookies": false, "type": "", "demo": "domains\/update-record-caa.md", @@ -23527,7 +23867,7 @@ "x-appwrite": { "method": "createRecordCNAME", "group": null, - "weight": 939, + "weight": 958, "cookies": false, "type": "", "demo": "domains\/create-record-cname.md", @@ -23626,7 +23966,7 @@ "x-appwrite": { "method": "updateRecordCNAME", "group": null, - "weight": 940, + "weight": 959, "cookies": false, "type": "", "demo": "domains\/update-record-cname.md", @@ -23733,7 +24073,7 @@ "x-appwrite": { "method": "createRecordHTTPS", "group": null, - "weight": 941, + "weight": 960, "cookies": false, "type": "", "demo": "domains\/create-record-https.md", @@ -23832,7 +24172,7 @@ "x-appwrite": { "method": "updateRecordHTTPS", "group": null, - "weight": 942, + "weight": 961, "cookies": false, "type": "", "demo": "domains\/update-record-https.md", @@ -23939,7 +24279,7 @@ "x-appwrite": { "method": "createRecordMX", "group": null, - "weight": 943, + "weight": 962, "cookies": false, "type": "", "demo": "domains\/create-record-mx.md", @@ -24046,7 +24386,7 @@ "x-appwrite": { "method": "updateRecordMX", "group": null, - "weight": 944, + "weight": 963, "cookies": false, "type": "", "demo": "domains\/update-record-mx.md", @@ -24161,7 +24501,7 @@ "x-appwrite": { "method": "createRecordNS", "group": null, - "weight": 945, + "weight": 964, "cookies": false, "type": "", "demo": "domains\/create-record-ns.md", @@ -24260,7 +24600,7 @@ "x-appwrite": { "method": "updateRecordNS", "group": null, - "weight": 946, + "weight": 965, "cookies": false, "type": "", "demo": "domains\/update-record-ns.md", @@ -24367,7 +24707,7 @@ "x-appwrite": { "method": "createRecordSRV", "group": null, - "weight": 947, + "weight": 966, "cookies": false, "type": "", "demo": "domains\/create-record-srv.md", @@ -24490,7 +24830,7 @@ "x-appwrite": { "method": "updateRecordSRV", "group": null, - "weight": 948, + "weight": 967, "cookies": false, "type": "", "demo": "domains\/update-record-srv.md", @@ -24621,7 +24961,7 @@ "x-appwrite": { "method": "createRecordTXT", "group": null, - "weight": 949, + "weight": 968, "cookies": false, "type": "", "demo": "domains\/create-record-txt.md", @@ -24719,7 +25059,7 @@ "x-appwrite": { "method": "updateRecordTXT", "group": null, - "weight": 950, + "weight": 969, "cookies": false, "type": "", "demo": "domains\/update-record-txt.md", @@ -24824,7 +25164,7 @@ "x-appwrite": { "method": "getRecord", "group": null, - "weight": 952, + "weight": 971, "cookies": false, "type": "", "demo": "domains\/get-record.md", @@ -24887,7 +25227,7 @@ "x-appwrite": { "method": "deleteRecord", "group": null, - "weight": 951, + "weight": 970, "cookies": false, "type": "", "demo": "domains\/delete-record.md", @@ -24955,7 +25295,7 @@ "x-appwrite": { "method": "updateTeam", "group": null, - "weight": 926, + "weight": 945, "cookies": false, "type": "", "demo": "domains\/update-team.md", @@ -25031,7 +25371,7 @@ "x-appwrite": { "method": "getTransferStatus", "group": null, - "weight": 930, + "weight": 949, "cookies": false, "type": "", "demo": "domains\/get-transfer-status.md", @@ -25089,7 +25429,7 @@ "x-appwrite": { "method": "getZone", "group": null, - "weight": 921, + "weight": 940, "cookies": false, "type": "", "demo": "domains\/get-zone.md", @@ -25147,7 +25487,7 @@ "x-appwrite": { "method": "updateZone", "group": null, - "weight": 925, + "weight": 944, "cookies": false, "type": "", "demo": "domains\/update-zone.md", @@ -25223,7 +25563,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 416, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -25305,7 +25645,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 900, + "weight": 919, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -25577,6 +25917,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -25589,8 +25931,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -25689,7 +26035,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 418, + "weight": 427, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -25739,7 +26085,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 419, + "weight": 428, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -25789,7 +26135,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 442, + "weight": 451, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -25999,7 +26345,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 441, + "weight": 450, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -26057,7 +26403,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 435, + "weight": 444, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -26127,7 +26473,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 414, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -26187,7 +26533,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 901, + "weight": 920, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -26461,6 +26807,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -26473,8 +26821,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -26567,7 +26919,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 417, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -26629,7 +26981,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 422, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -26707,7 +27059,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 423, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -26797,7 +27149,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 420, + "weight": 429, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -26890,7 +27242,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 428, + "weight": 437, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -26976,7 +27328,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 425, + "weight": 434, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -27097,7 +27449,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 426, + "weight": 435, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -27194,7 +27546,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 421, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -27257,7 +27609,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 424, + "weight": 433, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -27325,7 +27677,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 427, + "weight": 436, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -27411,7 +27763,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 429, + "weight": 438, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -27479,7 +27831,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 432, + "weight": 441, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -27566,7 +27918,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 430, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -27689,7 +28041,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 431, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -27758,7 +28110,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 433, + "weight": 442, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -27829,7 +28181,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 434, + "weight": 443, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -27907,7 +28259,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 438, + "weight": 447, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -27939,6 +28291,27 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "queries", + "description": "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: key, resourceType, resourceId, secret", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, @@ -27967,7 +28340,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 902, + "weight": 921, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -28006,6 +28379,12 @@ "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -28026,6 +28405,7 @@ } }, "required": [ + "variableId", "key", "value" ] @@ -28058,7 +28438,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 437, + "weight": 446, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -28126,7 +28506,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 439, + "weight": 448, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -28177,7 +28557,8 @@ "type": "string", "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -28193,10 +28574,7 @@ "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } ] @@ -28221,7 +28599,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 440, + "weight": 449, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -28291,7 +28669,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 117, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -28367,7 +28745,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 116, + "weight": 115, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -28441,7 +28819,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 443, + "weight": 452, "cookies": false, "type": "", "demo": "health\/get.md", @@ -28492,7 +28870,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 452, + "weight": 461, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -28543,7 +28921,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 446, + "weight": 455, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -28594,7 +28972,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 449, + "weight": 458, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -28654,7 +29032,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 1044, + "weight": 1061, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -28725,7 +29103,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 445, + "weight": 454, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -28776,7 +29154,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 447, + "weight": 456, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -28827,7 +29205,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 453, + "weight": 462, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -28889,7 +29267,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 1040, + "weight": 1057, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -28951,7 +29329,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 1039, + "weight": 1056, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -29013,7 +29391,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 457, + "weight": 466, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -29075,7 +29453,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 1041, + "weight": 1058, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -29137,7 +29515,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 456, + "weight": 465, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -29199,7 +29577,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 458, + "weight": 467, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -29270,7 +29648,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 459, + "weight": 468, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -29332,7 +29710,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 466, + "weight": 475, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -29419,7 +29797,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 463, + "weight": 472, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -29481,7 +29859,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 455, + "weight": 464, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -29543,7 +29921,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 460, + "weight": 469, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -29605,7 +29983,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 461, + "weight": 470, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -29667,7 +30045,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 462, + "weight": 471, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -29729,7 +30107,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 1042, + "weight": 1059, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -29791,7 +30169,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 464, + "weight": 473, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -29853,7 +30231,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 465, + "weight": 474, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -29915,7 +30293,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 1043, + "weight": 1060, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -29977,7 +30355,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 454, + "weight": 463, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -30039,7 +30417,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 451, + "weight": 460, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -30090,7 +30468,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 450, + "weight": 459, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -30141,7 +30519,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 448, + "weight": 457, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -30626,7 +31004,7 @@ "x-appwrite": { "method": "createBlock", "group": null, - "weight": 975, + "weight": 994, "cookies": false, "type": "", "demo": "manager\/create-block.md", @@ -30725,7 +31103,7 @@ "x-appwrite": { "method": "deleteBlock", "group": null, - "weight": 977, + "weight": 996, "cookies": false, "type": "", "demo": "manager\/delete-block.md", @@ -30811,7 +31189,7 @@ "x-appwrite": { "method": "listBlocks", "group": null, - "weight": 976, + "weight": 995, "cookies": false, "type": "", "demo": "manager\/list-blocks.md", @@ -30863,7 +31241,7 @@ "x-appwrite": { "method": "updateUserStatus", "group": "users", - "weight": 978, + "weight": 997, "cookies": false, "type": "", "demo": "manager\/update-user-status.md", @@ -30941,7 +31319,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 158, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -31026,7 +31404,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 155, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -31187,7 +31565,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 162, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -31355,7 +31733,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 157, + "weight": 156, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -31555,7 +31933,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 164, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -31770,7 +32148,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 156, + "weight": 155, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -31961,7 +32339,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 163, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -32151,7 +32529,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 161, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -32207,7 +32585,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 165, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -32268,7 +32646,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 159, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -32350,7 +32728,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 160, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -32432,7 +32810,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 129, + "weight": 128, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -32517,7 +32895,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 128, + "weight": 127, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -32706,7 +33084,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 142, + "weight": 141, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -32892,7 +33270,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 127, + "weight": 126, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -33050,7 +33428,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 141, + "weight": 140, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -33204,7 +33582,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 118, + "weight": 117, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -33336,7 +33714,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 132, + "weight": 131, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -33465,7 +33843,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 122, + "weight": 121, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -33570,7 +33948,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 136, + "weight": 135, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -33673,7 +34051,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 120, + "weight": 119, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -33792,7 +34170,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 134, + "weight": 133, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -33908,7 +34286,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 119, + "weight": 118, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -34027,7 +34405,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 133, + "weight": 132, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -34143,7 +34521,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 121, + "weight": 120, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -34393,7 +34771,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 135, + "weight": 134, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -34637,7 +35015,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 123, + "weight": 122, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -34743,7 +35121,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 137, + "weight": 136, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -34846,7 +35224,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 124, + "weight": 123, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -34952,7 +35330,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 138, + "weight": 137, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -35055,7 +35433,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 125, + "weight": 124, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -35161,7 +35539,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 139, + "weight": 138, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -35264,7 +35642,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 126, + "weight": 125, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -35370,7 +35748,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 140, + "weight": 139, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -35471,7 +35849,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 131, + "weight": 130, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -35527,7 +35905,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 143, + "weight": 142, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -35588,7 +35966,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 130, + "weight": 129, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -35670,7 +36048,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 152, + "weight": 151, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -35752,7 +36130,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 145, + "weight": 144, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -35835,7 +36213,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 144, + "weight": 143, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -35924,7 +36302,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 147, + "weight": 146, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -35985,7 +36363,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 148, + "weight": 147, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -36067,7 +36445,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 149, + "weight": 148, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -36128,7 +36506,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 146, + "weight": 145, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -36210,7 +36588,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 151, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -36301,7 +36679,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 150, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -36390,7 +36768,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 153, + "weight": 152, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -36454,7 +36832,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 154, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -36526,7 +36904,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 572, + "weight": 581, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -36609,7 +36987,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 576, + "weight": 585, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -36696,6 +37074,19 @@ "description": "Source API Key", "default": null, "x-example": "" + }, + "onDuplicate": { + "type": "string", + "description": "Behavior when a row with an existing $id is encountered. \"fail\" (default): abort on first conflict. \"skip\": silently ignore. \"overwrite\": replace existing row.", + "default": "fail", + "x-example": "fail", + "enum": [ + "fail", + "skip", + "overwrite" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ @@ -36733,7 +37124,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 577, + "weight": 1079, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -36852,7 +37243,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 585, + "weight": 594, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -36978,7 +37369,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 584, + "weight": 593, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -37031,6 +37422,19 @@ "description": "Is the file stored in an internal bucket?", "default": false, "x-example": false + }, + "onDuplicate": { + "type": "string", + "description": "Behavior when a row with an existing $id is encountered. \"fail\" (default): abort on first conflict. \"skip\": silently ignore. \"overwrite\": replace existing row.", + "default": "fail", + "x-example": "fail", + "enum": [ + "fail", + "skip", + "overwrite" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ @@ -37069,7 +37473,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 578, + "weight": 587, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -37162,7 +37566,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 579, + "weight": 588, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -37248,7 +37652,7 @@ "x-appwrite": { "method": "createJSONExport", "group": null, - "weight": 587, + "weight": 596, "cookies": false, "type": "", "demo": "migrations\/create-json-export.md", @@ -37350,7 +37754,7 @@ "x-appwrite": { "method": "createJSONImport", "group": null, - "weight": 586, + "weight": 595, "cookies": false, "type": "", "demo": "migrations\/create-json-import.md", @@ -37403,6 +37807,19 @@ "description": "Is the file stored in an internal bucket?", "default": false, "x-example": false + }, + "onDuplicate": { + "type": "string", + "description": "Behavior when a row with an existing $id is encountered. \"fail\" (default): abort on first conflict. \"skip\": silently ignore. \"overwrite\": replace existing row.", + "default": "fail", + "x-example": "fail", + "enum": [ + "fail", + "skip", + "overwrite" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ @@ -37441,7 +37858,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 582, + "weight": 591, "cookies": false, "type": "", "demo": "migrations\/create-n-host-migration.md", @@ -37577,7 +37994,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 583, + "weight": 592, "cookies": false, "type": "", "demo": "migrations\/get-n-host-report.md", @@ -37713,7 +38130,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 580, + "weight": 589, "cookies": false, "type": "", "demo": "migrations\/create-supabase-migration.md", @@ -37843,7 +38260,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 581, + "weight": 590, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -37970,7 +38387,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 573, + "weight": 582, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -38029,7 +38446,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 574, + "weight": 583, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -38083,7 +38500,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 575, + "weight": 584, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -38142,7 +38559,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 990, + "weight": 1007, "cookies": false, "type": "", "demo": "organizations\/list.md", @@ -38221,7 +38638,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 989, + "weight": 1006, "cookies": false, "type": "", "demo": "organizations\/create.md", @@ -38363,7 +38780,7 @@ "x-appwrite": { "method": "estimationCreateOrganization", "group": null, - "weight": 1024, + "weight": 1041, "cookies": false, "type": "", "demo": "organizations\/estimation-create-organization.md", @@ -38466,7 +38883,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 991, + "weight": 1008, "cookies": false, "type": "", "demo": "organizations\/delete.md", @@ -38525,7 +38942,7 @@ "x-appwrite": { "method": "listAddons", "group": null, - "weight": 1032, + "weight": 1049, "cookies": false, "type": "", "demo": "organizations\/list-addons.md", @@ -38586,7 +39003,7 @@ "x-appwrite": { "method": "createBaaAddon", "group": null, - "weight": 1035, + "weight": 1052, "cookies": false, "type": "", "demo": "organizations\/create-baa-addon.md", @@ -38645,7 +39062,7 @@ "x-appwrite": { "method": "getAddon", "group": null, - "weight": 1033, + "weight": 1050, "cookies": false, "type": "", "demo": "organizations\/get-addon.md", @@ -38709,7 +39126,7 @@ "x-appwrite": { "method": "deleteAddon", "group": null, - "weight": 1036, + "weight": 1053, "cookies": false, "type": "", "demo": "organizations\/delete-addon.md", @@ -38778,7 +39195,7 @@ "x-appwrite": { "method": "confirmAddonPayment", "group": null, - "weight": 1037, + "weight": 1054, "cookies": false, "type": "", "demo": "organizations\/confirm-addon-payment.md", @@ -38845,7 +39262,7 @@ "x-appwrite": { "method": "getAddonPrice", "group": null, - "weight": 1034, + "weight": 1051, "cookies": false, "type": "", "demo": "organizations\/get-addon-price.md", @@ -38917,7 +39334,7 @@ "x-appwrite": { "method": "listAggregations", "group": null, - "weight": 1006, + "weight": 1023, "cookies": false, "type": "", "demo": "organizations\/list-aggregations.md", @@ -38988,7 +39405,7 @@ "x-appwrite": { "method": "getAggregation", "group": null, - "weight": 1007, + "weight": 1024, "cookies": false, "type": "", "demo": "organizations\/get-aggregation.md", @@ -39076,7 +39493,7 @@ "x-appwrite": { "method": "setBillingAddress", "group": null, - "weight": 999, + "weight": 1016, "cookies": false, "type": "", "demo": "organizations\/set-billing-address.md", @@ -39150,7 +39567,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 1000, + "weight": 1017, "cookies": false, "type": "", "demo": "organizations\/delete-billing-address.md", @@ -39209,7 +39626,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 998, + "weight": 1015, "cookies": false, "type": "", "demo": "organizations\/get-billing-address.md", @@ -39278,7 +39695,7 @@ "x-appwrite": { "method": "setBillingEmail", "group": null, - "weight": 1018, + "weight": 1035, "cookies": false, "type": "", "demo": "organizations\/set-billing-email.md", @@ -39358,7 +39775,7 @@ "x-appwrite": { "method": "updateBudget", "group": null, - "weight": 995, + "weight": 1012, "cookies": false, "type": "", "demo": "organizations\/update-budget.md", @@ -39448,7 +39865,7 @@ "x-appwrite": { "method": "listCredits", "group": null, - "weight": 1010, + "weight": 1027, "cookies": false, "type": "", "demo": "organizations\/list-credits.md", @@ -39519,7 +39936,7 @@ "x-appwrite": { "method": "addCredit", "group": null, - "weight": 1011, + "weight": 1028, "cookies": false, "type": "", "demo": "organizations\/add-credit.md", @@ -39596,7 +40013,7 @@ "x-appwrite": { "method": "getAvailableCredits", "group": null, - "weight": 1009, + "weight": 1026, "cookies": false, "type": "", "demo": "organizations\/get-available-credits.md", @@ -39655,7 +40072,7 @@ "x-appwrite": { "method": "getCredit", "group": null, - "weight": 1008, + "weight": 1025, "cookies": false, "type": "", "demo": "organizations\/get-credit.md", @@ -39724,7 +40141,7 @@ "x-appwrite": { "method": "estimationDeleteOrganization", "group": null, - "weight": 1025, + "weight": 1042, "cookies": false, "type": "", "demo": "organizations\/estimation-delete-organization.md", @@ -39785,7 +40202,7 @@ "x-appwrite": { "method": "estimationUpdatePlan", "group": null, - "weight": 1022, + "weight": 1039, "cookies": false, "type": "", "demo": "organizations\/estimation-update-plan.md", @@ -39880,7 +40297,7 @@ "x-appwrite": { "method": "createDowngradeFeedback", "group": null, - "weight": 1026, + "weight": 1043, "cookies": false, "type": "", "demo": "organizations\/create-downgrade-feedback.md", @@ -39978,7 +40395,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 1013, + "weight": 1030, "cookies": false, "type": "", "demo": "organizations\/list-invoices.md", @@ -40049,7 +40466,7 @@ "x-appwrite": { "method": "getInvoice", "group": null, - "weight": 1012, + "weight": 1029, "cookies": false, "type": "", "demo": "organizations\/get-invoice.md", @@ -40116,7 +40533,7 @@ "x-appwrite": { "method": "getInvoiceDownload", "group": null, - "weight": 1016, + "weight": 1033, "cookies": false, "type": "", "demo": "organizations\/get-invoice-download.md", @@ -40185,7 +40602,7 @@ "x-appwrite": { "method": "createInvoicePayment", "group": null, - "weight": 1017, + "weight": 1034, "cookies": false, "type": "", "demo": "organizations\/create-invoice-payment.md", @@ -40272,7 +40689,7 @@ "x-appwrite": { "method": "validateInvoice", "group": null, - "weight": 1014, + "weight": 1031, "cookies": false, "type": "", "demo": "organizations\/validate-invoice.md", @@ -40339,7 +40756,7 @@ "x-appwrite": { "method": "getInvoiceView", "group": null, - "weight": 1015, + "weight": 1032, "cookies": false, "type": "", "demo": "organizations\/get-invoice-view.md", @@ -40406,7 +40823,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1029, + "weight": 1046, "cookies": false, "type": "", "demo": "organizations\/list-keys.md", @@ -40473,7 +40890,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1027, + "weight": 1044, "cookies": false, "type": "", "demo": "organizations\/create-key.md", @@ -40579,7 +40996,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1031, + "weight": 1048, "cookies": false, "type": "", "demo": "organizations\/get-key.md", @@ -40645,7 +41062,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1028, + "weight": 1045, "cookies": false, "type": "", "demo": "organizations\/update-key.md", @@ -40756,7 +41173,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1030, + "weight": 1047, "cookies": false, "type": "", "demo": "organizations\/delete-key.md", @@ -40824,7 +41241,7 @@ "x-appwrite": { "method": "setDefaultPaymentMethod", "group": null, - "weight": 1002, + "weight": 1019, "cookies": false, "type": "", "demo": "organizations\/set-default-payment-method.md", @@ -40901,7 +41318,7 @@ "x-appwrite": { "method": "deleteDefaultPaymentMethod", "group": null, - "weight": 1004, + "weight": 1021, "cookies": false, "type": "", "demo": "organizations\/delete-default-payment-method.md", @@ -40962,7 +41379,7 @@ "x-appwrite": { "method": "setBackupPaymentMethod", "group": null, - "weight": 1003, + "weight": 1020, "cookies": false, "type": "", "demo": "organizations\/set-backup-payment-method.md", @@ -41039,7 +41456,7 @@ "x-appwrite": { "method": "deleteBackupPaymentMethod", "group": null, - "weight": 1005, + "weight": 1022, "cookies": false, "type": "", "demo": "organizations\/delete-backup-payment-method.md", @@ -41098,7 +41515,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 1001, + "weight": 1018, "cookies": false, "type": "", "demo": "organizations\/get-payment-method.md", @@ -41165,7 +41582,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 992, + "weight": 1009, "cookies": false, "type": "", "demo": "organizations\/get-plan.md", @@ -41224,7 +41641,7 @@ "x-appwrite": { "method": "updatePlan", "group": null, - "weight": 993, + "weight": 1010, "cookies": false, "type": "", "demo": "organizations\/update-plan.md", @@ -41347,7 +41764,7 @@ "x-appwrite": { "method": "cancelDowngrade", "group": null, - "weight": 994, + "weight": 1011, "cookies": false, "type": "", "demo": "organizations\/cancel-downgrade.md", @@ -41408,7 +41825,7 @@ "x-appwrite": { "method": "createPlanEstimation", "group": null, - "weight": 1023, + "weight": 1040, "cookies": false, "type": "", "demo": "organizations\/create-plan-estimation.md", @@ -41501,7 +41918,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 1021, + "weight": 1038, "cookies": false, "type": "", "demo": "organizations\/list-regions.md", @@ -41560,7 +41977,7 @@ "x-appwrite": { "method": "getScopes", "group": null, - "weight": 1020, + "weight": 1037, "cookies": false, "type": "", "demo": "organizations\/get-scopes.md", @@ -41630,7 +42047,7 @@ "x-appwrite": { "method": "setBillingTaxId", "group": null, - "weight": 996, + "weight": 1013, "cookies": false, "type": "", "demo": "organizations\/set-billing-tax-id.md", @@ -41708,7 +42125,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 997, + "weight": 1014, "cookies": false, "type": "", "demo": "organizations\/get-usage.md", @@ -41787,7 +42204,7 @@ "x-appwrite": { "method": "validatePayment", "group": null, - "weight": 1019, + "weight": 1036, "cookies": false, "type": "", "demo": "organizations\/validate-payment.md", @@ -41840,38 +42257,42 @@ ] } }, - "\/project": { - "delete": { - "summary": "Delete project", - "operationId": "projectDelete", - "consumes": [ + "\/presences": { + "get": { + "summary": "List presences", + "operationId": "presencesList", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "project" + "presences" ], - "description": "Delete a project.", + "description": "List presence logs.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Presences List", + "schema": { + "$ref": "#\/definitions\/presenceList" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": null, - "weight": 1088, + "method": "list", + "group": "presences", + "weight": 419, "cookies": false, "type": "", - "demo": "project\/delete.md", + "demo": "presences\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.read", "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, @@ -41882,48 +42303,80 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" } ] } }, - "\/project\/auth-methods\/{methodId}": { - "patch": { - "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", - "operationId": "projectUpdateAuthMethod", - "consumes": [ - "application\/json" - ], + "\/presences\/usage": { + "get": { + "summary": "Get presence usage", + "operationId": "presencesGetUsage", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "project" + "presences" ], - "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", + "description": "Get presence usage metrics and statistics, including the current total of online users and historical online user counts for the selected time range.", "responses": { "200": { - "description": "Project", + "description": "UsagePresence", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/usagePresence" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthMethod", + "method": "getUsage", "group": null, - "weight": 1137, + "weight": 417, "cookies": false, "type": "", - "demo": "project\/update-auth-method.md", + "demo": "presences\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -41933,28 +42386,178 @@ }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "methodId", - "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "type": "string", - "x-example": "email-password", + "x-example": "24h", "enum": [ - "email-password", - "magic-url", - "email-otp", - "anonymous", - "invites", - "jwt", - "phone" + "24h", + "30d", + "90d" ], "x-enum-name": null, "x-enum-keys": [], + "default": "30d", + "in": "query" + } + ] + } + }, + "\/presences\/{presenceId}": { + "get": { + "summary": "Get presence", + "operationId": "presencesGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "presences" + ], + "description": "Get a presence log by its unique ID.", + "responses": { + "200": { + "description": "Presence", + "schema": { + "$ref": "#\/definitions\/presence" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "presences", + "weight": 418, + "cookies": false, + "type": "", + "demo": "presences\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.read", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Upsert presence", + "operationId": "presencesUpsert", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "presences" + ], + "description": "Create or update a presence log by its unique ID.", + "responses": { + "200": { + "description": "Presence", + "schema": { + "$ref": "#\/definitions\/presence" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsert", + "group": "presences", + "weight": 416, + "cookies": false, + "type": "", + "demo": "presences\/upsert.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "client" + ], + "packaging": false, + "public": true, + "methods": [ + { + "name": "upsert", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "presenceId", + "userId", + "status", + "permissions", + "expiresAt", + "metadata" + ], + "required": [ + "presenceId", + "userId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/presence" + } + ], + "description": "", + "demo": "presences\/upsert.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -41963,25 +42566,54 @@ "schema": { "type": "object", "properties": { - "enabled": { - "type": "boolean", - "description": "Auth method status.", + "userId": { + "type": "string", + "description": "User ID.", "default": null, - "x-example": false + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "default": [], + "x-example": "{}" } }, "required": [ - "enabled" + "status" ] } } ] - } - }, - "\/project\/auth\/canonical-emails": { + }, "patch": { - "summary": "Update project auth canonical emails", - "operationId": "projectUpdateCanonicalEmails", + "summary": "Update presence", + "operationId": "presencesUpdate", "consumes": [ "application\/json" ], @@ -41989,35 +42621,66 @@ "application\/json" ], "tags": [ - "project" + "presences" ], - "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", + "description": "Update a presence log by its unique ID.", "responses": { "200": { - "description": "Project", + "description": "Presence", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/presence" } } }, "deprecated": false, "x-appwrite": { - "method": "updateCanonicalEmails", - "group": "auth", - "weight": 1182, + "method": "update", + "group": "presences", + "weight": 420, "cookies": false, "type": "", - "demo": "project\/update-canonical-emails.md", + "demo": "presences\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.write", "platforms": [ - "console", - "server" + "client" ], "packaging": false, "public": true, + "methods": [ + { + "name": "updatePresence", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "presenceId", + "userId", + "status", + "expiresAt", + "metadata", + "permissions", + "purge" + ], + "required": [ + "presenceId", + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/presence" + } + ], + "description": "", + "demo": "presences\/update-presence.md", + "public": true + } + ], "auth": { "Project": [] } @@ -42025,35 +42688,230 @@ "security": [ { "Project": [], - "Key": [] + "Session": [] } ], "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to require canonical email addresses during signup and email updates.", + "userId": { + "type": "string", + "description": "User ID.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", "default": null, + "x-example": "", + "x-nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "default": {}, + "x-example": "{}", + "x-nullable": true + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "purge": { + "type": "boolean", + "description": "When true, purge cached responses used by list presences endpoint.", + "default": false, "x-example": false } - }, - "required": [ - "enabled" - ] + } + } + } + ] + }, + "delete": { + "summary": "Delete presence", + "operationId": "presencesDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "presences" + ], + "description": "Delete a presence log by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "presences", + "weight": 421, + "cookies": false, + "type": "", + "demo": "presences\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/project": { + "get": { + "summary": "Get project", + "operationId": "projectGet", + "consumes": [], + "produces": [], + "tags": [ + "project" + ], + "description": "Get a project.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" } } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 1107, + "cookies": false, + "type": "", + "demo": "project\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + }, + "delete": { + "summary": "Delete project", + "operationId": "projectDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "project" + ], + "description": "Delete a project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 1106, + "cookies": false, + "type": "", + "demo": "project\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } ] } }, - "\/project\/auth\/disposable-emails": { + "\/project\/auth-methods\/{methodId}": { "patch": { - "summary": "Update project auth disposable emails", - "operationId": "projectUpdateDisposableEmails", + "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", + "operationId": "projectUpdateAuthMethod", "consumes": [ "application\/json" ], @@ -42063,7 +42921,7 @@ "tags": [ "project" ], - "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", + "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", "responses": { "200": { "description": "Project", @@ -42074,12 +42932,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDisposableEmails", - "group": "auth", - "weight": 1183, + "method": "updateAuthMethod", + "group": null, + "weight": 1156, "cookies": false, "type": "", - "demo": "project\/update-disposable-emails.md", + "demo": "project\/update-auth-method.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42102,77 +42960,24 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to block disposable email addresses during signup and email updates.", - "default": null, - "x-example": false - } - }, - "required": [ - "enabled" - ] - } - } - ] - } - }, - "\/project\/auth\/free-emails": { - "patch": { - "summary": "Update project auth free emails", - "operationId": "projectUpdateFreeEmails", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "project" - ], - "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", - "responses": { - "200": { - "description": "Project", - "schema": { - "$ref": "#\/definitions\/project" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateFreeEmails", - "group": "auth", - "weight": 1184, - "cookies": false, - "type": "", - "demo": "project\/update-free-emails.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ + "name": "methodId", + "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "required": true, + "type": "string", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "ProjectAuthMethodId", + "x-enum-keys": [], + "in": "path" + }, { "name": "payload", "in": "body", @@ -42181,7 +42986,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Set whether or not to block free email addresses during signup and email updates.", + "description": "Auth method status.", "default": null, "x-example": false } @@ -42218,7 +43023,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1104, + "weight": 1123, "cookies": false, "type": "", "demo": "project\/list-keys.md", @@ -42291,7 +43096,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1102, + "weight": 1121, "cookies": false, "type": "", "demo": "project\/create-key.md", @@ -42406,6 +43211,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -42418,8 +43225,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -42430,7 +43241,7 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, @@ -42479,7 +43290,7 @@ "x-appwrite": { "method": "createEphemeralKey", "group": "keys", - "weight": 1103, + "weight": 1122, "cookies": false, "type": "", "demo": "project\/create-ephemeral-key.md", @@ -42582,6 +43393,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -42594,8 +43407,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -42606,7 +43423,7 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, @@ -42614,7 +43431,7 @@ "type": "integer", "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", "default": null, - "x-example": 1, + "x-example": "600", "format": "int32" } }, @@ -42651,7 +43468,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1105, + "weight": 1124, "cookies": false, "type": "", "demo": "project\/get-key.md", @@ -42711,7 +43528,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1107, + "weight": 1126, "cookies": false, "type": "", "demo": "project\/update-key.md", @@ -42828,6 +43645,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -42840,8 +43659,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -42852,7 +43675,7 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, @@ -42893,7 +43716,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1106, + "weight": 1125, "cookies": false, "type": "", "demo": "project\/delete-key.md", @@ -42955,7 +43778,7 @@ "x-appwrite": { "method": "updateLabels", "group": null, - "weight": 1089, + "weight": 1108, "cookies": false, "type": "", "demo": "project\/update-labels.md", @@ -43028,7 +43851,7 @@ "x-appwrite": { "method": "listMockPhones", "group": "mocks", - "weight": 1122, + "weight": 1141, "cookies": false, "type": "", "demo": "project\/list-mock-phones.md", @@ -43101,7 +43924,7 @@ "x-appwrite": { "method": "createMockPhone", "group": "mocks", - "weight": 1121, + "weight": 1140, "cookies": false, "type": "", "demo": "project\/create-mock-phone.md", @@ -43179,7 +44002,7 @@ "x-appwrite": { "method": "getMockPhone", "group": "mocks", - "weight": 1123, + "weight": 1142, "cookies": false, "type": "", "demo": "project\/get-mock-phone.md", @@ -43240,7 +44063,7 @@ "x-appwrite": { "method": "updateMockPhone", "group": "mocks", - "weight": 1124, + "weight": 1143, "cookies": false, "type": "", "demo": "project\/update-mock-phone.md", @@ -43314,7 +44137,7 @@ "x-appwrite": { "method": "deleteMockPhone", "group": "mocks", - "weight": 1125, + "weight": 1144, "cookies": false, "type": "", "demo": "project\/delete-mock-phone.md", @@ -43375,7 +44198,7 @@ "x-appwrite": { "method": "listOAuth2Providers", "group": "oauth2", - "weight": 1138, + "weight": 1157, "cookies": false, "type": "", "demo": "project\/list-o-auth-2-providers.md", @@ -43398,6 +44221,29 @@ "Project": [], "Key": [] } + ], + "parameters": [ + { + "name": "queries", + "description": "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", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } ] } }, @@ -43427,7 +44273,7 @@ "x-appwrite": { "method": "updateOAuth2Amazon", "group": "oauth2", - "weight": 1165, + "weight": 1184, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-amazon.md", @@ -43511,7 +44357,7 @@ "x-appwrite": { "method": "updateOAuth2Apple", "group": "oauth2", - "weight": 1180, + "weight": 1199, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-apple.md", @@ -43609,7 +44455,7 @@ "x-appwrite": { "method": "updateOAuth2Auth0", "group": "oauth2", - "weight": 1174, + "weight": 1193, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-auth-0.md", @@ -43700,7 +44546,7 @@ "x-appwrite": { "method": "updateOAuth2Authentik", "group": "oauth2", - "weight": 1173, + "weight": 1192, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-authentik.md", @@ -43791,7 +44637,7 @@ "x-appwrite": { "method": "updateOAuth2Autodesk", "group": "oauth2", - "weight": 1148, + "weight": 1167, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-autodesk.md", @@ -43875,7 +44721,7 @@ "x-appwrite": { "method": "updateOAuth2Bitbucket", "group": "oauth2", - "weight": 1145, + "weight": 1164, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-bitbucket.md", @@ -43959,7 +44805,7 @@ "x-appwrite": { "method": "updateOAuth2Bitly", "group": "oauth2", - "weight": 1146, + "weight": 1165, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-bitly.md", @@ -44043,7 +44889,7 @@ "x-appwrite": { "method": "updateOAuth2Box", "group": "oauth2", - "weight": 1147, + "weight": 1166, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-box.md", @@ -44127,7 +44973,7 @@ "x-appwrite": { "method": "updateOAuth2Dailymotion", "group": "oauth2", - "weight": 1144, + "weight": 1163, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-dailymotion.md", @@ -44211,7 +45057,7 @@ "x-appwrite": { "method": "updateOAuth2Discord", "group": "oauth2", - "weight": 1141, + "weight": 1160, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-discord.md", @@ -44295,7 +45141,7 @@ "x-appwrite": { "method": "updateOAuth2Disqus", "group": "oauth2", - "weight": 1164, + "weight": 1183, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-disqus.md", @@ -44379,7 +45225,7 @@ "x-appwrite": { "method": "updateOAuth2Dropbox", "group": "oauth2", - "weight": 1143, + "weight": 1162, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-dropbox.md", @@ -44463,7 +45309,7 @@ "x-appwrite": { "method": "updateOAuth2Etsy", "group": "oauth2", - "weight": 1166, + "weight": 1185, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-etsy.md", @@ -44547,7 +45393,7 @@ "x-appwrite": { "method": "updateOAuth2Facebook", "group": "oauth2", - "weight": 1167, + "weight": 1186, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-facebook.md", @@ -44631,7 +45477,7 @@ "x-appwrite": { "method": "updateOAuth2Figma", "group": "oauth2", - "weight": 1142, + "weight": 1161, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-figma.md", @@ -44715,7 +45561,7 @@ "x-appwrite": { "method": "updateOAuth2FusionAuth", "group": "oauth2", - "weight": 1175, + "weight": 1194, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-fusion-auth.md", @@ -44806,7 +45652,7 @@ "x-appwrite": { "method": "updateOAuth2GitHub", "group": "oauth2", - "weight": 1140, + "weight": 1159, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-git-hub.md", @@ -44890,7 +45736,7 @@ "x-appwrite": { "method": "updateOAuth2Gitlab", "group": "oauth2", - "weight": 1172, + "weight": 1191, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-gitlab.md", @@ -44982,7 +45828,7 @@ "x-appwrite": { "method": "updateOAuth2Google", "group": "oauth2", - "weight": 1149, + "weight": 1168, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-google.md", @@ -45027,6 +45873,23 @@ "x-example": "", "x-nullable": true }, + "prompt": { + "type": "array", + "description": "Array of Google OAuth2 prompt values. If \"none\" is included, it must be the only element. \"none\" means: don't display any authentication or consent screens. Must not be specified with other values. \"consent\" means: prompt the user for consent. \"select_account\" means: prompt the user to select an account.", + "default": null, + "x-example": null, + "x-nullable": true, + "items": { + "type": "string", + "enum": [ + "none", + "consent", + "select_account" + ], + "x-enum-name": "ProjectOAuth2GooglePrompt", + "x-enum-keys": [] + } + }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", @@ -45066,7 +45929,7 @@ "x-appwrite": { "method": "updateOAuth2Keycloak", "group": "oauth2", - "weight": 1176, + "weight": 1195, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-keycloak.md", @@ -45164,7 +46027,7 @@ "x-appwrite": { "method": "updateOAuth2Kick", "group": "oauth2", - "weight": 1179, + "weight": 1198, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-kick.md", @@ -45248,7 +46111,7 @@ "x-appwrite": { "method": "updateOAuth2Linkedin", "group": "oauth2", - "weight": 1163, + "weight": 1182, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-linkedin.md", @@ -45332,7 +46195,7 @@ "x-appwrite": { "method": "updateOAuth2Microsoft", "group": "oauth2", - "weight": 1181, + "weight": 1200, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-microsoft.md", @@ -45423,7 +46286,7 @@ "x-appwrite": { "method": "updateOAuth2Notion", "group": "oauth2", - "weight": 1160, + "weight": 1179, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-notion.md", @@ -45507,7 +46370,7 @@ "x-appwrite": { "method": "updateOAuth2Oidc", "group": "oauth2", - "weight": 1177, + "weight": 1196, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-oidc.md", @@ -45568,7 +46431,7 @@ "format": "url", "x-nullable": true }, - "tokenUrl": { + "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", "default": null, @@ -45576,7 +46439,7 @@ "format": "url", "x-nullable": true }, - "userInfoUrl": { + "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", "default": null, @@ -45623,7 +46486,7 @@ "x-appwrite": { "method": "updateOAuth2Okta", "group": "oauth2", - "weight": 1178, + "weight": 1197, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-okta.md", @@ -45721,7 +46584,7 @@ "x-appwrite": { "method": "updateOAuth2Paypal", "group": "oauth2", - "weight": 1170, + "weight": 1189, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-paypal.md", @@ -45805,7 +46668,7 @@ "x-appwrite": { "method": "updateOAuth2PaypalSandbox", "group": "oauth2", - "weight": 1171, + "weight": 1190, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-paypal-sandbox.md", @@ -45889,7 +46752,7 @@ "x-appwrite": { "method": "updateOAuth2Podio", "group": "oauth2", - "weight": 1159, + "weight": 1178, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-podio.md", @@ -45973,7 +46836,7 @@ "x-appwrite": { "method": "updateOAuth2Salesforce", "group": "oauth2", - "weight": 1161, + "weight": 1180, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-salesforce.md", @@ -46057,7 +46920,7 @@ "x-appwrite": { "method": "updateOAuth2Slack", "group": "oauth2", - "weight": 1158, + "weight": 1177, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-slack.md", @@ -46141,7 +47004,7 @@ "x-appwrite": { "method": "updateOAuth2Spotify", "group": "oauth2", - "weight": 1157, + "weight": 1176, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-spotify.md", @@ -46225,7 +47088,7 @@ "x-appwrite": { "method": "updateOAuth2Stripe", "group": "oauth2", - "weight": 1156, + "weight": 1175, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-stripe.md", @@ -46309,7 +47172,7 @@ "x-appwrite": { "method": "updateOAuth2Tradeshift", "group": "oauth2", - "weight": 1168, + "weight": 1187, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-tradeshift.md", @@ -46393,7 +47256,7 @@ "x-appwrite": { "method": "updateOAuth2TradeshiftSandbox", "group": "oauth2", - "weight": 1169, + "weight": 1188, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-tradeshift-sandbox.md", @@ -46477,7 +47340,7 @@ "x-appwrite": { "method": "updateOAuth2Twitch", "group": "oauth2", - "weight": 1155, + "weight": 1174, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-twitch.md", @@ -46561,7 +47424,7 @@ "x-appwrite": { "method": "updateOAuth2WordPress", "group": "oauth2", - "weight": 1154, + "weight": 1173, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-word-press.md", @@ -46645,7 +47508,7 @@ "x-appwrite": { "method": "updateOAuth2X", "group": "oauth2", - "weight": 1153, + "weight": 1172, "cookies": false, "type": "", "demo": "project\/update-o-auth-2x.md", @@ -46729,7 +47592,7 @@ "x-appwrite": { "method": "updateOAuth2Yahoo", "group": "oauth2", - "weight": 1162, + "weight": 1181, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-yahoo.md", @@ -46813,7 +47676,7 @@ "x-appwrite": { "method": "updateOAuth2Yandex", "group": "oauth2", - "weight": 1152, + "weight": 1171, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-yandex.md", @@ -46897,7 +47760,7 @@ "x-appwrite": { "method": "updateOAuth2Zoho", "group": "oauth2", - "weight": 1151, + "weight": 1170, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-zoho.md", @@ -46981,7 +47844,7 @@ "x-appwrite": { "method": "updateOAuth2Zoom", "group": "oauth2", - "weight": 1150, + "weight": 1169, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-zoom.md", @@ -47039,7 +47902,7 @@ ] } }, - "\/project\/oauth2\/{provider}": { + "\/project\/oauth2\/{providerId}": { "get": { "summary": "Get project OAuth2 provider", "operationId": "projectGetOAuth2Provider", @@ -47231,7 +48094,7 @@ "x-appwrite": { "method": "getOAuth2Provider", "group": "oauth2", - "weight": 1139, + "weight": 1158, "cookies": false, "type": "", "demo": "project\/get-o-auth-2-provider.md", @@ -47257,11 +48120,60 @@ ], "parameters": [ { - "name": "provider", + "name": "providerId", "description": "OAuth2 provider key. For example: github, google, apple.", "required": true, "type": "string", - "x-example": "", + "x-example": "amazon", + "enum": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom", + "githubImagine", + "googleImagine" + ], + "x-enum-name": "ProjectOAuthProviderId", + "x-enum-keys": [], "in": "path" } ] @@ -47291,7 +48203,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 1120, + "weight": 1139, "cookies": false, "type": "", "demo": "project\/list-platforms.md", @@ -47366,7 +48278,7 @@ "x-appwrite": { "method": "createAndroidPlatform", "group": "platforms", - "weight": 1116, + "weight": 1135, "cookies": false, "type": "", "demo": "project\/create-android-platform.md", @@ -47452,7 +48364,7 @@ "x-appwrite": { "method": "updateAndroidPlatform", "group": "platforms", - "weight": 1111, + "weight": 1130, "cookies": false, "type": "", "demo": "project\/update-android-platform.md", @@ -47539,7 +48451,7 @@ "x-appwrite": { "method": "createApplePlatform", "group": "platforms", - "weight": 1115, + "weight": 1134, "cookies": false, "type": "", "demo": "project\/create-apple-platform.md", @@ -47625,7 +48537,7 @@ "x-appwrite": { "method": "updateApplePlatform", "group": "platforms", - "weight": 1110, + "weight": 1129, "cookies": false, "type": "", "demo": "project\/update-apple-platform.md", @@ -47712,7 +48624,7 @@ "x-appwrite": { "method": "createLinuxPlatform", "group": "platforms", - "weight": 1118, + "weight": 1137, "cookies": false, "type": "", "demo": "project\/create-linux-platform.md", @@ -47798,7 +48710,7 @@ "x-appwrite": { "method": "updateLinuxPlatform", "group": "platforms", - "weight": 1113, + "weight": 1132, "cookies": false, "type": "", "demo": "project\/update-linux-platform.md", @@ -47885,7 +48797,7 @@ "x-appwrite": { "method": "createWebPlatform", "group": "platforms", - "weight": 1114, + "weight": 1133, "cookies": false, "type": "", "demo": "project\/create-web-platform.md", @@ -47971,7 +48883,7 @@ "x-appwrite": { "method": "updateWebPlatform", "group": "platforms", - "weight": 1109, + "weight": 1128, "cookies": false, "type": "", "demo": "project\/update-web-platform.md", @@ -48058,7 +48970,7 @@ "x-appwrite": { "method": "createWindowsPlatform", "group": "platforms", - "weight": 1117, + "weight": 1136, "cookies": false, "type": "", "demo": "project\/create-windows-platform.md", @@ -48144,7 +49056,7 @@ "x-appwrite": { "method": "updateWindowsPlatform", "group": "platforms", - "weight": 1112, + "weight": 1131, "cookies": false, "type": "", "demo": "project\/update-windows-platform.md", @@ -48255,7 +49167,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 1119, + "weight": 1138, "cookies": false, "type": "", "demo": "project\/get-platform.md", @@ -48310,7 +49222,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 1108, + "weight": 1127, "cookies": false, "type": "", "demo": "project\/delete-platform.md", @@ -48370,7 +49282,7 @@ "x-appwrite": { "method": "listPolicies", "group": "policies", - "weight": 1126, + "weight": 1145, "cookies": false, "type": "", "demo": "project\/list-policies.md", @@ -48422,6 +49334,231 @@ ] } }, + "\/project\/policies\/deny-aliased-email": { + "patch": { + "summary": "Update deny aliased email policy", + "operationId": "projectUpdateDenyAliasedEmailPolicy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Configures if aliased emails such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDenyAliasedEmailPolicy", + "group": "policies", + "weight": 1201, + "cookies": false, + "type": "", + "demo": "project\/update-deny-aliased-email-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block aliased emails during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/project\/policies\/deny-disposable-email": { + "patch": { + "summary": "Update deny disposable email policy", + "operationId": "projectUpdateDenyDisposableEmailPolicy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Configures if disposable emails from known temporary domains are denied during new users sign-ups and email updates.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDenyDisposableEmailPolicy", + "group": "policies", + "weight": 1202, + "cookies": false, + "type": "", + "demo": "project\/update-deny-disposable-email-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/project\/policies\/deny-free-email": { + "patch": { + "summary": "Update deny free email policy", + "operationId": "projectUpdateDenyFreeEmailPolicy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Configures if emails from free providers such as Gmail or Yahoo are denied during new users sign-ups and email updates.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDenyFreeEmailPolicy", + "group": "policies", + "weight": 1203, + "cookies": false, + "type": "", + "demo": "project\/update-deny-free-email-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block free email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, "\/project\/policies\/membership-privacy": { "patch": { "summary": "Update membership privacy policy", @@ -48448,7 +49585,7 @@ "x-appwrite": { "method": "updateMembershipPrivacyPolicy", "group": "policies", - "weight": 1128, + "weight": 1147, "cookies": false, "type": "", "demo": "project\/update-membership-privacy-policy.md", @@ -48544,7 +49681,7 @@ "x-appwrite": { "method": "updatePasswordDictionaryPolicy", "group": "policies", - "weight": 1129, + "weight": 1148, "cookies": false, "type": "", "demo": "project\/update-password-dictionary-policy.md", @@ -48619,7 +49756,7 @@ "x-appwrite": { "method": "updatePasswordHistoryPolicy", "group": "policies", - "weight": 1130, + "weight": 1149, "cookies": false, "type": "", "demo": "project\/update-password-history-policy.md", @@ -48696,7 +49833,7 @@ "x-appwrite": { "method": "updatePasswordPersonalDataPolicy", "group": "policies", - "weight": 1131, + "weight": 1150, "cookies": false, "type": "", "demo": "project\/update-password-personal-data-policy.md", @@ -48771,7 +49908,7 @@ "x-appwrite": { "method": "updateSessionAlertPolicy", "group": "policies", - "weight": 1132, + "weight": 1151, "cookies": false, "type": "", "demo": "project\/update-session-alert-policy.md", @@ -48846,7 +49983,7 @@ "x-appwrite": { "method": "updateSessionDurationPolicy", "group": "policies", - "weight": 1133, + "weight": 1152, "cookies": false, "type": "", "demo": "project\/update-session-duration-policy.md", @@ -48922,7 +50059,7 @@ "x-appwrite": { "method": "updateSessionInvalidationPolicy", "group": "policies", - "weight": 1134, + "weight": 1153, "cookies": false, "type": "", "demo": "project\/update-session-invalidation-policy.md", @@ -48997,7 +50134,7 @@ "x-appwrite": { "method": "updateSessionLimitPolicy", "group": "policies", - "weight": 1135, + "weight": 1154, "cookies": false, "type": "", "demo": "project\/update-session-limit-policy.md", @@ -49074,7 +50211,7 @@ "x-appwrite": { "method": "updateUserLimitPolicy", "group": "policies", - "weight": 1136, + "weight": 1155, "cookies": false, "type": "", "demo": "project\/update-user-limit-policy.md", @@ -49191,7 +50328,7 @@ "x-appwrite": { "method": "getPolicy", "group": "policies", - "weight": 1127, + "weight": 1146, "cookies": false, "type": "", "demo": "project\/get-policy.md", @@ -49236,7 +50373,7 @@ "user-limit", "membership-privacy" ], - "x-enum-name": null, + "x-enum-name": "ProjectPolicyId", "x-enum-keys": [], "in": "path" } @@ -49269,7 +50406,7 @@ "x-appwrite": { "method": "updateProtocol", "group": null, - "weight": 1090, + "weight": 1109, "cookies": false, "type": "", "demo": "project\/update-protocol.md", @@ -49305,7 +50442,7 @@ "graphql", "websocket" ], - "x-enum-name": null, + "x-enum-name": "ProjectProtocolId", "x-enum-keys": [], "in": "path" }, @@ -49356,7 +50493,7 @@ "x-appwrite": { "method": "updateService", "group": null, - "weight": 1091, + "weight": 1110, "cookies": false, "type": "", "demo": "project\/update-service.md", @@ -49383,7 +50520,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "type": "string", "x-example": "account", @@ -49404,9 +50541,10 @@ "proxy", "graphql", "migrations", - "messaging" + "messaging", + "advisor" ], - "x-enum-name": null, + "x-enum-name": "ProjectServiceId", "x-enum-keys": [], "in": "path" }, @@ -49457,7 +50595,7 @@ "x-appwrite": { "method": "updateSMTP", "group": "smtp", - "weight": 1092, + "weight": 1111, "cookies": false, "type": "", "demo": "project\/update-smtp.md", @@ -49556,7 +50694,7 @@ "tls", "ssl" ], - "x-enum-name": null, + "x-enum-name": "ProjectSMTPSecure", "x-enum-keys": [], "x-nullable": true }, @@ -49594,7 +50732,7 @@ "x-appwrite": { "method": "createSMTPTest", "group": "smtp", - "weight": 1093, + "weight": 1112, "cookies": false, "type": "", "demo": "project\/create-smtp-test.md", @@ -49667,7 +50805,7 @@ "x-appwrite": { "method": "listEmailTemplates", "group": "templates", - "weight": 1094, + "weight": 1113, "cookies": false, "type": "", "demo": "project\/list-email-templates.md", @@ -49740,7 +50878,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 1096, + "weight": 1115, "cookies": false, "type": "", "demo": "project\/update-email-template.md", @@ -49785,7 +50923,7 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "EmailTemplateType", + "x-enum-name": "ProjectEmailTemplateId", "x-enum-keys": [] }, "locale": { @@ -49926,7 +51064,7 @@ "zh-tw", "zu" ], - "x-enum-name": "EmailTemplateLocale", + "x-enum-name": "ProjectEmailTemplateLocale", "x-enum-keys": [] }, "subject": { @@ -50006,7 +51144,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 1095, + "weight": 1114, "cookies": false, "type": "", "demo": "project\/get-email-template.md", @@ -50046,7 +51184,7 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "EmailTemplateType", + "x-enum-name": "ProjectEmailTemplateId", "x-enum-keys": [], "in": "path" }, @@ -50189,7 +51327,7 @@ "zh-tw", "zu" ], - "x-enum-name": "EmailTemplateLocale", + "x-enum-name": "ProjectEmailTemplateLocale", "x-enum-keys": [], "default": "", "in": "query" @@ -50221,7 +51359,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 682, + "weight": 697, "cookies": false, "type": "", "demo": "project\/get-usage.md", @@ -50308,7 +51446,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 1098, + "weight": 1117, "cookies": false, "type": "", "demo": "project\/list-variables.md", @@ -50381,7 +51519,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 1097, + "weight": 1116, "cookies": false, "type": "", "demo": "project\/create-variable.md", @@ -50414,7 +51552,7 @@ "properties": { "variableId": { "type": "string", - "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, "x-example": "" }, @@ -50471,7 +51609,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 1099, + "weight": 1118, "cookies": false, "type": "", "demo": "project\/get-variable.md", @@ -50498,7 +51636,7 @@ "parameters": [ { "name": "variableId", - "description": "Variable ID.", + "description": "Variable unique ID.", "required": true, "type": "string", "x-example": "", @@ -50531,7 +51669,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 1101, + "weight": 1120, "cookies": false, "type": "", "demo": "project\/update-variable.md", @@ -50558,7 +51696,7 @@ "parameters": [ { "name": "variableId", - "description": "Variable ID.", + "description": "Variable unique ID.", "required": true, "type": "string", "x-example": "", @@ -50616,7 +51754,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 1100, + "weight": 1119, "cookies": false, "type": "", "demo": "project\/delete-variable.md", @@ -50643,7 +51781,7 @@ "parameters": [ { "name": "variableId", - "description": "Variable ID.", + "description": "Variable unique ID.", "required": true, "type": "string", "x-example": "", @@ -50676,7 +51814,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 1086, + "weight": 1104, "cookies": false, "type": "", "demo": "projects\/list.md", @@ -50756,7 +51894,7 @@ "x-appwrite": { "method": "create", "group": "projects", - "weight": 1084, + "weight": 1102, "cookies": false, "type": "", "demo": "projects\/create.md", @@ -50819,61 +51957,6 @@ ], "x-enum-name": null, "x-enum-keys": [] - }, - "description": { - "type": "string", - "description": "Project description. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "logo": { - "type": "string", - "description": "Project logo.", - "default": "", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Project URL.", - "default": "", - "x-example": "https:\/\/example.com", - "format": "url" - }, - "legalName": { - "type": "string", - "description": "Project legal Name. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalCountry": { - "type": "string", - "description": "Project legal Country. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalState": { - "type": "string", - "description": "Project legal State. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalCity": { - "type": "string", - "description": "Project legal City. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalAddress": { - "type": "string", - "description": "Project legal Address. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalTaxId": { - "type": "string", - "description": "Project legal Tax ID. Max length: 256 chars.", - "default": "", - "x-example": "" } }, "required": [ @@ -50887,63 +51970,6 @@ } }, "\/projects\/{projectId}": { - "get": { - "summary": "Get project", - "operationId": "projectsGet", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "projects" - ], - "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", - "responses": { - "200": { - "description": "Project", - "schema": { - "$ref": "#\/definitions\/project" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "get", - "group": "projects", - "weight": 57, - "cookies": false, - "type": "", - "demo": "projects\/get.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, "patch": { "summary": "Update project", "operationId": "projectsUpdate", @@ -50969,7 +51995,7 @@ "x-appwrite": { "method": "update", "group": "projects", - "weight": 1085, + "weight": 1103, "cookies": false, "type": "", "demo": "projects\/update.md", @@ -51100,7 +52126,7 @@ "x-appwrite": { "method": "updateConsoleAccess", "group": null, - "weight": 1081, + "weight": 1099, "cookies": false, "type": "", "demo": "projects\/update-console-access.md", @@ -51159,7 +52185,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 404, + "weight": 407, "cookies": false, "type": "", "demo": "projects\/list-dev-keys.md", @@ -51229,7 +52255,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 401, + "weight": 404, "cookies": false, "type": "", "demo": "projects\/create-dev-key.md", @@ -51313,7 +52339,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 403, + "weight": 406, "cookies": false, "type": "", "demo": "projects\/get-dev-key.md", @@ -51379,7 +52405,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 402, + "weight": 405, "cookies": false, "type": "", "demo": "projects\/update-dev-key.md", @@ -51466,7 +52492,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 405, + "weight": 408, "cookies": false, "type": "", "demo": "projects\/delete-dev-key.md", @@ -51532,7 +52558,7 @@ "x-appwrite": { "method": "listSchedules", "group": "schedules", - "weight": 412, + "weight": 415, "cookies": false, "type": "", "demo": "projects\/list-schedules.md", @@ -51612,7 +52638,7 @@ "x-appwrite": { "method": "createSchedule", "group": "schedules", - "weight": 1087, + "weight": 1105, "cookies": false, "type": "", "demo": "projects\/create-schedule.md", @@ -51723,7 +52749,7 @@ "x-appwrite": { "method": "getSchedule", "group": "schedules", - "weight": 411, + "weight": 414, "cookies": false, "type": "", "demo": "projects\/get-schedule.md", @@ -51789,7 +52815,7 @@ "x-appwrite": { "method": "updateStatus", "group": null, - "weight": 1082, + "weight": 1100, "cookies": false, "type": "", "demo": "projects\/update-status.md", @@ -51873,7 +52899,7 @@ "x-appwrite": { "method": "updateTeam", "group": "projects", - "weight": 1083, + "weight": 1101, "cookies": false, "type": "", "demo": "projects\/update-team.md", @@ -51949,8 +52975,8 @@ "deprecated": false, "x-appwrite": { "method": "listRules", - "group": null, - "weight": 1194, + "group": "rules", + "weight": 1213, "cookies": false, "type": "", "demo": "proxy\/list-rules.md", @@ -51959,7 +52985,8 @@ "rate-key": "url:{url},ip:{ip}", "scope": "rules.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -51969,7 +52996,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -51985,15 +53013,6 @@ "default": [], "in": "query" }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -52019,7 +53038,7 @@ "tags": [ "proxy" ], - "description": "Create a new proxy rule for serving Appwrite's API on custom domain.", + "description": "Create a new proxy rule for serving Appwrite's API on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", "responses": { "201": { "description": "Rule", @@ -52031,8 +53050,8 @@ "deprecated": false, "x-appwrite": { "method": "createAPIRule", - "group": null, - "weight": 1189, + "group": "rules", + "weight": 1208, "cookies": false, "type": "", "demo": "proxy\/create-api-rule.md", @@ -52041,7 +53060,8 @@ "rate-key": "userId:{userId}, url:{url}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -52051,7 +53071,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -52089,7 +53110,7 @@ "tags": [ "proxy" ], - "description": "Create a new proxy rule for executing Appwrite Function on custom domain.", + "description": "Create a new proxy rule for executing Appwrite Function on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", "responses": { "201": { "description": "Rule", @@ -52101,8 +53122,8 @@ "deprecated": false, "x-appwrite": { "method": "createFunctionRule", - "group": null, - "weight": 1191, + "group": "rules", + "weight": 1210, "cookies": false, "type": "", "demo": "proxy\/create-function-rule.md", @@ -52111,7 +53132,8 @@ "rate-key": "userId:{userId}, url:{url}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -52121,7 +53143,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -52172,7 +53195,7 @@ "tags": [ "proxy" ], - "description": "Create a new proxy rule for to redirect from custom domain to another domain.", + "description": "Create a new proxy rule for to redirect from custom domain to another domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", "responses": { "201": { "description": "Rule", @@ -52184,8 +53207,8 @@ "deprecated": false, "x-appwrite": { "method": "createRedirectRule", - "group": null, - "weight": 1192, + "group": "rules", + "weight": 1211, "cookies": false, "type": "", "demo": "proxy\/create-redirect-rule.md", @@ -52194,7 +53217,8 @@ "rate-key": "userId:{userId}, url:{url}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -52204,7 +53228,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -52293,7 +53318,7 @@ "tags": [ "proxy" ], - "description": "Create a new proxy rule for serving Appwrite Site on custom domain.", + "description": "Create a new proxy rule for serving Appwrite Site on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", "responses": { "201": { "description": "Rule", @@ -52305,8 +53330,8 @@ "deprecated": false, "x-appwrite": { "method": "createSiteRule", - "group": null, - "weight": 1190, + "group": "rules", + "weight": 1209, "cookies": false, "type": "", "demo": "proxy\/create-site-rule.md", @@ -52315,7 +53340,8 @@ "rate-key": "userId:{userId}, url:{url}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -52325,7 +53351,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -52386,8 +53413,8 @@ "deprecated": false, "x-appwrite": { "method": "getRule", - "group": null, - "weight": 1193, + "group": "rules", + "weight": 1212, "cookies": false, "type": "", "demo": "proxy\/get-rule.md", @@ -52396,7 +53423,8 @@ "rate-key": "url:{url},ip:{ip}", "scope": "rules.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -52406,7 +53434,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -52439,8 +53468,8 @@ "deprecated": false, "x-appwrite": { "method": "deleteRule", - "group": null, - "weight": 1195, + "group": "rules", + "weight": 1214, "cookies": false, "type": "", "demo": "proxy\/delete-rule.md", @@ -52449,7 +53478,8 @@ "rate-key": "url:{url},ip:{ip}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -52459,7 +53489,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -52474,10 +53505,10 @@ ] } }, - "\/proxy\/rules\/{ruleId}\/verification": { + "\/proxy\/rules\/{ruleId}\/status": { "patch": { - "summary": "Update rule verification status", - "operationId": "proxyUpdateRuleVerification", + "summary": "Update rule status", + "operationId": "proxyUpdateRuleStatus", "consumes": [ "application\/json" ], @@ -52487,7 +53518,7 @@ "tags": [ "proxy" ], - "description": "Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.", + "description": "If not succeeded yet, retry verification process of a proxy rule domain. This endpoint triggers domain verification by checking DNS records. If verification is successful, a TLS certificate will be automatically provisioned for the domain asynchronously in the background.", "responses": { "200": { "description": "Rule", @@ -52498,18 +53529,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRuleVerification", - "group": null, - "weight": 1196, + "method": "updateRuleStatus", + "group": "rules", + "weight": 1215, "cookies": false, "type": "", - "demo": "proxy\/update-rule-verification.md", + "demo": "proxy\/update-rule-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "rules.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -52519,7 +53551,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -52534,6 +53567,360 @@ ] } }, + "\/reports": { + "get": { + "summary": "List reports", + "operationId": "advisorListReports", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "Get a list of all the project's analyzer reports. You can use the query params to filter your results.\n", + "responses": { + "200": { + "description": "Reports List", + "schema": { + "$ref": "#\/definitions\/reportList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listReports", + "group": "reports", + "weight": 693, + "cookies": false, + "type": "", + "demo": "advisor\/list-reports.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-reports.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "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: appId, type, targetType, target, analyzedAt", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/reports\/{reportId}": { + "get": { + "summary": "Get report", + "operationId": "advisorGetReport", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "Get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.\n", + "responses": { + "200": { + "description": "Report", + "schema": { + "$ref": "#\/definitions\/report" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getReport", + "group": "reports", + "weight": 692, + "cookies": false, + "type": "", + "demo": "advisor\/get-report.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-report.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete report", + "operationId": "advisorDeleteReport", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "advisor" + ], + "description": "Delete an analyzer report by its unique ID. Nested insights and CTA metadata are removed asynchronously by the deletes worker.\n", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteReport", + "group": "reports", + "weight": 694, + "cookies": false, + "type": "", + "demo": "advisor\/delete-report.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "projectId:{projectId},userId:{userId}", + "scope": "reports.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/delete-report.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/reports\/{reportId}\/insights": { + "get": { + "summary": "List insights", + "operationId": "advisorListInsights", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "List the insights produced under a single analyzer report. You can use the query params to filter your results further.\n", + "responses": { + "200": { + "description": "Insights List", + "schema": { + "$ref": "#\/definitions\/insightList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listInsights", + "group": "insights", + "weight": 696, + "cookies": false, + "type": "", + "demo": "advisor\/list-insights.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "insights.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-insights.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Parent report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "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: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/reports\/{reportId}\/insights\/{insightId}": { + "get": { + "summary": "Get insight", + "operationId": "advisorGetInsight", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "Get an insight by its unique ID, scoped to its parent report.\n", + "responses": { + "200": { + "description": "Insight", + "schema": { + "$ref": "#\/definitions\/insight" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getInsight", + "group": "insights", + "weight": 695, + "cookies": false, + "type": "", + "demo": "advisor\/get-insight.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "insights.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-insight.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Parent report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "insightId", + "description": "Insight ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, "\/sites": { "get": { "summary": "List sites", @@ -52558,7 +53945,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 470, + "weight": 479, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -52640,7 +54027,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 903, + "weight": 922, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -52956,7 +54343,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 473, + "weight": 482, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -53006,7 +54393,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 496, + "weight": 505, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -53056,7 +54443,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 492, + "weight": 501, "cookies": false, "type": "", "demo": "sites\/list-templates.md", @@ -53182,7 +54569,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 493, + "weight": 502, "cookies": false, "type": "", "demo": "sites\/get-template.md", @@ -53240,7 +54627,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 494, + "weight": 503, "cookies": false, "type": "", "demo": "sites\/list-usage.md", @@ -53310,7 +54697,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 469, + "weight": 478, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -53370,7 +54757,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 904, + "weight": 923, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -53681,7 +55068,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 472, + "weight": 481, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -53743,7 +55130,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 479, + "weight": 488, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -53821,7 +55208,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 478, + "weight": 487, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -53911,7 +55298,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 474, + "weight": 483, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -54013,7 +55400,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 482, + "weight": 491, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -54093,7 +55480,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 475, + "weight": 484, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -54214,7 +55601,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 476, + "weight": 485, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -54312,7 +55699,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 477, + "weight": 486, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -54375,7 +55762,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 480, + "weight": 489, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -54443,7 +55830,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 481, + "weight": 490, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -54529,7 +55916,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 483, + "weight": 492, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -54597,7 +55984,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 485, + "weight": 494, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -54678,7 +56065,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 484, + "weight": 493, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -54743,7 +56130,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 486, + "weight": 495, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -54811,7 +56198,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 495, + "weight": 504, "cookies": false, "type": "", "demo": "sites\/get-usage.md", @@ -54889,7 +56276,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 489, + "weight": 498, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -54921,6 +56308,27 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "queries", + "description": "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: key, resourceType, resourceId, secret", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, @@ -54949,7 +56357,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 905, + "weight": 924, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -54988,6 +56396,12 @@ "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -55008,6 +56422,7 @@ } }, "required": [ + "variableId", "key", "value" ] @@ -55040,7 +56455,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 488, + "weight": 497, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -55108,7 +56523,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 490, + "weight": 499, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -55159,7 +56574,8 @@ "type": "string", "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -55175,10 +56591,7 @@ "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } ] @@ -55203,7 +56616,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 491, + "weight": 500, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -55271,7 +56684,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 539, + "weight": 548, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -55354,7 +56767,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 537, + "weight": 546, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -55501,7 +56914,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 538, + "weight": 547, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -55562,7 +56975,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 540, + "weight": 549, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -55705,7 +57118,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 541, + "weight": 550, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -55766,7 +57179,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 544, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -55860,7 +57273,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 1187, + "weight": 1206, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -55952,7 +57365,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 543, + "weight": 552, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -56024,7 +57437,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 545, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -56116,7 +57529,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 546, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -56188,7 +57601,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 548, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -56269,7 +57682,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 547, + "weight": 556, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -56478,7 +57891,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 549, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -56559,7 +57972,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 551, + "weight": 560, "cookies": false, "type": "", "demo": "storage\/get-usage.md", @@ -56630,7 +58043,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 552, + "weight": 561, "cookies": false, "type": "", "demo": "storage\/get-bucket-usage.md", @@ -56709,7 +58122,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 761, + "weight": 778, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -56792,7 +58205,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 757, + "weight": 774, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -56876,7 +58289,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 828, + "weight": 847, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -56947,7 +58360,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 824, + "weight": 843, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -57022,7 +58435,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 825, + "weight": 844, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -57089,7 +58502,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 826, + "weight": 845, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -57172,7 +58585,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 827, + "weight": 846, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -57241,7 +58654,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 829, + "weight": 848, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -57326,7 +58739,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 763, + "weight": 780, "cookies": false, "type": "", "demo": "tablesdb\/list-usage.md", @@ -57423,7 +58836,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 758, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -57484,7 +58897,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 759, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -57561,7 +58974,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 760, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -57622,7 +59035,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 768, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -57716,7 +59129,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 764, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -57845,7 +59258,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 765, + "weight": 782, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -57917,7 +59330,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 766, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -57968,149 +59381,377 @@ "schema": { "type": "object", "properties": { - "name": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tablesDB" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTable", + "group": "tables", + "weight": 784, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "List columns in the table.", + "responses": { + "200": { + "description": "Columns List", + "schema": { + "$ref": "#\/definitions\/columnList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 790, + "cookies": false, + "type": "", + "demo": "tablesdb\/list-columns.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.read", + "collections.read", + "columns.read", + "attributes.read" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "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 columns: key, type, size, required, array, status, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint": { + "post": { + "summary": "Create bigint column", + "operationId": "tablesDBCreateBigIntColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "Create a bigint column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnBigInt", + "schema": { + "$ref": "#\/definitions\/columnBigint" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBigIntColumn", + "group": "columns", + "weight": 803, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-bigint-column.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { "type": "string", - "description": "Table name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Column Key.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": null }, - "rowSecurity": { + "required": { "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, + "description": "Is column required?", + "default": null, "x-example": false }, - "enabled": { - "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", - "default": true, - "x-example": false + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true }, - "purge": { + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { "type": "boolean", - "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "description": "Is column an array?", "default": false, "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } ] - }, - "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint\/{key}": { + "patch": { + "summary": "Update bigint column", + "operationId": "tablesDBUpdateBigIntColumn", "consumes": [ "application\/json" ], - "produces": [], - "tags": [ - "tablesDB" - ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 767, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete-table.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { - "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", - "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "List columns in the table.", + "description": "Update a bigint column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Columns List", + "description": "ColumnBigInt", "schema": { - "$ref": "#\/definitions\/columnList" + "$ref": "#\/definitions\/columnBigint" } } }, "deprecated": false, "x-appwrite": { - "method": "listColumns", + "method": "updateBigIntColumn", "group": "columns", - "weight": 773, + "weight": 804, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "tablesdb\/update-big-int-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read", - "columns.read", - "attributes.read" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ "console", @@ -58118,7 +59759,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-bigint-column.md", "auth": { "Project": [] } @@ -58147,25 +59788,61 @@ "in": "path" }, { - "name": "queries", - "description": "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 columns: key, type, size, required, array, status, error", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } @@ -58196,7 +59873,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 774, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -58310,7 +59987,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 775, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -58426,7 +60103,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 776, + "weight": 793, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -58541,7 +60218,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 777, + "weight": 794, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -58658,7 +60335,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 778, + "weight": 795, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -58773,7 +60450,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 779, + "weight": 796, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -58890,7 +60567,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 780, + "weight": 797, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -59014,7 +60691,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 781, + "weight": 798, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -59140,7 +60817,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 782, + "weight": 799, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -59271,7 +60948,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 783, + "weight": 800, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -59404,7 +61081,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 784, + "weight": 801, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -59535,7 +61212,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 785, + "weight": 802, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -59668,7 +61345,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 786, + "weight": 805, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -59782,7 +61459,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 787, + "weight": 806, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -59898,7 +61575,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 788, + "weight": 807, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -60006,7 +61683,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 789, + "weight": 808, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -60121,7 +61798,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 806, + "weight": 825, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -60241,7 +61918,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 807, + "weight": 826, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -60357,7 +62034,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 804, + "weight": 823, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -60477,7 +62154,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 805, + "weight": 824, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -60593,7 +62270,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 790, + "weight": 809, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -60701,7 +62378,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 791, + "weight": 810, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -60816,7 +62493,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 792, + "weight": 811, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -60924,7 +62601,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 793, + "weight": 812, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -61039,7 +62716,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 794, + "weight": 813, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -61181,7 +62858,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 796, + "weight": 815, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -61313,7 +62990,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 797, + "weight": 816, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -61441,7 +63118,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 802, + "weight": 821, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -61561,7 +63238,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 803, + "weight": 822, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -61677,7 +63354,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 798, + "weight": 817, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -61792,7 +63469,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 799, + "weight": 818, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -61909,7 +63586,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 800, + "weight": 819, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -62037,7 +63714,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 801, + "weight": 820, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -62241,7 +63918,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 771, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -62317,7 +63994,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 772, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -62400,7 +64077,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 795, + "weight": 814, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -62511,7 +64188,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 811, + "weight": 830, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -62605,7 +64282,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 808, + "weight": 827, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -62745,7 +64422,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 809, + "weight": 828, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -62820,7 +64497,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 810, + "weight": 829, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -62900,7 +64577,7 @@ "x-appwrite": { "method": "listTableLogs", "group": "tables", - "weight": 769, + "weight": 786, "cookies": false, "type": "", "demo": "tablesdb\/list-table-logs.md", @@ -62982,7 +64659,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 899, + "weight": 918, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -63096,7 +64773,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 812, + "weight": 831, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -63279,7 +64956,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 817, + "weight": 836, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -63409,7 +65086,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 815, + "weight": 834, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -63512,7 +65189,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 819, + "weight": 838, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -63609,7 +65286,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 813, + "weight": 832, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -63712,7 +65389,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 816, + "weight": 835, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -63859,7 +65536,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 814, + "weight": 833, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -63969,7 +65646,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 818, + "weight": 837, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -64068,7 +65745,7 @@ "x-appwrite": { "method": "listRowLogs", "group": "logs", - "weight": 821, + "weight": 840, "cookies": false, "type": "", "demo": "tablesdb\/list-row-logs.md", @@ -64160,7 +65837,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 823, + "weight": 842, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -64283,7 +65960,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 822, + "weight": 841, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -64404,7 +66081,7 @@ "x-appwrite": { "method": "getTableUsage", "group": null, - "weight": 770, + "weight": 787, "cookies": false, "type": "", "demo": "tablesdb\/get-table-usage.md", @@ -64494,7 +66171,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 762, + "weight": 779, "cookies": false, "type": "", "demo": "tablesdb\/get-usage.md", @@ -64602,7 +66279,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 520, + "weight": 529, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -64688,7 +66365,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 518, + "weight": 527, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -64780,7 +66457,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 519, + "weight": 528, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -64844,7 +66521,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 522, + "weight": 531, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -64921,7 +66598,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 521, + "weight": 530, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -64985,7 +66662,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 531, + "weight": 540, "cookies": false, "type": "", "demo": "teams\/list-logs.md", @@ -65065,7 +66742,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 527, + "weight": 536, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -65159,7 +66836,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 525, + "weight": 534, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -65277,7 +66954,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 526, + "weight": 535, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -65349,7 +67026,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 528, + "weight": 537, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -65437,7 +67114,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 1188, + "weight": 1207, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -65511,7 +67188,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 530, + "weight": 539, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -65607,7 +67284,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 523, + "weight": 532, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -65670,7 +67347,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 524, + "weight": 533, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -65751,7 +67428,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 534, + "weight": 543, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -65840,7 +67517,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 532, + "weight": 541, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -65925,7 +67602,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 533, + "weight": 542, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -65985,7 +67662,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 535, + "weight": 544, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -66057,7 +67734,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 536, + "weight": 545, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -66117,7 +67794,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 71, + "weight": 70, "cookies": false, "type": "", "demo": "users\/list.md", @@ -66200,7 +67877,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 62, + "weight": 61, "cookies": false, "type": "", "demo": "users\/create.md", @@ -66301,7 +67978,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 65, + "weight": 64, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -66396,7 +68073,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 63, + "weight": 62, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -66489,7 +68166,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 79, + "weight": 78, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -66569,7 +68246,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 103, + "weight": 102, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -66632,7 +68309,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 64, + "weight": 63, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -66727,7 +68404,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 67, + "weight": 66, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -66822,7 +68499,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 68, + "weight": 67, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -66956,7 +68633,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 69, + "weight": 68, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -67072,7 +68749,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 66, + "weight": 65, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -67186,7 +68863,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 105, + "weight": 104, "cookies": false, "type": "", "demo": "users\/get-usage.md", @@ -67257,7 +68934,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 72, + "weight": 71, "cookies": false, "type": "", "demo": "users\/get.md", @@ -67313,7 +68990,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 101, + "weight": 100, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -67376,7 +69053,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 86, + "weight": 85, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -67458,7 +69135,7 @@ "x-appwrite": { "method": "updateImpersonator", "group": "users", - "weight": 82, + "weight": 81, "cookies": false, "type": "", "demo": "users\/update-impersonator.md", @@ -67539,7 +69216,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 104, + "weight": 103, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -67624,7 +69301,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 81, + "weight": 80, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -67706,7 +69383,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 77, + "weight": 76, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -67788,7 +69465,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 76, + "weight": 75, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -67881,7 +69558,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 91, + "weight": 90, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -68017,7 +69694,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 96, + "weight": 95, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -68149,7 +69826,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 92, + "weight": 91, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -68266,7 +69943,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 93, + "weight": 92, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -68383,7 +70060,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 95, + "weight": 94, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -68500,7 +70177,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 94, + "weight": 93, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -68619,7 +70296,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 84, + "weight": 83, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -68700,7 +70377,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 85, + "weight": 84, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -68781,7 +70458,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 87, + "weight": 86, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -68861,7 +70538,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 73, + "weight": 72, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -68922,7 +70599,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 89, + "weight": 88, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -69001,7 +70678,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 75, + "weight": 74, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -69074,7 +70751,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 97, + "weight": 96, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -69133,7 +70810,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 100, + "weight": 99, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -69194,7 +70871,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 99, + "weight": 98, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -69268,7 +70945,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 80, + "weight": 79, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -69347,7 +71024,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 78, + "weight": 77, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -69429,7 +71106,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 70, + "weight": 69, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -69541,7 +71218,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 74, + "weight": 73, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -69610,7 +71287,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 90, + "weight": 89, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -69701,7 +71378,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 102, + "weight": 101, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -69772,7 +71449,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 98, + "weight": 97, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -69858,7 +71535,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 88, + "weight": 87, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -69939,7 +71616,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 83, + "weight": 82, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -70034,7 +71711,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 564, + "weight": 573, "cookies": false, "type": "", "demo": "vcs\/create-repository-detection.md", @@ -70144,7 +71821,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 561, + "weight": 570, "cookies": false, "type": "", "demo": "vcs\/list-repositories.md", @@ -70238,7 +71915,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 559, + "weight": 568, "cookies": false, "type": "", "demo": "vcs\/create-repository.md", @@ -70322,7 +71999,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 560, + "weight": 569, "cookies": false, "type": "", "demo": "vcs\/get-repository.md", @@ -70376,7 +72053,7 @@ "tags": [ "vcs" ], - "description": "Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.\n", + "description": "Get a list of branches from a GitHub repository in your installation. This endpoint supports filtering by a search term and pagination using query strings such as `Query.limit()`, `Query.offset()`, `Query.cursorAfter()`, and `Query.cursorBefore()`. It returns branch names along with the total number of matches. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.\n", "responses": { "200": { "description": "Branches List", @@ -70389,7 +72066,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 562, + "weight": 571, "cookies": false, "type": "", "demo": "vcs\/list-repository-branches.md", @@ -70428,6 +72105,27 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "queries", + "description": "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, offset, cursorAfter, and cursorBefore", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" } ] } @@ -70456,7 +72154,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 563, + "weight": 572, "cookies": false, "type": "", "demo": "vcs\/get-repository-contents.md", @@ -70540,7 +72238,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 1198, + "weight": 1217, "cookies": false, "type": "", "demo": "vcs\/update-external-deployments.md", @@ -70625,7 +72323,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 557, + "weight": 566, "cookies": false, "type": "", "demo": "vcs\/list-installations.md", @@ -70706,7 +72404,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 556, + "weight": 565, "cookies": false, "type": "", "demo": "vcs\/get-installation.md", @@ -70760,7 +72458,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 558, + "weight": 567, "cookies": false, "type": "", "demo": "vcs\/delete-installation.md", @@ -70819,7 +72517,7 @@ "x-appwrite": { "method": "list", "group": "vectorsdb", - "weight": 868, + "weight": 887, "cookies": false, "type": "", "demo": "vectorsdb\/list.md", @@ -70902,7 +72600,7 @@ "x-appwrite": { "method": "create", "group": "vectorsdb", - "weight": 864, + "weight": 883, "cookies": false, "type": "", "demo": "vectorsdb\/create.md", @@ -70988,7 +72686,7 @@ "x-appwrite": { "method": "createTextEmbeddings", "group": "documents", - "weight": 890, + "weight": 909, "cookies": false, "type": "", "demo": "vectorsdb\/create-text-embeddings.md", @@ -71100,7 +72798,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 895, + "weight": 914, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -71168,7 +72866,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 891, + "weight": 910, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -71240,7 +72938,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 892, + "weight": 911, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -71304,7 +73002,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 893, + "weight": 912, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -71384,7 +73082,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 894, + "weight": 913, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -71450,7 +73148,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 896, + "weight": 915, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -71532,7 +73230,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 870, + "weight": 889, "cookies": false, "type": "", "demo": "vectorsdb\/list-usage.md", @@ -71626,7 +73324,7 @@ "x-appwrite": { "method": "get", "group": "vectorsdb", - "weight": 865, + "weight": 884, "cookies": false, "type": "", "demo": "vectorsdb\/get.md", @@ -71687,7 +73385,7 @@ "x-appwrite": { "method": "update", "group": "vectorsdb", - "weight": 866, + "weight": 885, "cookies": false, "type": "", "demo": "vectorsdb\/update.md", @@ -71767,7 +73465,7 @@ "x-appwrite": { "method": "delete", "group": "vectorsdb", - "weight": 867, + "weight": 886, "cookies": false, "type": "", "demo": "vectorsdb\/delete.md", @@ -71828,7 +73526,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 875, + "weight": 894, "cookies": false, "type": "", "demo": "vectorsdb\/list-collections.md", @@ -71919,7 +73617,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 871, + "weight": 890, "cookies": false, "type": "", "demo": "vectorsdb\/create-collection.md", @@ -72034,7 +73732,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 872, + "weight": 891, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection.md", @@ -72103,7 +73801,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 873, + "weight": 892, "cookies": false, "type": "", "demo": "vectorsdb\/update-collection.md", @@ -72213,7 +73911,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 874, + "weight": 893, "cookies": false, "type": "", "demo": "vectorsdb\/delete-collection.md", @@ -72282,7 +73980,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 885, + "weight": 904, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -72393,7 +74091,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 881, + "weight": 900, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -72569,7 +74267,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 888, + "weight": 907, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-documents.md", @@ -72695,7 +74393,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 887, + "weight": 906, "cookies": false, "type": "", "demo": "vectorsdb\/update-documents.md", @@ -72794,7 +74492,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 889, + "weight": 908, "cookies": false, "type": "", "demo": "vectorsdb\/delete-documents.md", @@ -72887,7 +74585,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 884, + "weight": 903, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -72987,7 +74685,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 883, + "weight": 902, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -73129,7 +74827,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 882, + "weight": 901, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -73234,7 +74932,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 886, + "weight": 905, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -73329,7 +75027,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 880, + "weight": 899, "cookies": false, "type": "", "demo": "vectorsdb\/list-indexes.md", @@ -73419,7 +75117,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 877, + "weight": 896, "cookies": false, "type": "", "demo": "vectorsdb\/create-index.md", @@ -73557,7 +75255,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 878, + "weight": 897, "cookies": false, "type": "", "demo": "vectorsdb\/get-index.md", @@ -73628,7 +75326,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 879, + "weight": 898, "cookies": false, "type": "", "demo": "vectorsdb\/delete-index.md", @@ -73704,7 +75402,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 876, + "weight": 895, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection-usage.md", @@ -73791,7 +75489,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 869, + "weight": 888, "cookies": false, "type": "", "demo": "vectorsdb\/get-usage.md", @@ -73896,7 +75594,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 567, + "weight": 576, "cookies": false, "type": "", "demo": "webhooks\/list.md", @@ -73969,7 +75667,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 566, + "weight": 575, "cookies": false, "type": "", "demo": "webhooks\/create.md", @@ -74094,7 +75792,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 568, + "weight": 577, "cookies": false, "type": "", "demo": "webhooks\/get.md", @@ -74154,7 +75852,7 @@ "x-appwrite": { "method": "update", "group": null, - "weight": 570, + "weight": 579, "cookies": false, "type": "", "demo": "webhooks\/update.md", @@ -74268,7 +75966,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 569, + "weight": 578, "cookies": false, "type": "", "demo": "webhooks\/delete.md", @@ -74330,7 +76028,7 @@ "x-appwrite": { "method": "updateSecret", "group": null, - "weight": 571, + "weight": 580, "cookies": false, "type": "", "demo": "webhooks\/update-secret.md", @@ -74455,6 +76153,10 @@ { "name": "messaging", "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." + }, + { + "name": "advisor", + "description": "The Advisor service surfaces actionable reports about your project resources, with CTA descriptors for one-click remediation in the console." } ], "definitions": { @@ -74522,6 +76224,35 @@ "documents": "" } }, + "presenceList": { + "description": "Presences List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of presences that matched your query.", + "x-example": 5, + "format": "int32" + }, + "presences": { + "type": "array", + "description": "List of presences.", + "items": { + "type": "object", + "$ref": "#\/definitions\/presence" + }, + "x-example": "" + } + }, + "required": [ + "total", + "presences" + ], + "example": { + "total": 5, + "presences": "" + } + }, "tableList": { "description": "Tables List", "type": "object", @@ -76143,6 +77874,64 @@ "embeddings": "" } }, + "insightList": { + "description": "Insights List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of insights that matched your query.", + "x-example": 5, + "format": "int32" + }, + "insights": { + "type": "array", + "description": "List of insights.", + "items": { + "type": "object", + "$ref": "#\/definitions\/insight" + }, + "x-example": "" + } + }, + "required": [ + "total", + "insights" + ], + "example": { + "total": 5, + "insights": "" + } + }, + "reportList": { + "description": "Reports List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of reports that matched your query.", + "x-example": 5, + "format": "int32" + }, + "reports": { + "type": "array", + "description": "List of reports.", + "items": { + "type": "object", + "$ref": "#\/definitions\/report" + }, + "x-example": "" + } + }, + "required": [ + "total", + "reports" + ], + "example": { + "total": 5, + "reports": "" + } + }, "database": { "description": "Database", "type": "object", @@ -76188,7 +77977,7 @@ "description": "Database backup policies.", "items": { "type": "object", - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/backupPolicy" }, "x-example": {} }, @@ -76197,7 +77986,7 @@ "description": "Database backup archives.", "items": { "type": "object", - "$ref": "#\/definitions\/collection" + "$ref": "#\/definitions\/backupArchive" }, "x-example": {} } @@ -76331,6 +78120,9 @@ { "$ref": "#\/definitions\/attributeBoolean" }, + { + "$ref": "#\/definitions\/attributeBigint" + }, { "$ref": "#\/definitions\/attributeInteger" }, @@ -76384,6 +78176,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/definitions\/attributeBoolean", + "bigint": "#\/definitions\/attributeBigint", "integer": "#\/definitions\/attributeInteger", "double": "#\/definitions\/attributeFloat", "string": "#\/definitions\/attributeString", @@ -76405,6 +78198,9 @@ "#\/definitions\/attributeBoolean": { "type": "boolean" }, + "#\/definitions\/attributeBigint": { + "type": "bigint" + }, "#\/definitions\/attributeInteger": { "type": "integer" }, @@ -76533,6 +78329,9 @@ { "$ref": "#\/definitions\/attributeBoolean" }, + { + "$ref": "#\/definitions\/attributeBigint" + }, { "$ref": "#\/definitions\/attributeInteger" }, @@ -76586,6 +78385,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/definitions\/attributeBoolean", + "bigint": "#\/definitions\/attributeBigint", "integer": "#\/definitions\/attributeInteger", "double": "#\/definitions\/attributeFloat", "string": "#\/definitions\/attributeString", @@ -76607,6 +78407,9 @@ "#\/definitions\/attributeBoolean": { "type": "boolean" }, + "#\/definitions\/attributeBigint": { + "type": "bigint" + }, "#\/definitions\/attributeInteger": { "type": "integer" }, @@ -76868,6 +78671,104 @@ "default": 10 } }, + "attributeBigint": { + "description": "AttributeBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int64", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "attributeFloat": { "description": "AttributeFloat", "type": "object", @@ -78982,6 +80883,9 @@ { "$ref": "#\/definitions\/columnBoolean" }, + { + "$ref": "#\/definitions\/columnBigint" + }, { "$ref": "#\/definitions\/columnInteger" }, @@ -79035,6 +80939,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/definitions\/columnBoolean", + "bigint": "#\/definitions\/columnBigint", "integer": "#\/definitions\/columnInteger", "double": "#\/definitions\/columnFloat", "string": "#\/definitions\/columnString", @@ -79056,6 +80961,9 @@ "#\/definitions\/columnBoolean": { "type": "boolean" }, + "#\/definitions\/columnBigint": { + "type": "bigint" + }, "#\/definitions\/columnInteger": { "type": "integer" }, @@ -79184,6 +81092,9 @@ { "$ref": "#\/definitions\/columnBoolean" }, + { + "$ref": "#\/definitions\/columnBigint" + }, { "$ref": "#\/definitions\/columnInteger" }, @@ -79237,6 +81148,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/definitions\/columnBoolean", + "bigint": "#\/definitions\/columnBigint", "integer": "#\/definitions\/columnInteger", "double": "#\/definitions\/columnFloat", "string": "#\/definitions\/columnString", @@ -79258,6 +81170,9 @@ "#\/definitions\/columnBoolean": { "type": "boolean" }, + "#\/definitions\/columnBigint": { + "type": "bigint" + }, "#\/definitions\/columnInteger": { "type": "integer" }, @@ -79519,6 +81434,104 @@ "default": 10 } }, + "columnBigint": { + "description": "ColumnBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 10, + "format": "int64", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "columnFloat": { "description": "ColumnFloat", "type": "object", @@ -81265,6 +83278,89 @@ "isAdmin": false } }, + "presence": { + "description": "Presence", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Presence ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "string", + "description": "Presence sequence ID.", + "x-example": "1", + "readOnly": true + }, + "$createdAt": { + "type": "string", + "description": "Presence creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Presence update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Presence permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "674af8f3e12a5f9ac0be" + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "online", + "x-nullable": true + }, + "source": { + "type": "string", + "description": "Presence source.", + "x-example": "HTTP" + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "additionalProperties": true, + "x-additional-properties-key": "metadata", + "required": [ + "$id", + "$sequence", + "$createdAt", + "$updatedAt", + "$permissions", + "userId", + "source" + ], + "example": { + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "userId": "674af8f3e12a5f9ac0be", + "status": "online", + "source": "HTTP", + "expiresAt": "2020-10-15T06:38:00.000+00:00" + } + }, "log": { "description": "Log", "type": "object", @@ -84804,217 +86900,14 @@ "description": "Project name.", "x-example": "New Project" }, - "description": { - "type": "string", - "description": "Project description.", - "x-example": "This is a new project." - }, "teamId": { "type": "string", "description": "Project team ID.", "x-example": "1592981250" }, - "logo": { - "type": "string", - "description": "Project logo file ID.", - "x-example": "5f5c451b403cb" - }, - "url": { - "type": "string", - "description": "Project website URL.", - "x-example": "5f5c451b403cb" - }, - "legalName": { - "type": "string", - "description": "Company legal name.", - "x-example": "Company LTD." - }, - "legalCountry": { - "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", - "x-example": "US" - }, - "legalState": { - "type": "string", - "description": "State name.", - "x-example": "New York" - }, - "legalCity": { - "type": "string", - "description": "City name.", - "x-example": "New York City." - }, - "legalAddress": { - "type": "string", - "description": "Company Address.", - "x-example": "620 Eighth Avenue, New York, NY 10018" - }, - "legalTaxId": { - "type": "string", - "description": "Company Tax ID.", - "x-example": "131102020" - }, - "authDuration": { - "type": "integer", - "description": "Session duration in seconds.", - "x-example": 60, - "format": "int32" - }, - "authLimit": { - "type": "integer", - "description": "Max users allowed. 0 is unlimited.", - "x-example": 100, - "format": "int32" - }, - "authSessionsLimit": { - "type": "integer", - "description": "Max sessions allowed per user. 100 maximum.", - "x-example": 10, - "format": "int32" - }, - "authPasswordHistory": { - "type": "integer", - "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", - "x-example": 5, - "format": "int32" - }, - "authPasswordDictionary": { - "type": "boolean", - "description": "Whether or not to check user's password against most commonly used passwords.", - "x-example": true - }, - "authPersonalDataCheck": { - "type": "boolean", - "description": "Whether or not to check the user password for similarity with their personal data.", - "x-example": true - }, - "authDisposableEmails": { - "type": "boolean", - "description": "Whether or not to disallow disposable email addresses during signup and email updates.", - "x-example": true - }, - "authCanonicalEmails": { - "type": "boolean", - "description": "Whether or not to require canonical email addresses during signup and email updates.", - "x-example": true - }, - "authFreeEmails": { - "type": "boolean", - "description": "Whether or not to disallow free email addresses during signup and email updates.", - "x-example": true - }, - "authMockNumbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs).", - "items": { - "type": "object", - "$ref": "#\/definitions\/mockNumber" - }, - "x-example": [ - {} - ] - }, - "authSessionAlerts": { - "type": "boolean", - "description": "Whether or not to send session alert emails to users.", - "x-example": true - }, - "authMembershipsUserName": { - "type": "boolean", - "description": "Whether or not to show user names in the teams membership response.", - "x-example": true - }, - "authMembershipsUserEmail": { - "type": "boolean", - "description": "Whether or not to show user emails in the teams membership response.", - "x-example": true - }, - "authMembershipsMfa": { - "type": "boolean", - "description": "Whether or not to show user MFA status in the teams membership response.", - "x-example": true - }, - "authMembershipsUserId": { - "type": "boolean", - "description": "Whether or not to show user IDs in the teams membership response.", - "x-example": true - }, - "authMembershipsUserPhone": { - "type": "boolean", - "description": "Whether or not to show user phone numbers in the teams membership response.", - "x-example": true - }, - "authInvalidateSessions": { - "type": "boolean", - "description": "Whether or not all existing sessions should be invalidated on password change", - "x-example": true - }, - "oAuthProviders": { - "type": "array", - "description": "List of Auth Providers.", - "items": { - "type": "object", - "$ref": "#\/definitions\/authProvider" - }, - "x-example": [ - {} - ] - }, - "platforms": { - "type": "array", - "description": "List of Platforms.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/platformWeb" - }, - { - "$ref": "#\/definitions\/platformApple" - }, - { - "$ref": "#\/definitions\/platformAndroid" - }, - { - "$ref": "#\/definitions\/platformWindows" - }, - { - "$ref": "#\/definitions\/platformLinux" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/definitions\/platformWeb", - "apple": "#\/definitions\/platformApple", - "android": "#\/definitions\/platformAndroid", - "windows": "#\/definitions\/platformWindows", - "linux": "#\/definitions\/platformLinux" - } - } - }, - "x-example": {} - }, - "webhooks": { - "type": "array", - "description": "List of Webhooks.", - "items": { - "type": "object", - "$ref": "#\/definitions\/webhook" - }, - "x-example": {} - }, - "keys": { - "type": "array", - "description": "List of API Keys.", - "items": { - "type": "object", - "$ref": "#\/definitions\/key" - }, - "x-example": {} - }, "devKeys": { "type": "array", - "description": "List of dev keys.", + "description": "Deprecated since 1.9.5: List of dev keys.", "items": { "type": "object", "$ref": "#\/definitions\/devKey" @@ -85098,140 +86991,32 @@ "description": "Project status", "x-example": "active" }, - "authEmailPassword": { - "type": "boolean", - "description": "Email\/Password auth method status", - "x-example": true - }, - "authUsersAuthMagicURL": { - "type": "boolean", - "description": "Magic URL auth method status", - "x-example": true - }, - "authEmailOtp": { - "type": "boolean", - "description": "Email (OTP) auth method status", - "x-example": true - }, - "authAnonymous": { - "type": "boolean", - "description": "Anonymous auth method status", - "x-example": true - }, - "authInvites": { - "type": "boolean", - "description": "Invites auth method status", - "x-example": true - }, - "authJWT": { - "type": "boolean", - "description": "JWT auth method status", - "x-example": true - }, - "authPhone": { - "type": "boolean", - "description": "Phone auth method status", - "x-example": true - }, - "serviceStatusForAccount": { - "type": "boolean", - "description": "Account service status", - "x-example": true - }, - "serviceStatusForAvatars": { - "type": "boolean", - "description": "Avatars service status", - "x-example": true - }, - "serviceStatusForDatabases": { - "type": "boolean", - "description": "Databases (legacy) service status", - "x-example": true - }, - "serviceStatusForTablesdb": { - "type": "boolean", - "description": "TablesDB service status", - "x-example": true - }, - "serviceStatusForLocale": { - "type": "boolean", - "description": "Locale service status", - "x-example": true - }, - "serviceStatusForHealth": { - "type": "boolean", - "description": "Health service status", - "x-example": true - }, - "serviceStatusForProject": { - "type": "boolean", - "description": "Project service status", - "x-example": true - }, - "serviceStatusForStorage": { - "type": "boolean", - "description": "Storage service status", - "x-example": true - }, - "serviceStatusForTeams": { - "type": "boolean", - "description": "Teams service status", - "x-example": true - }, - "serviceStatusForUsers": { - "type": "boolean", - "description": "Users service status", - "x-example": true - }, - "serviceStatusForVcs": { - "type": "boolean", - "description": "VCS service status", - "x-example": true - }, - "serviceStatusForSites": { - "type": "boolean", - "description": "Sites service status", - "x-example": true - }, - "serviceStatusForFunctions": { - "type": "boolean", - "description": "Functions service status", - "x-example": true - }, - "serviceStatusForProxy": { - "type": "boolean", - "description": "Proxy service status", - "x-example": true - }, - "serviceStatusForGraphql": { - "type": "boolean", - "description": "GraphQL service status", - "x-example": true - }, - "serviceStatusForMigrations": { - "type": "boolean", - "description": "Migrations service status", - "x-example": true - }, - "serviceStatusForMessaging": { - "type": "boolean", - "description": "Messaging service status", - "x-example": true - }, - "protocolStatusForRest": { - "type": "boolean", - "description": "REST protocol status", - "x-example": true + "authMethods": { + "type": "array", + "description": "List of auth methods.", + "items": { + "type": "object", + "$ref": "#\/definitions\/projectAuthMethod" + }, + "x-example": {} }, - "protocolStatusForGraphql": { - "type": "boolean", - "description": "GraphQL protocol status", - "x-example": true + "services": { + "type": "array", + "description": "List of services.", + "items": { + "type": "object", + "$ref": "#\/definitions\/projectService" + }, + "x-example": {} }, - "protocolStatusForWebsocket": { - "type": "boolean", - "description": "Websocket protocol status", - "x-example": true + "protocols": { + "type": "array", + "description": "List of protocols.", + "items": { + "type": "object", + "$ref": "#\/definitions\/projectProtocol" + }, + "x-example": {} }, "region": { "type": "string", @@ -85267,37 +87052,7 @@ "$createdAt", "$updatedAt", "name", - "description", "teamId", - "logo", - "url", - "legalName", - "legalCountry", - "legalState", - "legalCity", - "legalAddress", - "legalTaxId", - "authDuration", - "authLimit", - "authSessionsLimit", - "authPasswordHistory", - "authPasswordDictionary", - "authPersonalDataCheck", - "authDisposableEmails", - "authCanonicalEmails", - "authFreeEmails", - "authMockNumbers", - "authSessionAlerts", - "authMembershipsUserName", - "authMembershipsUserEmail", - "authMembershipsMfa", - "authMembershipsUserId", - "authMembershipsUserPhone", - "authInvalidateSessions", - "oAuthProviders", - "platforms", - "webhooks", - "keys", "devKeys", "smtpEnabled", "smtpSenderName", @@ -85313,33 +87068,9 @@ "pingedAt", "labels", "status", - "authEmailPassword", - "authUsersAuthMagicURL", - "authEmailOtp", - "authAnonymous", - "authInvites", - "authJWT", - "authPhone", - "serviceStatusForAccount", - "serviceStatusForAvatars", - "serviceStatusForDatabases", - "serviceStatusForTablesdb", - "serviceStatusForLocale", - "serviceStatusForHealth", - "serviceStatusForProject", - "serviceStatusForStorage", - "serviceStatusForTeams", - "serviceStatusForUsers", - "serviceStatusForVcs", - "serviceStatusForSites", - "serviceStatusForFunctions", - "serviceStatusForProxy", - "serviceStatusForGraphql", - "serviceStatusForMigrations", - "serviceStatusForMessaging", - "protocolStatusForRest", - "protocolStatusForGraphql", - "protocolStatusForWebsocket", + "authMethods", + "services", + "protocols", "region", "billingLimits", "blocks", @@ -85350,41 +87081,7 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "New Project", - "description": "This is a new project.", "teamId": "1592981250", - "logo": "5f5c451b403cb", - "url": "5f5c451b403cb", - "legalName": "Company LTD.", - "legalCountry": "US", - "legalState": "New York", - "legalCity": "New York City.", - "legalAddress": "620 Eighth Avenue, New York, NY 10018", - "legalTaxId": "131102020", - "authDuration": 60, - "authLimit": 100, - "authSessionsLimit": 10, - "authPasswordHistory": 5, - "authPasswordDictionary": true, - "authPersonalDataCheck": true, - "authDisposableEmails": true, - "authCanonicalEmails": true, - "authFreeEmails": true, - "authMockNumbers": [ - {} - ], - "authSessionAlerts": true, - "authMembershipsUserName": true, - "authMembershipsUserEmail": true, - "authMembershipsMfa": true, - "authMembershipsUserId": true, - "authMembershipsUserPhone": true, - "authInvalidateSessions": true, - "oAuthProviders": [ - {} - ], - "platforms": {}, - "webhooks": {}, - "keys": {}, "devKeys": {}, "smtpEnabled": false, "smtpSenderName": "John Appwrite", @@ -85402,39 +87099,124 @@ "vip" ], "status": "active", - "authEmailPassword": true, - "authUsersAuthMagicURL": true, - "authEmailOtp": true, - "authAnonymous": true, - "authInvites": true, - "authJWT": true, - "authPhone": true, - "serviceStatusForAccount": true, - "serviceStatusForAvatars": true, - "serviceStatusForDatabases": true, - "serviceStatusForTablesdb": true, - "serviceStatusForLocale": true, - "serviceStatusForHealth": true, - "serviceStatusForProject": true, - "serviceStatusForStorage": true, - "serviceStatusForTeams": true, - "serviceStatusForUsers": true, - "serviceStatusForVcs": true, - "serviceStatusForSites": true, - "serviceStatusForFunctions": true, - "serviceStatusForProxy": true, - "serviceStatusForGraphql": true, - "serviceStatusForMigrations": true, - "serviceStatusForMessaging": true, - "protocolStatusForRest": true, - "protocolStatusForGraphql": true, - "protocolStatusForWebsocket": true, + "authMethods": {}, + "services": {}, + "protocols": {}, "region": "fra", "billingLimits": "", "blocks": "", "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, + "projectAuthMethod": { + "description": "ProjectAuthMethod", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Auth method ID.", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "ProjectAuthMethodId" + }, + "enabled": { + "type": "boolean", + "description": "Auth method status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "email-password", + "enabled": false + } + }, + "projectService": { + "description": "ProjectService", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Service ID.", + "x-example": "sites", + "enum": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging", + "advisor" + ], + "x-enum-name": "ProjectServiceId" + }, + "enabled": { + "type": "boolean", + "description": "Service status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "sites", + "enabled": false + } + }, + "projectProtocol": { + "description": "ProjectProtocol", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Protocol ID.", + "x-example": "graphql", + "enum": [ + "rest", + "graphql", + "websocket" + ], + "x-enum-name": "ProjectProtocolId" + }, + "enabled": { + "type": "boolean", + "description": "Protocol status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "graphql", + "enabled": false + } + }, "webhook": { "description": "Webhook", "type": "object", @@ -86176,19 +87958,38 @@ "type": "string", "description": "Google OAuth2 client secret.", "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" + }, + "prompt": { + "type": "array", + "description": "Google OAuth2 prompt values.", + "items": { + "type": "string", + "enum": [ + "none", + "consent", + "select_account" + ] + }, + "x-example": [ + "consent" + ] } }, "required": [ "$id", "enabled", "clientId", - "clientSecret" + "clientSecret", + "prompt" ], "example": { "$id": "github", "enabled": false, "clientId": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", - "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj" + "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj", + "prompt": [ + "consent" + ] } }, "oAuth2Zoom": { @@ -87217,12 +89018,12 @@ "description": "OpenID Connect authorization endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" }, - "tokenUrl": { + "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/token" }, - "userInfoUrl": { + "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" @@ -87235,8 +89036,8 @@ "clientSecret", "wellKnownURL", "authorizationURL", - "tokenUrl", - "userInfoUrl" + "tokenURL", + "userInfoURL" ], "example": { "$id": "github", @@ -87245,8 +89046,8 @@ "clientSecret": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", "wellKnownURL": "https:\/\/myoauth.com\/.well-known\/openid-configuration", "authorizationURL": "https:\/\/myoauth.com\/oauth2\/authorize", - "tokenUrl": "https:\/\/myoauth.com\/oauth2\/token", - "userInfoUrl": "https:\/\/myoauth.com\/oauth2\/userinfo" + "tokenURL": "https:\/\/myoauth.com\/oauth2\/token", + "userInfoURL": "https:\/\/myoauth.com\/oauth2\/userinfo" } }, "oAuth2Okta": { @@ -87880,51 +89681,6 @@ "userMFA": true } }, - "authProvider": { - "description": "AuthProvider", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Auth Provider.", - "x-example": "github" - }, - "name": { - "type": "string", - "description": "Auth Provider name.", - "x-example": "GitHub" - }, - "appId": { - "type": "string", - "description": "OAuth 2.0 application ID.", - "x-example": "259125845563242502" - }, - "secret": { - "type": "string", - "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Auth Provider is active and can be used to create session.", - "x-example": "" - } - }, - "required": [ - "key", - "name", - "appId", - "secret", - "enabled" - ], - "example": { - "key": "github", - "name": "GitHub", - "appId": "259125845563242502", - "secret": "", - "enabled": "" - } - }, "platformWeb": { "description": "Platform Web", "type": "object", @@ -89198,6 +90954,42 @@ "sessions": [] } }, + "usagePresence": { + "description": "UsagePresence", + "type": "object", + "properties": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "usersOnlineTotal": { + "type": "integer", + "description": "Current total number of online users.", + "x-example": 0, + "format": "int32" + }, + "presences": { + "type": "array", + "description": "Aggregated number of online users per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + } + }, + "required": [ + "range", + "usersOnlineTotal", + "presences" + ], + "example": { + "range": "30d", + "usersOnlineTotal": 0, + "presences": [] + } + }, "usageStorage": { "description": "StorageUsage", "type": "object", @@ -91276,7 +93068,7 @@ }, "deploymentResourceId": { "type": "string", - "description": "ID deployment's resource. Used if type is \"deployment\"", + "description": "ID of deployment's resource (site or function ID). Used if type is \"deployment\"", "x-example": "n3u9feiwmf" }, "deploymentVcsProviderBranch": { @@ -91286,13 +93078,12 @@ }, "status": { "type": "string", - "description": "Domain verification status. Possible values are \"created\", \"verifying\", \"verified\" and \"unverified\"", + "description": "Domain verification status. Possible values are \"unverified\", \"verifying\", \"verified\"", "x-example": "verified", "enum": [ - "created", + "unverified", "verifying", - "verified", - "unverified" + "verified" ] }, "logs": { @@ -92704,6 +94495,12 @@ "type": "string", "description": "Version of the Appwrite instance to be migrated.", "x-example": "1.4.0" + }, + "backup-policy": { + "type": "integer", + "description": "Number of backup policies to be migrated.", + "x-example": 5, + "format": "int32" } }, "required": [ @@ -92720,7 +94517,8 @@ "subscriber", "message", "size", - "version" + "version", + "backup-policy" ], "example": { "user": 20, @@ -92736,7 +94534,303 @@ "subscriber": 100, "message": 50, "size": 30000, - "version": "1.4.0" + "version": "1.4.0", + "backup-policy": 5 + } + }, + "insight": { + "description": "Insight", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Insight ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Insight creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Insight update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "reportId": { + "type": "string", + "description": "Parent report ID. Insights always belong to a report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).", + "x-example": "tablesDBIndex" + }, + "severity": { + "type": "string", + "description": "Insight severity. One of info, warning, critical.", + "x-example": "warning" + }, + "status": { + "type": "string", + "description": "Insight status. One of active, dismissed.", + "x-example": "active" + }, + "resourceType": { + "type": "string", + "description": "Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.", + "x-example": "databases" + }, + "resourceId": { + "type": "string", + "description": "ID of the resource the insight is about.", + "x-example": "main" + }, + "parentResourceType": { + "type": "string", + "description": "Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table \u2192 resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.", + "x-example": "tables" + }, + "parentResourceId": { + "type": "string", + "description": "ID of the parent resource. Empty when the resource has no parent.", + "x-example": "orders" + }, + "title": { + "type": "string", + "description": "Insight title.", + "x-example": "Missing index on collection orders" + }, + "summary": { + "type": "string", + "description": "Short markdown summary describing the insight.", + "x-example": "Queries against `orders.status` are scanning the full collection." + }, + "ctas": { + "type": "array", + "description": "List of call-to-action buttons attached to this insight.", + "items": { + "type": "object", + "$ref": "#\/definitions\/insightCTA" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the insight was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + }, + "dismissedAt": { + "type": "string", + "description": "Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + }, + "dismissedBy": { + "type": "string", + "description": "User ID that dismissed the insight. Empty when not dismissed.", + "x-example": "5e5ea5c16897e", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "reportId", + "type", + "severity", + "status", + "resourceType", + "resourceId", + "parentResourceType", + "parentResourceId", + "title", + "summary", + "ctas" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "reportId": "5e5ea5c16897e", + "type": "tablesDBIndex", + "severity": "warning", + "status": "active", + "resourceType": "databases", + "resourceId": "main", + "parentResourceType": "tables", + "parentResourceId": "orders", + "title": "Missing index on collection orders", + "summary": "Queries against `orders.status` are scanning the full collection.", + "ctas": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedBy": "5e5ea5c16897e" + } + }, + "insightCTA": { + "description": "InsightCTA", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Human-readable label for the CTA, used in UI.", + "x-example": "Create missing index" + }, + "service": { + "type": "string", + "description": "Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource \u2014 for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.", + "x-example": "tablesDB" + }, + "method": { + "type": "string", + "description": "Public API method on the chosen service the client should invoke when this CTA is triggered.", + "x-example": "createIndex" + }, + "params": { + "type": "object", + "additionalProperties": true, + "description": "Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId\/tableId\/columns for tablesDB, databaseId\/collectionId\/attributes for the legacy Databases API).", + "x-example": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "required": [ + "label", + "service", + "method", + "params" + ], + "example": { + "label": "Create missing index", + "service": "tablesDB", + "method": "createIndex", + "params": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "report": { + "description": "Report", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Report ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Report creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Report update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "ID of the third-party app that submitted the report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.", + "x-example": "lighthouse" + }, + "title": { + "type": "string", + "description": "Short, human-readable title for the report.", + "x-example": "Lighthouse audit for https:\/\/appwrite.io\/" + }, + "summary": { + "type": "string", + "description": "Markdown summary describing the report.", + "x-example": "Performance score 78. 4 opportunities found." + }, + "targetType": { + "type": "string", + "description": "Plural noun describing what the report analyzes, e.g. databases, sites, urls.", + "x-example": "urls" + }, + "target": { + "type": "string", + "description": "Free-form target identifier (URL for lighthouse, resource ID for db).", + "x-example": "https:\/\/appwrite.io\/" + }, + "categories": { + "type": "array", + "description": "Categories covered by the report, e.g. performance, accessibility.", + "items": { + "type": "string" + }, + "x-example": [ + "performance", + "accessibility" + ] + }, + "insights": { + "type": "array", + "description": "Insights nested under this report.", + "items": { + "type": "object", + "$ref": "#\/definitions\/insight" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the report was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "type", + "title", + "summary", + "targetType", + "target", + "categories", + "insights" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "type": "lighthouse", + "title": "Lighthouse audit for https:\/\/appwrite.io\/", + "summary": "Performance score 78. 4 opportunities found.", + "targetType": "urls", + "target": "https:\/\/appwrite.io\/", + "categories": [ + "performance", + "accessibility" + ], + "insights": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00" } }, "activityEvent": { @@ -93357,7 +95451,7 @@ }, "status": { "type": "string", - "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed.", + "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.", "x-example": "completed" }, "startedAt": { diff --git a/specs/latest/swagger2-latest-server.json b/specs/latest/swagger2-latest-server.json index cf750058..27fa866e 100644 --- a/specs/latest/swagger2-latest-server.json +++ b/specs/latest/swagger2-latest-server.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.9.3", + "version": "1.9.5", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -658,7 +658,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 166, + "weight": 165, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -734,7 +734,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 168, + "weight": 167, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -861,7 +861,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 169, + "weight": 168, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -1005,7 +1005,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 170, + "weight": 169, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1132,7 +1132,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 174, + "weight": 173, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1272,7 +1272,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 175, + "weight": 174, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1415,7 +1415,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 167, + "weight": 166, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1519,7 +1519,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 173, + "weight": 172, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1623,7 +1623,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 171, + "weight": 170, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1727,7 +1727,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 172, + "weight": 171, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -3953,7 +3953,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 1185, + "weight": 1204, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -4015,7 +4015,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 1186, + "weight": 1205, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -4077,7 +4077,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 177, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4205,7 +4205,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 176, + "weight": 175, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4339,7 +4339,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 180, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4405,7 +4405,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 178, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4895,7 +4895,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 179, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4981,7 +4981,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 182, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5075,7 +5075,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 181, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5169,7 +5169,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 183, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5884,7 +5884,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 1056, + "weight": 1073, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -5950,7 +5950,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 1057, + "weight": 1074, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -6042,7 +6042,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 1055, + "weight": 1072, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -6101,7 +6101,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 1058, + "weight": 1075, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -6163,7 +6163,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 1051, + "weight": 1068, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -6232,7 +6232,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 1052, + "weight": 1069, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -6361,7 +6361,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 1050, + "weight": 1067, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -6426,7 +6426,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 1053, + "weight": 1070, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -6525,7 +6525,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 1054, + "weight": 1071, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -6592,7 +6592,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 1061, + "weight": 1078, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -6696,7 +6696,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 1060, + "weight": 1077, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -6762,7 +6762,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 1059, + "weight": 1076, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -6824,7 +6824,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 687, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6942,7 +6942,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 683, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -7064,7 +7064,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 755, + "weight": 772, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -7133,7 +7133,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 751, + "weight": 768, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -7206,7 +7206,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 752, + "weight": 769, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -7271,7 +7271,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 753, + "weight": 770, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -7352,7 +7352,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 754, + "weight": 771, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -7419,7 +7419,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 756, + "weight": 773, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -7502,7 +7502,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 684, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -7598,7 +7598,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 685, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7712,7 +7712,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 686, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7807,7 +7807,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 695, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7903,7 +7903,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 691, + "weight": 706, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -8034,7 +8034,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 692, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -8108,7 +8108,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 693, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -8220,7 +8220,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 694, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -8294,7 +8294,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 712, + "weight": 727, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -8365,10 +8365,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint": { "post": { - "summary": "Create boolean attribute", - "operationId": "databasesCreateBooleanAttribute", + "summary": "Create bigint attribute", + "operationId": "databasesCreateBigIntAttribute", "consumes": [ "application\/json" ], @@ -8378,23 +8378,23 @@ "tags": [ "databases" ], - "description": "Create a boolean attribute.\n", + "description": "Create a bigint attribute. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "schema": { - "$ref": "#\/definitions\/attributeBoolean" + "$ref": "#\/definitions\/attributeBigint" } } }, "deprecated": true, "x-appwrite": { - "method": "createBooleanAttribute", + "method": "createBigIntAttribute", "group": "attributes", - "weight": 713, + "weight": 740, "cookies": false, "type": "", - "demo": "databases\/create-boolean-attribute.md", + "demo": "databases\/create-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8405,10 +8405,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createBooleanColumn" + "replaceWith": "tablesDB.createBigIntColumn" }, "auth": { "Project": [], @@ -8432,7 +8432,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -8456,11 +8456,28 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", "default": null, - "x-example": false, + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -8479,10 +8496,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint\/{key}": { "patch": { - "summary": "Update boolean attribute", - "operationId": "databasesUpdateBooleanAttribute", + "summary": "Update bigint attribute", + "operationId": "databasesUpdateBigIntAttribute", "consumes": [ "application\/json" ], @@ -8492,23 +8509,23 @@ "tags": [ "databases" ], - "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a bigint attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "schema": { - "$ref": "#\/definitions\/attributeBoolean" + "$ref": "#\/definitions\/attributeBigint" } } }, "deprecated": true, "x-appwrite": { - "method": "updateBooleanAttribute", + "method": "updateBigIntAttribute", "group": "attributes", - "weight": 714, + "weight": 741, "cookies": false, "type": "", - "demo": "databases\/update-boolean-attribute.md", + "demo": "databases\/update-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8519,10 +8536,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateBooleanColumn" + "replaceWith": "tablesDB.updateBigIntColumn" }, "auth": { "Project": [], @@ -8546,7 +8563,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -8571,16 +8588,33 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", "default": null, - "x-example": false, + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null, "x-nullable": true @@ -8595,10 +8629,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { "post": { - "summary": "Create datetime attribute", - "operationId": "databasesCreateDatetimeAttribute", + "summary": "Create boolean attribute", + "operationId": "databasesCreateBooleanAttribute", "consumes": [ "application\/json" ], @@ -8608,23 +8642,23 @@ "tags": [ "databases" ], - "description": "Create a date time attribute according to the ISO 8601 standard.", + "description": "Create a boolean attribute.\n", "responses": { "202": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "schema": { - "$ref": "#\/definitions\/attributeDatetime" + "$ref": "#\/definitions\/attributeBoolean" } } }, "deprecated": true, "x-appwrite": { - "method": "createDatetimeAttribute", + "method": "createBooleanAttribute", "group": "attributes", - "weight": 715, + "weight": 728, "cookies": false, "type": "", - "demo": "databases\/create-datetime-attribute.md", + "demo": "databases\/create-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8635,10 +8669,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createDatetimeColumn" + "replaceWith": "tablesDB.createBooleanColumn" }, "auth": { "Project": [], @@ -8662,7 +8696,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -8687,11 +8721,10 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "x-example": false, "x-nullable": true }, "array": { @@ -8710,10 +8743,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { "patch": { - "summary": "Update datetime attribute", - "operationId": "databasesUpdateDatetimeAttribute", + "summary": "Update boolean attribute", + "operationId": "databasesUpdateBooleanAttribute", "consumes": [ "application\/json" ], @@ -8723,23 +8756,23 @@ "tags": [ "databases" ], - "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "schema": { - "$ref": "#\/definitions\/attributeDatetime" + "$ref": "#\/definitions\/attributeBoolean" } } }, "deprecated": true, "x-appwrite": { - "method": "updateDatetimeAttribute", + "method": "updateBooleanAttribute", "group": "attributes", - "weight": 716, + "weight": 729, "cookies": false, "type": "", - "demo": "databases\/update-datetime-attribute.md", + "demo": "databases\/update-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8750,10 +8783,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateDatetimeColumn" + "replaceWith": "tablesDB.updateBooleanColumn" }, "auth": { "Project": [], @@ -8777,7 +8810,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -8803,11 +8836,10 @@ "x-example": false }, "default": { - "type": "string", + "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "x-example": false, "x-nullable": true }, "newKey": { @@ -8827,10 +8859,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { "post": { - "summary": "Create email attribute", - "operationId": "databasesCreateEmailAttribute", + "summary": "Create datetime attribute", + "operationId": "databasesCreateDatetimeAttribute", "consumes": [ "application\/json" ], @@ -8840,23 +8872,23 @@ "tags": [ "databases" ], - "description": "Create an email attribute.\n", + "description": "Create a date time attribute according to the ISO 8601 standard.", "responses": { "202": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "schema": { - "$ref": "#\/definitions\/attributeEmail" + "$ref": "#\/definitions\/attributeDatetime" } } }, "deprecated": true, "x-appwrite": { - "method": "createEmailAttribute", + "method": "createDatetimeAttribute", "group": "attributes", - "weight": 717, + "weight": 730, "cookies": false, "type": "", - "demo": "databases\/create-email-attribute.md", + "demo": "databases\/create-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8867,10 +8899,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createEmailColumn" + "replaceWith": "tablesDB.createDatetimeColumn" }, "auth": { "Project": [], @@ -8894,7 +8926,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -8920,10 +8952,10 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -8942,10 +8974,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update email attribute", - "operationId": "databasesUpdateEmailAttribute", + "summary": "Update datetime attribute", + "operationId": "databasesUpdateDatetimeAttribute", "consumes": [ "application\/json" ], @@ -8955,23 +8987,23 @@ "tags": [ "databases" ], - "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "schema": { - "$ref": "#\/definitions\/attributeEmail" + "$ref": "#\/definitions\/attributeDatetime" } } }, "deprecated": true, "x-appwrite": { - "method": "updateEmailAttribute", + "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 718, + "weight": 731, "cookies": false, "type": "", - "demo": "databases\/update-email-attribute.md", + "demo": "databases\/update-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8982,10 +9014,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateEmailColumn" + "replaceWith": "tablesDB.updateDatetimeColumn" }, "auth": { "Project": [], @@ -9038,13 +9070,13 @@ "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "newKey": { "type": "string", - "description": "New Attribute Key.", + "description": "New attribute key.", "default": null, "x-example": null, "x-nullable": true @@ -9059,10 +9091,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { "post": { - "summary": "Create enum attribute", - "operationId": "databasesCreateEnumAttribute", + "summary": "Create email attribute", + "operationId": "databasesCreateEmailAttribute", "consumes": [ "application\/json" ], @@ -9072,23 +9104,23 @@ "tags": [ "databases" ], - "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an email attribute.\n", "responses": { "202": { - "description": "AttributeEnum", + "description": "AttributeEmail", "schema": { - "$ref": "#\/definitions\/attributeEnum" + "$ref": "#\/definitions\/attributeEmail" } } }, "deprecated": true, "x-appwrite": { - "method": "createEnumAttribute", + "method": "createEmailAttribute", "group": "attributes", - "weight": 719, + "weight": 732, "cookies": false, "type": "", - "demo": "databases\/create-enum-attribute.md", + "demo": "databases\/create-email-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9099,10 +9131,242 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createEnumColumn" + "replaceWith": "tablesDB.createEmailColumn" + }, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { + "patch": { + "summary": "Update email attribute", + "operationId": "databasesUpdateEmailAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", + "responses": { + "200": { + "description": "AttributeEmail", + "schema": { + "$ref": "#\/definitions\/attributeEmail" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateEmailAttribute", + "group": "attributes", + "weight": 733, + "cookies": false, + "type": "", + "demo": "databases\/update-email-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateEmailColumn" + }, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum": { + "post": { + "summary": "Create enum attribute", + "operationId": "databasesCreateEnumAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "responses": { + "202": { + "description": "AttributeEnum", + "schema": { + "$ref": "#\/definitions\/attributeEnum" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "createEnumAttribute", + "group": "attributes", + "weight": 734, + "cookies": false, + "type": "", + "demo": "databases\/create-enum-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createEnumColumn" }, "auth": { "Project": [], @@ -9209,7 +9473,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 720, + "weight": 735, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -9335,7 +9599,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 721, + "weight": 736, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -9466,7 +9730,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 722, + "weight": 737, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -9599,7 +9863,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 723, + "weight": 738, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9730,7 +9994,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 724, + "weight": 739, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9863,7 +10127,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 725, + "weight": 742, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9977,7 +10241,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 726, + "weight": 743, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -10093,7 +10357,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 727, + "weight": 744, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -10201,7 +10465,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 728, + "weight": 745, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -10316,7 +10580,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 745, + "weight": 762, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -10432,7 +10696,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 746, + "weight": 763, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -10544,7 +10808,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 743, + "weight": 760, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -10660,7 +10924,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 744, + "weight": 761, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -10772,7 +11036,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 729, + "weight": 746, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -10880,7 +11144,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 730, + "weight": 747, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -10995,7 +11259,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 731, + "weight": 748, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -11103,7 +11367,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 732, + "weight": 749, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -11218,7 +11482,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 733, + "weight": 750, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -11360,7 +11624,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 734, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -11472,7 +11736,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 735, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -11600,7 +11864,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 736, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -11724,7 +11988,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 741, + "weight": 758, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -11840,7 +12104,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 742, + "weight": 759, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -11952,7 +12216,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 737, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -12067,7 +12331,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 738, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -12184,7 +12448,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 739, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -12308,7 +12572,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 740, + "weight": 757, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -12508,7 +12772,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 710, + "weight": 725, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -12584,7 +12848,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 711, + "weight": 726, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -12665,7 +12929,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 897, + "weight": 916, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -12781,7 +13045,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 698, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -12976,7 +13240,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 703, + "weight": 718, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -13113,7 +13377,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 701, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -13218,7 +13482,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 705, + "weight": 720, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -13317,7 +13581,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 699, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -13422,7 +13686,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 702, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -13576,7 +13840,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 700, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -13688,7 +13952,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 704, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -13791,7 +14055,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 709, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -13916,7 +14180,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 708, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -14039,7 +14303,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 750, + "weight": 767, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -14134,7 +14398,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 747, + "weight": 764, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -14275,7 +14539,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 748, + "weight": 765, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -14351,7 +14615,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 749, + "weight": 766, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -14432,7 +14696,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 834, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -14516,7 +14780,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 830, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -14601,7 +14865,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 862, + "weight": 881, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -14670,7 +14934,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 858, + "weight": 877, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -14743,7 +15007,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 859, + "weight": 878, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -14808,7 +15072,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 860, + "weight": 879, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -14889,7 +15153,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 861, + "weight": 880, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -14956,7 +15220,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 863, + "weight": 882, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -15038,7 +15302,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 831, + "weight": 850, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -15100,7 +15364,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 832, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -15181,7 +15445,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 833, + "weight": 852, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -15243,7 +15507,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 841, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -15335,7 +15599,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 837, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -15462,7 +15726,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 838, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -15532,7 +15796,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 839, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -15642,7 +15906,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 840, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -15712,7 +15976,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 898, + "weight": 917, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -15824,7 +16088,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 847, + "weight": 866, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -16003,7 +16267,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 852, + "weight": 871, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -16131,7 +16395,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 850, + "weight": 869, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -16231,7 +16495,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 854, + "weight": 873, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -16325,7 +16589,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 848, + "weight": 867, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -16426,7 +16690,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 851, + "weight": 870, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -16570,7 +16834,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 849, + "weight": 868, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -16676,7 +16940,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 853, + "weight": 872, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -16774,7 +17038,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 857, + "weight": 876, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -16893,7 +17157,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 856, + "weight": 875, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -17010,7 +17274,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 846, + "weight": 865, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -17101,7 +17365,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 843, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -17237,7 +17501,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 844, + "weight": 863, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -17309,7 +17573,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 845, + "weight": 864, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -17386,7 +17650,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 416, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -17469,7 +17733,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 900, + "weight": 919, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -17742,6 +18006,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -17754,8 +18020,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -17854,7 +18124,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 418, + "weight": 427, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -17905,7 +18175,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 419, + "weight": 428, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -17956,7 +18226,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 414, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -18017,7 +18287,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 901, + "weight": 920, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -18292,6 +18562,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -18304,8 +18576,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -18398,7 +18674,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 417, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -18461,7 +18737,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 422, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -18540,7 +18816,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 423, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -18631,7 +18907,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 420, + "weight": 429, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -18725,7 +19001,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 428, + "weight": 437, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -18812,7 +19088,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 425, + "weight": 434, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -18934,7 +19210,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 426, + "weight": 435, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -19032,7 +19308,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 421, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -19096,7 +19372,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 424, + "weight": 433, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -19165,7 +19441,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 427, + "weight": 436, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -19252,7 +19528,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 429, + "weight": 438, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -19321,7 +19597,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 432, + "weight": 441, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -19409,7 +19685,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 430, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -19533,7 +19809,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 431, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -19603,7 +19879,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 433, + "weight": 442, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -19675,7 +19951,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 438, + "weight": 447, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -19708,6 +19984,27 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "queries", + "description": "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: key, resourceType, resourceId, secret", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, @@ -19736,7 +20033,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 902, + "weight": 921, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -19776,6 +20073,12 @@ "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -19796,6 +20099,7 @@ } }, "required": [ + "variableId", "key", "value" ] @@ -19828,7 +20132,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 437, + "weight": 446, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -19897,7 +20201,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 439, + "weight": 448, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -19949,7 +20253,8 @@ "type": "string", "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -19965,10 +20270,7 @@ "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } ] @@ -19993,7 +20295,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 440, + "weight": 449, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -20064,7 +20366,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 117, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -20141,7 +20443,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 116, + "weight": 115, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -20216,7 +20518,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 443, + "weight": 452, "cookies": false, "type": "", "demo": "health\/get.md", @@ -20268,7 +20570,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 452, + "weight": 461, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -20320,7 +20622,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 446, + "weight": 455, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -20372,7 +20674,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 449, + "weight": 458, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -20433,7 +20735,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 1044, + "weight": 1061, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -20505,7 +20807,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 445, + "weight": 454, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -20557,7 +20859,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 447, + "weight": 456, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -20609,7 +20911,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 453, + "weight": 462, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -20672,7 +20974,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 1040, + "weight": 1057, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -20735,7 +21037,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 1039, + "weight": 1056, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -20798,7 +21100,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 457, + "weight": 466, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -20861,7 +21163,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 1041, + "weight": 1058, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -20924,7 +21226,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 456, + "weight": 465, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -20987,7 +21289,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 458, + "weight": 467, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -21059,7 +21361,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 459, + "weight": 468, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -21122,7 +21424,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 466, + "weight": 475, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -21210,7 +21512,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 463, + "weight": 472, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -21273,7 +21575,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 455, + "weight": 464, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -21336,7 +21638,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 460, + "weight": 469, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -21399,7 +21701,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 461, + "weight": 470, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -21462,7 +21764,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 462, + "weight": 471, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -21525,7 +21827,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 1042, + "weight": 1059, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -21588,7 +21890,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 464, + "weight": 473, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -21651,7 +21953,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 465, + "weight": 474, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -21714,7 +22016,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 1043, + "weight": 1060, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -21777,7 +22079,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 454, + "weight": 463, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -21840,7 +22142,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 451, + "weight": 460, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -21892,7 +22194,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 450, + "weight": 459, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -21944,7 +22246,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 448, + "weight": 457, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -22436,7 +22738,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 158, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -22522,7 +22824,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 155, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -22684,7 +22986,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 162, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -22853,7 +23155,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 157, + "weight": 156, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -23054,7 +23356,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 164, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -23270,7 +23572,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 156, + "weight": 155, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -23464,7 +23766,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 163, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -23657,7 +23959,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 161, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -23714,7 +24016,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 165, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -23776,7 +24078,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 159, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -23859,7 +24161,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 160, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -23942,7 +24244,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 129, + "weight": 128, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -24028,7 +24330,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 128, + "weight": 127, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -24220,7 +24522,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 142, + "weight": 141, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -24409,7 +24711,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 127, + "weight": 126, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -24570,7 +24872,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 141, + "weight": 140, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -24727,7 +25029,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 118, + "weight": 117, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -24860,7 +25162,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 132, + "weight": 131, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -24990,7 +25292,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 122, + "weight": 121, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -25096,7 +25398,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 136, + "weight": 135, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -25200,7 +25502,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 120, + "weight": 119, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -25320,7 +25622,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 134, + "weight": 133, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -25437,7 +25739,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 119, + "weight": 118, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -25557,7 +25859,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 133, + "weight": 132, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -25674,7 +25976,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 121, + "weight": 120, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -25927,7 +26229,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 135, + "weight": 134, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -26174,7 +26476,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 123, + "weight": 122, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -26281,7 +26583,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 137, + "weight": 136, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -26385,7 +26687,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 124, + "weight": 123, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -26492,7 +26794,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 138, + "weight": 137, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -26596,7 +26898,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 125, + "weight": 124, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -26703,7 +27005,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 139, + "weight": 138, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -26807,7 +27109,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 126, + "weight": 125, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -26914,7 +27216,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 140, + "weight": 139, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -27016,7 +27318,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 131, + "weight": 130, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -27073,7 +27375,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 143, + "weight": 142, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -27135,7 +27437,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 130, + "weight": 129, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -27218,7 +27520,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 152, + "weight": 151, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -27301,7 +27603,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 145, + "weight": 144, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -27385,7 +27687,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 144, + "weight": 143, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -27475,7 +27777,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 147, + "weight": 146, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -27537,7 +27839,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 148, + "weight": 147, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -27620,7 +27922,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 149, + "weight": 148, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -27682,7 +27984,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 146, + "weight": 145, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -27765,7 +28067,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 151, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -27857,7 +28159,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 150, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -27947,7 +28249,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 153, + "weight": 152, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -28012,7 +28314,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 154, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -28061,38 +28363,42 @@ ] } }, - "\/project": { - "delete": { - "summary": "Delete project", - "operationId": "projectDelete", - "consumes": [ + "\/presences": { + "get": { + "summary": "List presences", + "operationId": "presencesList", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "project" + "presences" ], - "description": "Delete a project.", + "description": "List presence logs.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Presences List", + "schema": { + "$ref": "#\/definitions\/presenceList" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": null, - "weight": 1088, + "method": "list", + "group": "presences", + "weight": 419, "cookies": false, "type": "", - "demo": "project\/delete.md", + "demo": "presences\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.read", "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, @@ -28104,15 +28410,112 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" } ] } }, - "\/project\/auth-methods\/{methodId}": { - "patch": { - "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", - "operationId": "projectUpdateAuthMethod", + "\/presences\/{presenceId}": { + "get": { + "summary": "Get presence", + "operationId": "presencesGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "presences" + ], + "description": "Get a presence log by its unique ID.", + "responses": { + "200": { + "description": "Presence", + "schema": { + "$ref": "#\/definitions\/presence" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "presences", + "weight": 418, + "cookies": false, + "type": "", + "demo": "presences\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.read", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Upsert presence", + "operationId": "presencesUpsert", "consumes": [ "application\/json" ], @@ -28120,64 +28523,85 @@ "application\/json" ], "tags": [ - "project" + "presences" ], - "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", + "description": "Create or update a presence log by its unique ID.", "responses": { "200": { - "description": "Project", + "description": "Presence", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/presence" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthMethod", - "group": null, - "weight": 1137, + "method": "upsert", + "group": "presences", + "weight": 416, "cookies": false, "type": "", - "demo": "project\/update-auth-method.md", + "demo": "presences\/upsert.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.write", "platforms": [ - "console", - "server" + "client" ], "packaging": false, "public": true, + "methods": [ + { + "name": "upsert", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "presenceId", + "userId", + "status", + "permissions", + "expiresAt", + "metadata" + ], + "required": [ + "presenceId", + "userId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/presence" + } + ], + "description": "", + "demo": "presences\/upsert.md", + "public": true + } + ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [] } ], "parameters": [ { - "name": "methodId", - "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "name": "presenceId", + "description": "Presence unique ID.", "required": true, "type": "string", - "x-example": "email-password", - "enum": [ - "email-password", - "magic-url", - "email-otp", - "anonymous", - "invites", - "jwt", - "phone" - ], - "x-enum-name": null, - "x-enum-keys": [], + "x-example": "", "in": "path" }, { @@ -28186,25 +28610,54 @@ "schema": { "type": "object", "properties": { - "enabled": { - "type": "boolean", - "description": "Auth method status.", + "userId": { + "type": "string", + "description": "User ID.", "default": null, - "x-example": false + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "default": [], + "x-example": "{}" } }, "required": [ - "enabled" + "status" ] } } ] - } - }, - "\/project\/auth\/canonical-emails": { + }, "patch": { - "summary": "Update project auth canonical emails", - "operationId": "projectUpdateCanonicalEmails", + "summary": "Update presence", + "operationId": "presencesUpdate", "consumes": [ "application\/json" ], @@ -28212,82 +28665,213 @@ "application\/json" ], "tags": [ - "project" + "presences" ], - "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", + "description": "Update a presence log by its unique ID.", "responses": { "200": { - "description": "Project", + "description": "Presence", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/presence" } } }, "deprecated": false, "x-appwrite": { - "method": "updateCanonicalEmails", - "group": "auth", - "weight": 1182, + "method": "update", + "group": "presences", + "weight": 420, "cookies": false, "type": "", - "demo": "project\/update-canonical-emails.md", + "demo": "presences\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "presences.write", "platforms": [ - "console", - "server" + "client" ], "packaging": false, "public": true, + "methods": [ + { + "name": "updatePresence", + "namespace": "presences", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "presenceId", + "userId", + "status", + "expiresAt", + "metadata", + "permissions", + "purge" + ], + "required": [ + "presenceId", + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/presence" + } + ], + "description": "", + "demo": "presences\/update-presence.md", + "public": true + } + ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [] } ], "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to require canonical email addresses during signup and email updates.", + "userId": { + "type": "string", + "description": "User ID.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "Presence status.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry datetime.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "metadata": { + "type": "object", + "description": "Presence metadata object.", + "default": {}, + "x-example": "{}", + "x-nullable": true + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "purge": { + "type": "boolean", + "description": "When true, purge cached responses used by list presences endpoint.", + "default": false, "x-example": false } - }, - "required": [ - "enabled" - ] + } } } ] - } - }, - "\/project\/auth\/disposable-emails": { - "patch": { - "summary": "Update project auth disposable emails", - "operationId": "projectUpdateDisposableEmails", + }, + "delete": { + "summary": "Delete presence", + "operationId": "presencesDelete", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" + "produces": [], + "tags": [ + "presences" + ], + "description": "Delete a presence log by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "presences", + "weight": 421, + "cookies": false, + "type": "", + "demo": "presences\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "presences.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } ], + "parameters": [ + { + "name": "presenceId", + "description": "Presence unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/project": { + "get": { + "summary": "Get project", + "operationId": "projectGet", + "consumes": [], + "produces": [], "tags": [ "project" ], - "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", + "description": "Get a project.", "responses": { "200": { "description": "Project", @@ -28298,16 +28882,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDisposableEmails", - "group": "auth", - "weight": 1183, + "method": "get", + "group": null, + "weight": 1107, "cookies": false, "type": "", - "demo": "project\/update-disposable-emails.md", + "demo": "project\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "project.read", "platforms": [ "console", "server" @@ -28324,33 +28908,59 @@ "Project": [], "Key": [] } + ] + }, + "delete": { + "summary": "Delete project", + "operationId": "projectDelete", + "consumes": [ + "application\/json" ], - "parameters": [ + "produces": [], + "tags": [ + "project" + ], + "description": "Delete a project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 1106, + "cookies": false, + "type": "", + "demo": "project\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to block disposable email addresses during signup and email updates.", - "default": null, - "x-example": false - } - }, - "required": [ - "enabled" - ] - } + "Project": [], + "Key": [] } ] } }, - "\/project\/auth\/free-emails": { + "\/project\/auth-methods\/{methodId}": { "patch": { - "summary": "Update project auth free emails", - "operationId": "projectUpdateFreeEmails", + "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", + "operationId": "projectUpdateAuthMethod", "consumes": [ "application\/json" ], @@ -28360,7 +28970,7 @@ "tags": [ "project" ], - "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", + "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", "responses": { "200": { "description": "Project", @@ -28371,12 +28981,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateFreeEmails", - "group": "auth", - "weight": 1184, + "method": "updateAuthMethod", + "group": null, + "weight": 1156, "cookies": false, "type": "", - "demo": "project\/update-free-emails.md", + "demo": "project\/update-auth-method.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -28399,6 +29009,25 @@ } ], "parameters": [ + { + "name": "methodId", + "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "required": true, + "type": "string", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "ProjectAuthMethodId", + "x-enum-keys": [], + "in": "path" + }, { "name": "payload", "in": "body", @@ -28407,7 +29036,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Set whether or not to block free email addresses during signup and email updates.", + "description": "Auth method status.", "default": null, "x-example": false } @@ -28444,7 +29073,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1104, + "weight": 1123, "cookies": false, "type": "", "demo": "project\/list-keys.md", @@ -28518,7 +29147,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1102, + "weight": 1121, "cookies": false, "type": "", "demo": "project\/create-key.md", @@ -28634,6 +29263,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -28646,8 +29277,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -28658,7 +29293,7 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, @@ -28707,7 +29342,7 @@ "x-appwrite": { "method": "createEphemeralKey", "group": "keys", - "weight": 1103, + "weight": 1122, "cookies": false, "type": "", "demo": "project\/create-ephemeral-key.md", @@ -28811,6 +29446,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -28823,8 +29460,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -28835,7 +29476,7 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, @@ -28843,7 +29484,7 @@ "type": "integer", "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", "default": null, - "x-example": 1, + "x-example": "600", "format": "int32" } }, @@ -28880,7 +29521,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1105, + "weight": 1124, "cookies": false, "type": "", "demo": "project\/get-key.md", @@ -28941,7 +29582,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1107, + "weight": 1126, "cookies": false, "type": "", "demo": "project\/update-key.md", @@ -29059,6 +29700,8 @@ "targets.write", "messages.read", "messages.write", + "rules.read", + "rules.write", "webhooks.read", "webhooks.write", "locale.read", @@ -29071,8 +29714,12 @@ "schedules.write", "vcs.read", "vcs.write", - "rules.read", - "rules.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", "backups.policies.read", "backups.policies.write", "archives.read", @@ -29083,7 +29730,7 @@ "domains.write", "events.read" ], - "x-enum-name": null, + "x-enum-name": "ProjectKeyScopes", "x-enum-keys": [] } }, @@ -29124,7 +29771,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1106, + "weight": 1125, "cookies": false, "type": "", "demo": "project\/delete-key.md", @@ -29187,7 +29834,7 @@ "x-appwrite": { "method": "updateLabels", "group": null, - "weight": 1089, + "weight": 1108, "cookies": false, "type": "", "demo": "project\/update-labels.md", @@ -29261,7 +29908,7 @@ "x-appwrite": { "method": "listMockPhones", "group": "mocks", - "weight": 1122, + "weight": 1141, "cookies": false, "type": "", "demo": "project\/list-mock-phones.md", @@ -29335,7 +29982,7 @@ "x-appwrite": { "method": "createMockPhone", "group": "mocks", - "weight": 1121, + "weight": 1140, "cookies": false, "type": "", "demo": "project\/create-mock-phone.md", @@ -29414,7 +30061,7 @@ "x-appwrite": { "method": "getMockPhone", "group": "mocks", - "weight": 1123, + "weight": 1142, "cookies": false, "type": "", "demo": "project\/get-mock-phone.md", @@ -29476,7 +30123,7 @@ "x-appwrite": { "method": "updateMockPhone", "group": "mocks", - "weight": 1124, + "weight": 1143, "cookies": false, "type": "", "demo": "project\/update-mock-phone.md", @@ -29551,7 +30198,7 @@ "x-appwrite": { "method": "deleteMockPhone", "group": "mocks", - "weight": 1125, + "weight": 1144, "cookies": false, "type": "", "demo": "project\/delete-mock-phone.md", @@ -29613,7 +30260,7 @@ "x-appwrite": { "method": "listOAuth2Providers", "group": "oauth2", - "weight": 1138, + "weight": 1157, "cookies": false, "type": "", "demo": "project\/list-o-auth-2-providers.md", @@ -29637,6 +30284,29 @@ "Project": [], "Key": [] } + ], + "parameters": [ + { + "name": "queries", + "description": "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", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } ] } }, @@ -29666,7 +30336,7 @@ "x-appwrite": { "method": "updateOAuth2Amazon", "group": "oauth2", - "weight": 1165, + "weight": 1184, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-amazon.md", @@ -29751,7 +30421,7 @@ "x-appwrite": { "method": "updateOAuth2Apple", "group": "oauth2", - "weight": 1180, + "weight": 1199, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-apple.md", @@ -29850,7 +30520,7 @@ "x-appwrite": { "method": "updateOAuth2Auth0", "group": "oauth2", - "weight": 1174, + "weight": 1193, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-auth-0.md", @@ -29942,7 +30612,7 @@ "x-appwrite": { "method": "updateOAuth2Authentik", "group": "oauth2", - "weight": 1173, + "weight": 1192, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-authentik.md", @@ -30034,7 +30704,7 @@ "x-appwrite": { "method": "updateOAuth2Autodesk", "group": "oauth2", - "weight": 1148, + "weight": 1167, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-autodesk.md", @@ -30119,7 +30789,7 @@ "x-appwrite": { "method": "updateOAuth2Bitbucket", "group": "oauth2", - "weight": 1145, + "weight": 1164, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-bitbucket.md", @@ -30204,7 +30874,7 @@ "x-appwrite": { "method": "updateOAuth2Bitly", "group": "oauth2", - "weight": 1146, + "weight": 1165, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-bitly.md", @@ -30289,7 +30959,7 @@ "x-appwrite": { "method": "updateOAuth2Box", "group": "oauth2", - "weight": 1147, + "weight": 1166, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-box.md", @@ -30374,7 +31044,7 @@ "x-appwrite": { "method": "updateOAuth2Dailymotion", "group": "oauth2", - "weight": 1144, + "weight": 1163, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-dailymotion.md", @@ -30459,7 +31129,7 @@ "x-appwrite": { "method": "updateOAuth2Discord", "group": "oauth2", - "weight": 1141, + "weight": 1160, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-discord.md", @@ -30544,7 +31214,7 @@ "x-appwrite": { "method": "updateOAuth2Disqus", "group": "oauth2", - "weight": 1164, + "weight": 1183, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-disqus.md", @@ -30629,7 +31299,7 @@ "x-appwrite": { "method": "updateOAuth2Dropbox", "group": "oauth2", - "weight": 1143, + "weight": 1162, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-dropbox.md", @@ -30714,7 +31384,7 @@ "x-appwrite": { "method": "updateOAuth2Etsy", "group": "oauth2", - "weight": 1166, + "weight": 1185, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-etsy.md", @@ -30799,7 +31469,7 @@ "x-appwrite": { "method": "updateOAuth2Facebook", "group": "oauth2", - "weight": 1167, + "weight": 1186, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-facebook.md", @@ -30884,7 +31554,7 @@ "x-appwrite": { "method": "updateOAuth2Figma", "group": "oauth2", - "weight": 1142, + "weight": 1161, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-figma.md", @@ -30969,7 +31639,7 @@ "x-appwrite": { "method": "updateOAuth2FusionAuth", "group": "oauth2", - "weight": 1175, + "weight": 1194, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-fusion-auth.md", @@ -31061,7 +31731,7 @@ "x-appwrite": { "method": "updateOAuth2GitHub", "group": "oauth2", - "weight": 1140, + "weight": 1159, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-git-hub.md", @@ -31146,7 +31816,7 @@ "x-appwrite": { "method": "updateOAuth2Gitlab", "group": "oauth2", - "weight": 1172, + "weight": 1191, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-gitlab.md", @@ -31239,7 +31909,7 @@ "x-appwrite": { "method": "updateOAuth2Google", "group": "oauth2", - "weight": 1149, + "weight": 1168, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-google.md", @@ -31285,6 +31955,23 @@ "x-example": "", "x-nullable": true }, + "prompt": { + "type": "array", + "description": "Array of Google OAuth2 prompt values. If \"none\" is included, it must be the only element. \"none\" means: don't display any authentication or consent screens. Must not be specified with other values. \"consent\" means: prompt the user for consent. \"select_account\" means: prompt the user to select an account.", + "default": null, + "x-example": null, + "x-nullable": true, + "items": { + "type": "string", + "enum": [ + "none", + "consent", + "select_account" + ], + "x-enum-name": "ProjectOAuth2GooglePrompt", + "x-enum-keys": [] + } + }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", @@ -31324,7 +32011,7 @@ "x-appwrite": { "method": "updateOAuth2Keycloak", "group": "oauth2", - "weight": 1176, + "weight": 1195, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-keycloak.md", @@ -31423,7 +32110,7 @@ "x-appwrite": { "method": "updateOAuth2Kick", "group": "oauth2", - "weight": 1179, + "weight": 1198, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-kick.md", @@ -31508,7 +32195,7 @@ "x-appwrite": { "method": "updateOAuth2Linkedin", "group": "oauth2", - "weight": 1163, + "weight": 1182, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-linkedin.md", @@ -31593,7 +32280,7 @@ "x-appwrite": { "method": "updateOAuth2Microsoft", "group": "oauth2", - "weight": 1181, + "weight": 1200, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-microsoft.md", @@ -31685,7 +32372,7 @@ "x-appwrite": { "method": "updateOAuth2Notion", "group": "oauth2", - "weight": 1160, + "weight": 1179, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-notion.md", @@ -31770,7 +32457,7 @@ "x-appwrite": { "method": "updateOAuth2Oidc", "group": "oauth2", - "weight": 1177, + "weight": 1196, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-oidc.md", @@ -31832,7 +32519,7 @@ "format": "url", "x-nullable": true }, - "tokenUrl": { + "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", "default": null, @@ -31840,7 +32527,7 @@ "format": "url", "x-nullable": true }, - "userInfoUrl": { + "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", "default": null, @@ -31887,7 +32574,7 @@ "x-appwrite": { "method": "updateOAuth2Okta", "group": "oauth2", - "weight": 1178, + "weight": 1197, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-okta.md", @@ -31986,7 +32673,7 @@ "x-appwrite": { "method": "updateOAuth2Paypal", "group": "oauth2", - "weight": 1170, + "weight": 1189, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-paypal.md", @@ -32071,7 +32758,7 @@ "x-appwrite": { "method": "updateOAuth2PaypalSandbox", "group": "oauth2", - "weight": 1171, + "weight": 1190, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-paypal-sandbox.md", @@ -32156,7 +32843,7 @@ "x-appwrite": { "method": "updateOAuth2Podio", "group": "oauth2", - "weight": 1159, + "weight": 1178, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-podio.md", @@ -32241,7 +32928,7 @@ "x-appwrite": { "method": "updateOAuth2Salesforce", "group": "oauth2", - "weight": 1161, + "weight": 1180, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-salesforce.md", @@ -32326,7 +33013,7 @@ "x-appwrite": { "method": "updateOAuth2Slack", "group": "oauth2", - "weight": 1158, + "weight": 1177, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-slack.md", @@ -32411,7 +33098,7 @@ "x-appwrite": { "method": "updateOAuth2Spotify", "group": "oauth2", - "weight": 1157, + "weight": 1176, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-spotify.md", @@ -32496,7 +33183,7 @@ "x-appwrite": { "method": "updateOAuth2Stripe", "group": "oauth2", - "weight": 1156, + "weight": 1175, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-stripe.md", @@ -32581,7 +33268,7 @@ "x-appwrite": { "method": "updateOAuth2Tradeshift", "group": "oauth2", - "weight": 1168, + "weight": 1187, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-tradeshift.md", @@ -32666,7 +33353,7 @@ "x-appwrite": { "method": "updateOAuth2TradeshiftSandbox", "group": "oauth2", - "weight": 1169, + "weight": 1188, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-tradeshift-sandbox.md", @@ -32751,7 +33438,7 @@ "x-appwrite": { "method": "updateOAuth2Twitch", "group": "oauth2", - "weight": 1155, + "weight": 1174, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-twitch.md", @@ -32836,7 +33523,7 @@ "x-appwrite": { "method": "updateOAuth2WordPress", "group": "oauth2", - "weight": 1154, + "weight": 1173, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-word-press.md", @@ -32921,7 +33608,7 @@ "x-appwrite": { "method": "updateOAuth2X", "group": "oauth2", - "weight": 1153, + "weight": 1172, "cookies": false, "type": "", "demo": "project\/update-o-auth-2x.md", @@ -33006,7 +33693,7 @@ "x-appwrite": { "method": "updateOAuth2Yahoo", "group": "oauth2", - "weight": 1162, + "weight": 1181, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-yahoo.md", @@ -33091,7 +33778,7 @@ "x-appwrite": { "method": "updateOAuth2Yandex", "group": "oauth2", - "weight": 1152, + "weight": 1171, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-yandex.md", @@ -33176,7 +33863,7 @@ "x-appwrite": { "method": "updateOAuth2Zoho", "group": "oauth2", - "weight": 1151, + "weight": 1170, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-zoho.md", @@ -33261,7 +33948,7 @@ "x-appwrite": { "method": "updateOAuth2Zoom", "group": "oauth2", - "weight": 1150, + "weight": 1169, "cookies": false, "type": "", "demo": "project\/update-o-auth-2-zoom.md", @@ -33320,7 +34007,7 @@ ] } }, - "\/project\/oauth2\/{provider}": { + "\/project\/oauth2\/{providerId}": { "get": { "summary": "Get project OAuth2 provider", "operationId": "projectGetOAuth2Provider", @@ -33512,7 +34199,7 @@ "x-appwrite": { "method": "getOAuth2Provider", "group": "oauth2", - "weight": 1139, + "weight": 1158, "cookies": false, "type": "", "demo": "project\/get-o-auth-2-provider.md", @@ -33539,11 +34226,60 @@ ], "parameters": [ { - "name": "provider", + "name": "providerId", "description": "OAuth2 provider key. For example: github, google, apple.", "required": true, "type": "string", - "x-example": "", + "x-example": "amazon", + "enum": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom", + "githubImagine", + "googleImagine" + ], + "x-enum-name": "ProjectOAuthProviderId", + "x-enum-keys": [], "in": "path" } ] @@ -33573,7 +34309,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 1120, + "weight": 1139, "cookies": false, "type": "", "demo": "project\/list-platforms.md", @@ -33649,7 +34385,7 @@ "x-appwrite": { "method": "createAndroidPlatform", "group": "platforms", - "weight": 1116, + "weight": 1135, "cookies": false, "type": "", "demo": "project\/create-android-platform.md", @@ -33736,7 +34472,7 @@ "x-appwrite": { "method": "updateAndroidPlatform", "group": "platforms", - "weight": 1111, + "weight": 1130, "cookies": false, "type": "", "demo": "project\/update-android-platform.md", @@ -33824,7 +34560,7 @@ "x-appwrite": { "method": "createApplePlatform", "group": "platforms", - "weight": 1115, + "weight": 1134, "cookies": false, "type": "", "demo": "project\/create-apple-platform.md", @@ -33911,7 +34647,7 @@ "x-appwrite": { "method": "updateApplePlatform", "group": "platforms", - "weight": 1110, + "weight": 1129, "cookies": false, "type": "", "demo": "project\/update-apple-platform.md", @@ -33999,7 +34735,7 @@ "x-appwrite": { "method": "createLinuxPlatform", "group": "platforms", - "weight": 1118, + "weight": 1137, "cookies": false, "type": "", "demo": "project\/create-linux-platform.md", @@ -34086,7 +34822,7 @@ "x-appwrite": { "method": "updateLinuxPlatform", "group": "platforms", - "weight": 1113, + "weight": 1132, "cookies": false, "type": "", "demo": "project\/update-linux-platform.md", @@ -34174,7 +34910,7 @@ "x-appwrite": { "method": "createWebPlatform", "group": "platforms", - "weight": 1114, + "weight": 1133, "cookies": false, "type": "", "demo": "project\/create-web-platform.md", @@ -34261,7 +34997,7 @@ "x-appwrite": { "method": "updateWebPlatform", "group": "platforms", - "weight": 1109, + "weight": 1128, "cookies": false, "type": "", "demo": "project\/update-web-platform.md", @@ -34349,7 +35085,7 @@ "x-appwrite": { "method": "createWindowsPlatform", "group": "platforms", - "weight": 1117, + "weight": 1136, "cookies": false, "type": "", "demo": "project\/create-windows-platform.md", @@ -34436,7 +35172,7 @@ "x-appwrite": { "method": "updateWindowsPlatform", "group": "platforms", - "weight": 1112, + "weight": 1131, "cookies": false, "type": "", "demo": "project\/update-windows-platform.md", @@ -34548,7 +35284,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 1119, + "weight": 1138, "cookies": false, "type": "", "demo": "project\/get-platform.md", @@ -34604,7 +35340,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 1108, + "weight": 1127, "cookies": false, "type": "", "demo": "project\/delete-platform.md", @@ -34665,7 +35401,7 @@ "x-appwrite": { "method": "listPolicies", "group": "policies", - "weight": 1126, + "weight": 1145, "cookies": false, "type": "", "demo": "project\/list-policies.md", @@ -34718,10 +35454,10 @@ ] } }, - "\/project\/policies\/membership-privacy": { + "\/project\/policies\/deny-aliased-email": { "patch": { - "summary": "Update membership privacy policy", - "operationId": "projectUpdateMembershipPrivacyPolicy", + "summary": "Update deny aliased email policy", + "operationId": "projectUpdateDenyAliasedEmailPolicy", "consumes": [ "application\/json" ], @@ -34731,7 +35467,7 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", + "description": "Configures if aliased emails such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.", "responses": { "200": { "description": "Project", @@ -34742,12 +35478,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipPrivacyPolicy", + "method": "updateDenyAliasedEmailPolicy", "group": "policies", - "weight": 1128, + "weight": 1201, "cookies": false, "type": "", - "demo": "project\/update-membership-privacy-policy.md", + "demo": "project\/update-deny-aliased-email-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34779,46 +35515,25 @@ "schema": { "type": "object", "properties": { - "userId": { - "type": "boolean", - "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", - "default": null, - "x-example": false - }, - "userEmail": { - "type": "boolean", - "description": "Set to true if you want make user email visible to all team members, or false to hide it.", - "default": null, - "x-example": false - }, - "userPhone": { - "type": "boolean", - "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", - "default": null, - "x-example": false - }, - "userName": { - "type": "boolean", - "description": "Set to true if you want make user name visible to all team members, or false to hide it.", - "default": null, - "x-example": false - }, - "userMFA": { + "enabled": { "type": "boolean", - "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "description": "Set whether or not to block aliased emails during signup and email updates.", "default": null, "x-example": false } - } + }, + "required": [ + "enabled" + ] } } ] } }, - "\/project\/policies\/password-dictionary": { + "\/project\/policies\/deny-disposable-email": { "patch": { - "summary": "Update password dictionary policy", - "operationId": "projectUpdatePasswordDictionaryPolicy", + "summary": "Update deny disposable email policy", + "operationId": "projectUpdateDenyDisposableEmailPolicy", "consumes": [ "application\/json" ], @@ -34828,7 +35543,7 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "description": "Configures if disposable emails from known temporary domains are denied during new users sign-ups and email updates.", "responses": { "200": { "description": "Project", @@ -34839,12 +35554,261 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordDictionaryPolicy", + "method": "updateDenyDisposableEmailPolicy", "group": "policies", - "weight": 1129, + "weight": 1202, "cookies": false, "type": "", - "demo": "project\/update-password-dictionary-policy.md", + "demo": "project\/update-deny-disposable-email-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/project\/policies\/deny-free-email": { + "patch": { + "summary": "Update deny free email policy", + "operationId": "projectUpdateDenyFreeEmailPolicy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Configures if emails from free providers such as Gmail or Yahoo are denied during new users sign-ups and email updates.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDenyFreeEmailPolicy", + "group": "policies", + "weight": 1203, + "cookies": false, + "type": "", + "demo": "project\/update-deny-free-email-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block free email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/project\/policies\/membership-privacy": { + "patch": { + "summary": "Update membership privacy policy", + "operationId": "projectUpdateMembershipPrivacyPolicy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateMembershipPrivacyPolicy", + "group": "policies", + "weight": 1147, + "cookies": false, + "type": "", + "demo": "project\/update-membership-privacy-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "boolean", + "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", + "default": null, + "x-example": false + }, + "userEmail": { + "type": "boolean", + "description": "Set to true if you want make user email visible to all team members, or false to hide it.", + "default": null, + "x-example": false + }, + "userPhone": { + "type": "boolean", + "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", + "default": null, + "x-example": false + }, + "userName": { + "type": "boolean", + "description": "Set to true if you want make user name visible to all team members, or false to hide it.", + "default": null, + "x-example": false + }, + "userMFA": { + "type": "boolean", + "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "default": null, + "x-example": false + } + } + } + } + ] + } + }, + "\/project\/policies\/password-dictionary": { + "patch": { + "summary": "Update password dictionary policy", + "operationId": "projectUpdatePasswordDictionaryPolicy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePasswordDictionaryPolicy", + "group": "policies", + "weight": 1148, + "cookies": false, + "type": "", + "demo": "project\/update-password-dictionary-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34917,7 +35881,7 @@ "x-appwrite": { "method": "updatePasswordHistoryPolicy", "group": "policies", - "weight": 1130, + "weight": 1149, "cookies": false, "type": "", "demo": "project\/update-password-history-policy.md", @@ -34995,7 +35959,7 @@ "x-appwrite": { "method": "updatePasswordPersonalDataPolicy", "group": "policies", - "weight": 1131, + "weight": 1150, "cookies": false, "type": "", "demo": "project\/update-password-personal-data-policy.md", @@ -35071,7 +36035,7 @@ "x-appwrite": { "method": "updateSessionAlertPolicy", "group": "policies", - "weight": 1132, + "weight": 1151, "cookies": false, "type": "", "demo": "project\/update-session-alert-policy.md", @@ -35147,7 +36111,7 @@ "x-appwrite": { "method": "updateSessionDurationPolicy", "group": "policies", - "weight": 1133, + "weight": 1152, "cookies": false, "type": "", "demo": "project\/update-session-duration-policy.md", @@ -35224,7 +36188,7 @@ "x-appwrite": { "method": "updateSessionInvalidationPolicy", "group": "policies", - "weight": 1134, + "weight": 1153, "cookies": false, "type": "", "demo": "project\/update-session-invalidation-policy.md", @@ -35300,7 +36264,7 @@ "x-appwrite": { "method": "updateSessionLimitPolicy", "group": "policies", - "weight": 1135, + "weight": 1154, "cookies": false, "type": "", "demo": "project\/update-session-limit-policy.md", @@ -35378,7 +36342,7 @@ "x-appwrite": { "method": "updateUserLimitPolicy", "group": "policies", - "weight": 1136, + "weight": 1155, "cookies": false, "type": "", "demo": "project\/update-user-limit-policy.md", @@ -35496,7 +36460,7 @@ "x-appwrite": { "method": "getPolicy", "group": "policies", - "weight": 1127, + "weight": 1146, "cookies": false, "type": "", "demo": "project\/get-policy.md", @@ -35542,7 +36506,7 @@ "user-limit", "membership-privacy" ], - "x-enum-name": null, + "x-enum-name": "ProjectPolicyId", "x-enum-keys": [], "in": "path" } @@ -35575,7 +36539,7 @@ "x-appwrite": { "method": "updateProtocol", "group": null, - "weight": 1090, + "weight": 1109, "cookies": false, "type": "", "demo": "project\/update-protocol.md", @@ -35612,7 +36576,7 @@ "graphql", "websocket" ], - "x-enum-name": null, + "x-enum-name": "ProjectProtocolId", "x-enum-keys": [], "in": "path" }, @@ -35663,7 +36627,7 @@ "x-appwrite": { "method": "updateService", "group": null, - "weight": 1091, + "weight": 1110, "cookies": false, "type": "", "demo": "project\/update-service.md", @@ -35691,7 +36655,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "type": "string", "x-example": "account", @@ -35712,9 +36676,10 @@ "proxy", "graphql", "migrations", - "messaging" + "messaging", + "advisor" ], - "x-enum-name": null, + "x-enum-name": "ProjectServiceId", "x-enum-keys": [], "in": "path" }, @@ -35765,7 +36730,7 @@ "x-appwrite": { "method": "updateSMTP", "group": "smtp", - "weight": 1092, + "weight": 1111, "cookies": false, "type": "", "demo": "project\/update-smtp.md", @@ -35865,7 +36830,7 @@ "tls", "ssl" ], - "x-enum-name": null, + "x-enum-name": "ProjectSMTPSecure", "x-enum-keys": [], "x-nullable": true }, @@ -35903,7 +36868,7 @@ "x-appwrite": { "method": "createSMTPTest", "group": "smtp", - "weight": 1093, + "weight": 1112, "cookies": false, "type": "", "demo": "project\/create-smtp-test.md", @@ -35977,7 +36942,7 @@ "x-appwrite": { "method": "listEmailTemplates", "group": "templates", - "weight": 1094, + "weight": 1113, "cookies": false, "type": "", "demo": "project\/list-email-templates.md", @@ -36051,7 +37016,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 1096, + "weight": 1115, "cookies": false, "type": "", "demo": "project\/update-email-template.md", @@ -36097,7 +37062,7 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "EmailTemplateType", + "x-enum-name": "ProjectEmailTemplateId", "x-enum-keys": [] }, "locale": { @@ -36238,7 +37203,7 @@ "zh-tw", "zu" ], - "x-enum-name": "EmailTemplateLocale", + "x-enum-name": "ProjectEmailTemplateLocale", "x-enum-keys": [] }, "subject": { @@ -36318,7 +37283,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 1095, + "weight": 1114, "cookies": false, "type": "", "demo": "project\/get-email-template.md", @@ -36359,7 +37324,7 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "EmailTemplateType", + "x-enum-name": "ProjectEmailTemplateId", "x-enum-keys": [], "in": "path" }, @@ -36502,7 +37467,7 @@ "zh-tw", "zu" ], - "x-enum-name": "EmailTemplateLocale", + "x-enum-name": "ProjectEmailTemplateLocale", "x-enum-keys": [], "default": "", "in": "query" @@ -36534,7 +37499,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 1098, + "weight": 1117, "cookies": false, "type": "", "demo": "project\/list-variables.md", @@ -36608,7 +37573,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 1097, + "weight": 1116, "cookies": false, "type": "", "demo": "project\/create-variable.md", @@ -36642,7 +37607,7 @@ "properties": { "variableId": { "type": "string", - "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, "x-example": "" }, @@ -36699,7 +37664,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 1099, + "weight": 1118, "cookies": false, "type": "", "demo": "project\/get-variable.md", @@ -36727,7 +37692,7 @@ "parameters": [ { "name": "variableId", - "description": "Variable ID.", + "description": "Variable unique ID.", "required": true, "type": "string", "x-example": "", @@ -36760,7 +37725,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 1101, + "weight": 1120, "cookies": false, "type": "", "demo": "project\/update-variable.md", @@ -36788,7 +37753,7 @@ "parameters": [ { "name": "variableId", - "description": "Variable ID.", + "description": "Variable unique ID.", "required": true, "type": "string", "x-example": "", @@ -36846,7 +37811,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 1100, + "weight": 1119, "cookies": false, "type": "", "demo": "project\/delete-variable.md", @@ -36874,7 +37839,7 @@ "parameters": [ { "name": "variableId", - "description": "Variable ID.", + "description": "Variable unique ID.", "required": true, "type": "string", "x-example": "", @@ -36883,6 +37848,988 @@ ] } }, + "\/proxy\/rules": { + "get": { + "summary": "List rules", + "operationId": "proxyListRules", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "proxy" + ], + "description": "Get a list of all the proxy rules. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rule List", + "schema": { + "$ref": "#\/definitions\/proxyRuleList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listRules", + "group": "rules", + "weight": 1213, + "cookies": false, + "type": "", + "demo": "proxy\/list-rules.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/proxy\/rules\/api": { + "post": { + "summary": "Create API rule", + "operationId": "proxyCreateAPIRule", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "proxy" + ], + "description": "Create a new proxy rule for serving Appwrite's API on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", + "responses": { + "201": { + "description": "Rule", + "schema": { + "$ref": "#\/definitions\/proxyRule" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createAPIRule", + "group": "rules", + "weight": 1208, + "cookies": false, + "type": "", + "demo": "proxy\/create-api-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "default": null, + "x-example": null + } + }, + "required": [ + "domain" + ] + } + } + ] + } + }, + "\/proxy\/rules\/function": { + "post": { + "summary": "Create function rule", + "operationId": "proxyCreateFunctionRule", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "proxy" + ], + "description": "Create a new proxy rule for executing Appwrite Function on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", + "responses": { + "201": { + "description": "Rule", + "schema": { + "$ref": "#\/definitions\/proxyRule" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createFunctionRule", + "group": "rules", + "weight": 1210, + "cookies": false, + "type": "", + "demo": "proxy\/create-function-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "default": null, + "x-example": null + }, + "functionId": { + "type": "string", + "description": "ID of function to be executed.", + "default": null, + "x-example": "" + }, + "branch": { + "type": "string", + "description": "Name of VCS branch to deploy changes automatically", + "default": "", + "x-example": "" + } + }, + "required": [ + "domain", + "functionId" + ] + } + } + ] + } + }, + "\/proxy\/rules\/redirect": { + "post": { + "summary": "Create Redirect rule", + "operationId": "proxyCreateRedirectRule", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "proxy" + ], + "description": "Create a new proxy rule for to redirect from custom domain to another domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", + "responses": { + "201": { + "description": "Rule", + "schema": { + "$ref": "#\/definitions\/proxyRule" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createRedirectRule", + "group": "rules", + "weight": 1211, + "cookies": false, + "type": "", + "demo": "proxy\/create-redirect-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "default": null, + "x-example": null + }, + "url": { + "type": "string", + "description": "Target URL of redirection", + "default": null, + "x-example": "https:\/\/example.com", + "format": "url" + }, + "statusCode": { + "type": "string", + "description": "Status code of redirection", + "default": null, + "x-example": "301", + "enum": [ + "301", + "302", + "307", + "308" + ], + "x-enum-name": null, + "x-enum-keys": [ + "Moved Permanently 301", + "Found 302", + "Temporary Redirect 307", + "Permanent Redirect 308" + ] + }, + "resourceId": { + "type": "string", + "description": "ID of parent resource.", + "default": null, + "x-example": "" + }, + "resourceType": { + "type": "string", + "description": "Type of parent resource.", + "default": null, + "x-example": "site", + "enum": [ + "site", + "function" + ], + "x-enum-name": "ProxyResourceType", + "x-enum-keys": [ + "Site", + "Function" + ] + } + }, + "required": [ + "domain", + "url", + "statusCode", + "resourceId", + "resourceType" + ] + } + } + ] + } + }, + "\/proxy\/rules\/site": { + "post": { + "summary": "Create site rule", + "operationId": "proxyCreateSiteRule", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "proxy" + ], + "description": "Create a new proxy rule for serving Appwrite Site on custom domain.\n\nRule ID is automatically generated as MD5 hash of a rule domain for performance purposes.", + "responses": { + "201": { + "description": "Rule", + "schema": { + "$ref": "#\/definitions\/proxyRule" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSiteRule", + "group": "rules", + "weight": 1209, + "cookies": false, + "type": "", + "demo": "proxy\/create-site-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "default": null, + "x-example": null + }, + "siteId": { + "type": "string", + "description": "ID of site to be executed.", + "default": null, + "x-example": "" + }, + "branch": { + "type": "string", + "description": "Name of VCS branch to deploy changes automatically", + "default": "", + "x-example": "" + } + }, + "required": [ + "domain", + "siteId" + ] + } + } + ] + } + }, + "\/proxy\/rules\/{ruleId}": { + "get": { + "summary": "Get rule", + "operationId": "proxyGetRule", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "proxy" + ], + "description": "Get a proxy rule by its unique ID.", + "responses": { + "200": { + "description": "Rule", + "schema": { + "$ref": "#\/definitions\/proxyRule" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getRule", + "group": "rules", + "weight": 1212, + "cookies": false, + "type": "", + "demo": "proxy\/get-rule.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "ruleId", + "description": "Rule ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete rule", + "operationId": "proxyDeleteRule", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "proxy" + ], + "description": "Delete a proxy rule by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteRule", + "group": "rules", + "weight": 1214, + "cookies": false, + "type": "", + "demo": "proxy\/delete-rule.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "ruleId", + "description": "Rule ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/proxy\/rules\/{ruleId}\/status": { + "patch": { + "summary": "Update rule status", + "operationId": "proxyUpdateRuleStatus", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "proxy" + ], + "description": "If not succeeded yet, retry verification process of a proxy rule domain. This endpoint triggers domain verification by checking DNS records. If verification is successful, a TLS certificate will be automatically provisioned for the domain asynchronously in the background.", + "responses": { + "200": { + "description": "Rule", + "schema": { + "$ref": "#\/definitions\/proxyRule" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateRuleStatus", + "group": "rules", + "weight": 1215, + "cookies": false, + "type": "", + "demo": "proxy\/update-rule-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "rules.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "ruleId", + "description": "Rule ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/reports": { + "get": { + "summary": "List reports", + "operationId": "advisorListReports", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "Get a list of all the project's analyzer reports. You can use the query params to filter your results.\n", + "responses": { + "200": { + "description": "Reports List", + "schema": { + "$ref": "#\/definitions\/reportList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listReports", + "group": "reports", + "weight": 693, + "cookies": false, + "type": "", + "demo": "advisor\/list-reports.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-reports.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "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: appId, type, targetType, target, analyzedAt", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/reports\/{reportId}": { + "get": { + "summary": "Get report", + "operationId": "advisorGetReport", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "Get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.\n", + "responses": { + "200": { + "description": "Report", + "schema": { + "$ref": "#\/definitions\/report" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getReport", + "group": "reports", + "weight": 692, + "cookies": false, + "type": "", + "demo": "advisor\/get-report.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "reports.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-report.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete report", + "operationId": "advisorDeleteReport", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "advisor" + ], + "description": "Delete an analyzer report by its unique ID. Nested insights and CTA metadata are removed asynchronously by the deletes worker.\n", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteReport", + "group": "reports", + "weight": 694, + "cookies": false, + "type": "", + "demo": "advisor\/delete-report.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "projectId:{projectId},userId:{userId}", + "scope": "reports.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/delete-report.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/reports\/{reportId}\/insights": { + "get": { + "summary": "List insights", + "operationId": "advisorListInsights", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "List the insights produced under a single analyzer report. You can use the query params to filter your results further.\n", + "responses": { + "200": { + "description": "Insights List", + "schema": { + "$ref": "#\/definitions\/insightList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listInsights", + "group": "insights", + "weight": 696, + "cookies": false, + "type": "", + "demo": "advisor\/list-insights.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "insights.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/list-insights.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Parent report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "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: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/reports\/{reportId}\/insights\/{insightId}": { + "get": { + "summary": "Get insight", + "operationId": "advisorGetInsight", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "advisor" + ], + "description": "Get an insight by its unique ID, scoped to its parent report.\n", + "responses": { + "200": { + "description": "Insight", + "schema": { + "$ref": "#\/definitions\/insight" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getInsight", + "group": "insights", + "weight": 695, + "cookies": false, + "type": "", + "demo": "advisor\/get-insight.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "insights.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/advisor\/get-insight.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "reportId", + "description": "Parent report ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "insightId", + "description": "Insight ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, "\/sites": { "get": { "summary": "List sites", @@ -36907,7 +38854,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 470, + "weight": 479, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -36990,7 +38937,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 903, + "weight": 922, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -37307,7 +39254,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 473, + "weight": 482, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -37358,7 +39305,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 496, + "weight": 505, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -37409,7 +39356,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 469, + "weight": 478, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -37470,7 +39417,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 904, + "weight": 923, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -37782,7 +39729,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 472, + "weight": 481, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -37845,7 +39792,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 479, + "weight": 488, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -37924,7 +39871,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 478, + "weight": 487, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -38015,7 +39962,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 474, + "weight": 483, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -38118,7 +40065,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 482, + "weight": 491, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -38199,7 +40146,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 475, + "weight": 484, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -38321,7 +40268,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 476, + "weight": 485, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -38420,7 +40367,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 477, + "weight": 486, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -38484,7 +40431,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 480, + "weight": 489, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -38553,7 +40500,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 481, + "weight": 490, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -38640,7 +40587,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 483, + "weight": 492, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -38675,20 +40622,237 @@ "in": "path" }, { - "name": "deploymentId", - "description": "Deployment ID.", + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/sites\/{siteId}\/logs": { + "get": { + "summary": "List logs", + "operationId": "sitesListLogs", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "Get a list of all site logs. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Executions List", + "schema": { + "$ref": "#\/definitions\/executionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listLogs", + "group": "logs", + "weight": 494, + "cookies": false, + "type": "", + "demo": "sites\/list-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "log.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "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", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/sites\/{siteId}\/logs\/{logId}": { + "get": { + "summary": "Get log", + "operationId": "sitesGetLog", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "Get a site request log by its unique ID.", + "responses": { + "200": { + "description": "Execution", + "schema": { + "$ref": "#\/definitions\/execution" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getLog", + "group": "logs", + "weight": 493, + "cookies": false, + "type": "", + "demo": "sites\/get-log.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "log.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "logId", + "description": "Log ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete log", + "operationId": "sitesDeleteLog", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "Delete a site log by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteLog", + "group": "logs", + "weight": 495, + "cookies": false, + "type": "", + "demo": "sites\/delete-log.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "log.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "logId", + "description": "Log ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/sites\/{siteId}\/logs": { + "\/sites\/{siteId}\/variables": { "get": { - "summary": "List logs", - "operationId": "sitesListLogs", + "summary": "List variables", + "operationId": "sitesListVariables", "consumes": [], "produces": [ "application\/json" @@ -38696,27 +40860,27 @@ "tags": [ "sites" ], - "description": "Get a list of all site logs. You can use the query params to filter your results.", + "description": "Get a list of all variables of a specific site.", "responses": { "200": { - "description": "Executions List", + "description": "Variables List", "schema": { - "$ref": "#\/definitions\/executionList" + "$ref": "#\/definitions\/variableList" } } }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 485, + "method": "listVariables", + "group": "variables", + "weight": 498, "cookies": false, "type": "", - "demo": "sites\/list-logs.md", + "demo": "sites\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "sites.read", "platforms": [ "console", "server" @@ -38737,7 +40901,7 @@ "parameters": [ { "name": "siteId", - "description": "Site ID.", + "description": "Site unique ID.", "required": true, "type": "string", "x-example": "", @@ -38745,7 +40909,7 @@ }, { "name": "queries", - "description": "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", + "description": "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: key, resourceType, resourceId, secret", "required": false, "type": "array", "collectionFormat": "multi", @@ -38765,202 +40929,6 @@ "in": "query" } ] - } - }, - "\/sites\/{siteId}\/logs\/{logId}": { - "get": { - "summary": "Get log", - "operationId": "sitesGetLog", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a site request log by its unique ID.", - "responses": { - "200": { - "description": "Execution", - "schema": { - "$ref": "#\/definitions\/execution" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getLog", - "group": "logs", - "weight": 484, - "cookies": false, - "type": "", - "demo": "sites\/get-log.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete log", - "operationId": "sitesDeleteLog", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Delete a site log by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteLog", - "group": "logs", - "weight": 486, - "cookies": false, - "type": "", - "demo": "sites\/delete-log.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/variables": { - "get": { - "summary": "List variables", - "operationId": "sitesListVariables", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a list of all variables of a specific site.", - "responses": { - "200": { - "description": "Variables List", - "schema": { - "$ref": "#\/definitions\/variableList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 489, - "cookies": false, - "type": "", - "demo": "sites\/list-variables.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] }, "post": { "summary": "Create variable", @@ -38987,7 +40955,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 905, + "weight": 924, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -39027,6 +40995,12 @@ "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -39047,6 +41021,7 @@ } }, "required": [ + "variableId", "key", "value" ] @@ -39079,7 +41054,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 488, + "weight": 497, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -39148,7 +41123,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 490, + "weight": 499, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -39200,7 +41175,8 @@ "type": "string", "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -39216,10 +41192,7 @@ "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } ] @@ -39244,7 +41217,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 491, + "weight": 500, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -39313,7 +41286,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 539, + "weight": 548, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -39397,7 +41370,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 537, + "weight": 546, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -39545,7 +41518,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 538, + "weight": 547, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -39607,7 +41580,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 540, + "weight": 549, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -39751,7 +41724,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 541, + "weight": 550, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -39813,7 +41786,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 544, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -39908,7 +41881,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 1187, + "weight": 1206, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -40001,7 +41974,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 543, + "weight": 552, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -40074,7 +42047,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 545, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -40167,7 +42140,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 546, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -40240,7 +42213,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 548, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -40322,7 +42295,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 547, + "weight": 556, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -40532,7 +42505,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 549, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -40614,7 +42587,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 761, + "weight": 778, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -40698,7 +42671,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 757, + "weight": 774, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -40783,7 +42756,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 828, + "weight": 847, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -40855,7 +42828,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 824, + "weight": 843, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -40931,7 +42904,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 825, + "weight": 844, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -40999,7 +42972,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 826, + "weight": 845, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -41083,7 +43056,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 827, + "weight": 846, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -41153,7 +43126,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 829, + "weight": 848, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -41239,7 +43212,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 758, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -41301,7 +43274,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 759, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -41379,7 +43352,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 760, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -41441,7 +43414,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 768, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -41536,7 +43509,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 764, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -41666,7 +43639,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 765, + "weight": 782, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -41739,7 +43712,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 766, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -41791,150 +43764,380 @@ "schema": { "type": "object", "properties": { - "name": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tablesDB" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTable", + "group": "tables", + "weight": 784, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "List columns in the table.", + "responses": { + "200": { + "description": "Columns List", + "schema": { + "$ref": "#\/definitions\/columnList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 790, + "cookies": false, + "type": "", + "demo": "tablesdb\/list-columns.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.read", + "collections.read", + "columns.read", + "attributes.read" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "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 columns: key, type, size, required, array, status, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint": { + "post": { + "summary": "Create bigint column", + "operationId": "tablesDBCreateBigIntColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "Create a bigint column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnBigInt", + "schema": { + "$ref": "#\/definitions\/columnBigint" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBigIntColumn", + "group": "columns", + "weight": 803, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-bigint-column.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { "type": "string", - "description": "Table name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Column Key.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": null }, - "rowSecurity": { + "required": { "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, + "description": "Is column required?", + "default": null, "x-example": false }, - "enabled": { - "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", - "default": true, - "x-example": false + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true }, - "purge": { + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { "type": "boolean", - "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "description": "Is column an array?", "default": false, "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } ] - }, - "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint\/{key}": { + "patch": { + "summary": "Update bigint column", + "operationId": "tablesDBUpdateBigIntColumn", "consumes": [ "application\/json" ], - "produces": [], - "tags": [ - "tablesDB" - ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 767, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete-table.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { - "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", - "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "List columns in the table.", + "description": "Update a bigint column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Columns List", + "description": "ColumnBigInt", "schema": { - "$ref": "#\/definitions\/columnList" + "$ref": "#\/definitions\/columnBigint" } } }, "deprecated": false, "x-appwrite": { - "method": "listColumns", + "method": "updateBigIntColumn", "group": "columns", - "weight": 773, + "weight": 804, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "tablesdb\/update-big-int-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read", - "columns.read", - "attributes.read" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ "console", @@ -41942,7 +44145,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-bigint-column.md", "auth": { "Project": [], "Key": [] @@ -41972,25 +44175,61 @@ "in": "path" }, { - "name": "queries", - "description": "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 columns: key, type, size, required, array, status, error", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } @@ -42021,7 +44260,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 774, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -42136,7 +44375,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 775, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -42253,7 +44492,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 776, + "weight": 793, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -42369,7 +44608,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 777, + "weight": 794, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -42487,7 +44726,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 778, + "weight": 795, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -42603,7 +44842,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 779, + "weight": 796, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -42721,7 +44960,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 780, + "weight": 797, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -42846,7 +45085,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 781, + "weight": 798, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -42973,7 +45212,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 782, + "weight": 799, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -43105,7 +45344,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 783, + "weight": 800, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -43239,7 +45478,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 784, + "weight": 801, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -43371,7 +45610,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 785, + "weight": 802, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -43505,7 +45744,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 786, + "weight": 805, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -43620,7 +45859,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 787, + "weight": 806, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -43737,7 +45976,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 788, + "weight": 807, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -43846,7 +46085,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 789, + "weight": 808, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -43962,7 +46201,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 806, + "weight": 825, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -44083,7 +46322,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 807, + "weight": 826, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -44200,7 +46439,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 804, + "weight": 823, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -44321,7 +46560,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 805, + "weight": 824, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -44438,7 +46677,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 790, + "weight": 809, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -44547,7 +46786,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 791, + "weight": 810, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -44663,7 +46902,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 792, + "weight": 811, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -44772,7 +47011,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 793, + "weight": 812, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -44888,7 +47127,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 794, + "weight": 813, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -45031,7 +47270,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 796, + "weight": 815, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -45164,7 +47403,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 797, + "weight": 816, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -45293,7 +47532,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 802, + "weight": 821, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -45414,7 +47653,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 803, + "weight": 822, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -45531,7 +47770,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 798, + "weight": 817, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -45647,7 +47886,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 799, + "weight": 818, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -45765,7 +48004,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 800, + "weight": 819, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -45894,7 +48133,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 801, + "weight": 820, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -46099,7 +48338,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 771, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -46176,7 +48415,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 772, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -46260,7 +48499,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 795, + "weight": 814, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -46372,7 +48611,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 811, + "weight": 830, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -46467,7 +48706,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 808, + "weight": 827, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -46608,7 +48847,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 809, + "weight": 828, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -46684,7 +48923,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 810, + "weight": 829, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -46765,7 +49004,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 899, + "weight": 918, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -46880,7 +49119,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 812, + "weight": 831, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -47066,7 +49305,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 817, + "weight": 836, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -47198,7 +49437,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 815, + "weight": 834, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -47302,7 +49541,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 819, + "weight": 838, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -47400,7 +49639,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 813, + "weight": 832, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -47504,7 +49743,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 816, + "weight": 835, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -47653,7 +49892,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 814, + "weight": 833, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -47764,7 +50003,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 818, + "weight": 837, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -47866,7 +50105,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 823, + "weight": 842, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -47990,7 +50229,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 822, + "weight": 841, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -48112,7 +50351,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 520, + "weight": 529, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -48199,7 +50438,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 518, + "weight": 527, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -48292,7 +50531,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 519, + "weight": 528, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -48357,7 +50596,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 522, + "weight": 531, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -48435,7 +50674,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 521, + "weight": 530, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -48500,7 +50739,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 527, + "weight": 536, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -48595,7 +50834,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 525, + "weight": 534, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -48714,7 +50953,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 526, + "weight": 535, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -48787,7 +51026,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 528, + "weight": 537, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -48876,7 +51115,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 1188, + "weight": 1207, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -48951,7 +51190,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 530, + "weight": 539, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -49048,7 +51287,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 523, + "weight": 532, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -49112,7 +51351,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 524, + "weight": 533, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -49194,7 +51433,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 534, + "weight": 543, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -49284,7 +51523,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 532, + "weight": 541, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -49370,7 +51609,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 533, + "weight": 542, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -49431,7 +51670,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 535, + "weight": 544, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -49504,7 +51743,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 536, + "weight": 545, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -49565,7 +51804,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 71, + "weight": 70, "cookies": false, "type": "", "demo": "users\/list.md", @@ -49649,7 +51888,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 62, + "weight": 61, "cookies": false, "type": "", "demo": "users\/create.md", @@ -49751,7 +51990,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 65, + "weight": 64, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -49847,7 +52086,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 63, + "weight": 62, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -49941,7 +52180,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 79, + "weight": 78, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -50022,7 +52261,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 103, + "weight": 102, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -50086,7 +52325,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 64, + "weight": 63, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -50182,7 +52421,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 67, + "weight": 66, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -50278,7 +52517,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 68, + "weight": 67, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -50413,7 +52652,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 69, + "weight": 68, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -50530,7 +52769,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 66, + "weight": 65, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -50645,7 +52884,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 72, + "weight": 71, "cookies": false, "type": "", "demo": "users\/get.md", @@ -50702,7 +52941,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 101, + "weight": 100, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -50766,7 +53005,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 86, + "weight": 85, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -50849,7 +53088,7 @@ "x-appwrite": { "method": "updateImpersonator", "group": "users", - "weight": 82, + "weight": 81, "cookies": false, "type": "", "demo": "users\/update-impersonator.md", @@ -50931,7 +53170,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 104, + "weight": 103, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -51017,7 +53256,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 81, + "weight": 80, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -51100,7 +53339,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 77, + "weight": 76, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -51183,7 +53422,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 76, + "weight": 75, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -51277,7 +53516,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 91, + "weight": 90, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -51416,7 +53655,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 96, + "weight": 95, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -51551,7 +53790,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 92, + "weight": 91, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -51671,7 +53910,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 93, + "weight": 92, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -51791,7 +54030,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 95, + "weight": 94, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -51911,7 +54150,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 94, + "weight": 93, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -52033,7 +54272,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 84, + "weight": 83, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -52115,7 +54354,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 85, + "weight": 84, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -52197,7 +54436,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 87, + "weight": 86, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -52278,7 +54517,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 73, + "weight": 72, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -52340,7 +54579,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 89, + "weight": 88, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -52420,7 +54659,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 75, + "weight": 74, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -52494,7 +54733,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 97, + "weight": 96, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -52554,7 +54793,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 100, + "weight": 99, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -52616,7 +54855,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 99, + "weight": 98, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -52691,7 +54930,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 80, + "weight": 79, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -52771,7 +55010,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 78, + "weight": 77, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -52854,7 +55093,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 70, + "weight": 69, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -52967,7 +55206,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 74, + "weight": 73, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -53037,7 +55276,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 90, + "weight": 89, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -53129,7 +55368,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 102, + "weight": 101, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -53201,7 +55440,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 98, + "weight": 97, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -53288,7 +55527,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 88, + "weight": 87, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -53370,7 +55609,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 83, + "weight": 82, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -53450,7 +55689,7 @@ "x-appwrite": { "method": "list", "group": "vectorsdb", - "weight": 868, + "weight": 887, "cookies": false, "type": "", "demo": "vectorsdb\/list.md", @@ -53534,7 +55773,7 @@ "x-appwrite": { "method": "create", "group": "vectorsdb", - "weight": 864, + "weight": 883, "cookies": false, "type": "", "demo": "vectorsdb\/create.md", @@ -53621,7 +55860,7 @@ "x-appwrite": { "method": "createTextEmbeddings", "group": "documents", - "weight": 890, + "weight": 909, "cookies": false, "type": "", "demo": "vectorsdb\/create-text-embeddings.md", @@ -53735,7 +55974,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 895, + "weight": 914, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -53804,7 +56043,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 891, + "weight": 910, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -53877,7 +56116,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 892, + "weight": 911, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -53942,7 +56181,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 893, + "weight": 912, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -54023,7 +56262,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 894, + "weight": 913, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -54090,7 +56329,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 896, + "weight": 915, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -54173,7 +56412,7 @@ "x-appwrite": { "method": "get", "group": "vectorsdb", - "weight": 865, + "weight": 884, "cookies": false, "type": "", "demo": "vectorsdb\/get.md", @@ -54235,7 +56474,7 @@ "x-appwrite": { "method": "update", "group": "vectorsdb", - "weight": 866, + "weight": 885, "cookies": false, "type": "", "demo": "vectorsdb\/update.md", @@ -54316,7 +56555,7 @@ "x-appwrite": { "method": "delete", "group": "vectorsdb", - "weight": 867, + "weight": 886, "cookies": false, "type": "", "demo": "vectorsdb\/delete.md", @@ -54378,7 +56617,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 875, + "weight": 894, "cookies": false, "type": "", "demo": "vectorsdb\/list-collections.md", @@ -54470,7 +56709,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 871, + "weight": 890, "cookies": false, "type": "", "demo": "vectorsdb\/create-collection.md", @@ -54586,7 +56825,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 872, + "weight": 891, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection.md", @@ -54656,7 +56895,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 873, + "weight": 892, "cookies": false, "type": "", "demo": "vectorsdb\/update-collection.md", @@ -54767,7 +57006,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 874, + "weight": 893, "cookies": false, "type": "", "demo": "vectorsdb\/delete-collection.md", @@ -54837,7 +57076,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 885, + "weight": 904, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -54949,7 +57188,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 881, + "weight": 900, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -55128,7 +57367,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 888, + "weight": 907, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-documents.md", @@ -55256,7 +57495,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 887, + "weight": 906, "cookies": false, "type": "", "demo": "vectorsdb\/update-documents.md", @@ -55356,7 +57595,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 889, + "weight": 908, "cookies": false, "type": "", "demo": "vectorsdb\/delete-documents.md", @@ -55450,7 +57689,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 884, + "weight": 903, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -55551,7 +57790,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 883, + "weight": 902, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -55695,7 +57934,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 882, + "weight": 901, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -55801,7 +58040,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 886, + "weight": 905, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -55897,7 +58136,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 880, + "weight": 899, "cookies": false, "type": "", "demo": "vectorsdb\/list-indexes.md", @@ -55988,7 +58227,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 877, + "weight": 896, "cookies": false, "type": "", "demo": "vectorsdb\/create-index.md", @@ -56127,7 +58366,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 878, + "weight": 897, "cookies": false, "type": "", "demo": "vectorsdb\/get-index.md", @@ -56199,7 +58438,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 879, + "weight": 898, "cookies": false, "type": "", "demo": "vectorsdb\/delete-index.md", @@ -56276,7 +58515,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 567, + "weight": 576, "cookies": false, "type": "", "demo": "webhooks\/list.md", @@ -56350,7 +58589,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 566, + "weight": 575, "cookies": false, "type": "", "demo": "webhooks\/create.md", @@ -56476,7 +58715,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 568, + "weight": 577, "cookies": false, "type": "", "demo": "webhooks\/get.md", @@ -56537,7 +58776,7 @@ "x-appwrite": { "method": "update", "group": null, - "weight": 570, + "weight": 579, "cookies": false, "type": "", "demo": "webhooks\/update.md", @@ -56652,7 +58891,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 569, + "weight": 578, "cookies": false, "type": "", "demo": "webhooks\/delete.md", @@ -56715,7 +58954,7 @@ "x-appwrite": { "method": "updateSecret", "group": null, - "weight": 571, + "weight": 580, "cookies": false, "type": "", "demo": "webhooks\/update-secret.md", @@ -56841,6 +59080,10 @@ { "name": "messaging", "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." + }, + { + "name": "advisor", + "description": "The Advisor service surfaces actionable reports about your project resources, with CTA descriptors for one-click remediation in the console." } ], "definitions": { @@ -56908,6 +59151,35 @@ "documents": "" } }, + "presenceList": { + "description": "Presences List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of presences that matched your query.", + "x-example": 5, + "format": "int32" + }, + "presences": { + "type": "array", + "description": "List of presences.", + "items": { + "type": "object", + "$ref": "#\/definitions\/presence" + }, + "x-example": "" + } + }, + "required": [ + "total", + "presences" + ], + "example": { + "total": 5, + "presences": "" + } + }, "tableList": { "description": "Tables List", "type": "object", @@ -57877,6 +60149,35 @@ "statuses": "" } }, + "proxyRuleList": { + "description": "Rule List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rules that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rules": { + "type": "array", + "description": "List of rules.", + "items": { + "type": "object", + "$ref": "#\/definitions\/proxyRule" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rules" + ], + "example": { + "total": 5, + "rules": "" + } + }, "localeCodeList": { "description": "Locale codes list", "type": "object", @@ -58167,6 +60468,64 @@ "embeddings": "" } }, + "insightList": { + "description": "Insights List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of insights that matched your query.", + "x-example": 5, + "format": "int32" + }, + "insights": { + "type": "array", + "description": "List of insights.", + "items": { + "type": "object", + "$ref": "#\/definitions\/insight" + }, + "x-example": "" + } + }, + "required": [ + "total", + "insights" + ], + "example": { + "total": 5, + "insights": "" + } + }, + "reportList": { + "description": "Reports List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of reports that matched your query.", + "x-example": 5, + "format": "int32" + }, + "reports": { + "type": "array", + "description": "List of reports.", + "items": { + "type": "object", + "$ref": "#\/definitions\/report" + }, + "x-example": "" + } + }, + "required": [ + "total", + "reports" + ], + "example": { + "total": 5, + "reports": "" + } + }, "database": { "description": "Database", "type": "object", @@ -58212,7 +60571,7 @@ "description": "Database backup policies.", "items": { "type": "object", - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/backupPolicy" }, "x-example": {} }, @@ -58221,7 +60580,7 @@ "description": "Database backup archives.", "items": { "type": "object", - "$ref": "#\/definitions\/collection" + "$ref": "#\/definitions\/backupArchive" }, "x-example": {} } @@ -58355,6 +60714,9 @@ { "$ref": "#\/definitions\/attributeBoolean" }, + { + "$ref": "#\/definitions\/attributeBigint" + }, { "$ref": "#\/definitions\/attributeInteger" }, @@ -58408,6 +60770,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/definitions\/attributeBoolean", + "bigint": "#\/definitions\/attributeBigint", "integer": "#\/definitions\/attributeInteger", "double": "#\/definitions\/attributeFloat", "string": "#\/definitions\/attributeString", @@ -58429,6 +60792,9 @@ "#\/definitions\/attributeBoolean": { "type": "boolean" }, + "#\/definitions\/attributeBigint": { + "type": "bigint" + }, "#\/definitions\/attributeInteger": { "type": "integer" }, @@ -58557,6 +60923,9 @@ { "$ref": "#\/definitions\/attributeBoolean" }, + { + "$ref": "#\/definitions\/attributeBigint" + }, { "$ref": "#\/definitions\/attributeInteger" }, @@ -58610,6 +60979,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/definitions\/attributeBoolean", + "bigint": "#\/definitions\/attributeBigint", "integer": "#\/definitions\/attributeInteger", "double": "#\/definitions\/attributeFloat", "string": "#\/definitions\/attributeString", @@ -58631,6 +61001,9 @@ "#\/definitions\/attributeBoolean": { "type": "boolean" }, + "#\/definitions\/attributeBigint": { + "type": "bigint" + }, "#\/definitions\/attributeInteger": { "type": "integer" }, @@ -58892,6 +61265,104 @@ "default": 10 } }, + "attributeBigint": { + "description": "AttributeBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int64", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "attributeFloat": { "description": "AttributeFloat", "type": "object", @@ -60651,6 +63122,9 @@ { "$ref": "#\/definitions\/columnBoolean" }, + { + "$ref": "#\/definitions\/columnBigint" + }, { "$ref": "#\/definitions\/columnInteger" }, @@ -60704,6 +63178,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/definitions\/columnBoolean", + "bigint": "#\/definitions\/columnBigint", "integer": "#\/definitions\/columnInteger", "double": "#\/definitions\/columnFloat", "string": "#\/definitions\/columnString", @@ -60725,6 +63200,9 @@ "#\/definitions\/columnBoolean": { "type": "boolean" }, + "#\/definitions\/columnBigint": { + "type": "bigint" + }, "#\/definitions\/columnInteger": { "type": "integer" }, @@ -60853,6 +63331,9 @@ { "$ref": "#\/definitions\/columnBoolean" }, + { + "$ref": "#\/definitions\/columnBigint" + }, { "$ref": "#\/definitions\/columnInteger" }, @@ -60906,6 +63387,7 @@ "propertyName": "type", "mapping": { "boolean": "#\/definitions\/columnBoolean", + "bigint": "#\/definitions\/columnBigint", "integer": "#\/definitions\/columnInteger", "double": "#\/definitions\/columnFloat", "string": "#\/definitions\/columnString", @@ -60927,6 +63409,9 @@ "#\/definitions\/columnBoolean": { "type": "boolean" }, + "#\/definitions\/columnBigint": { + "type": "bigint" + }, "#\/definitions\/columnInteger": { "type": "integer" }, @@ -61188,6 +63673,104 @@ "default": 10 } }, + "columnBigint": { + "description": "ColumnBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 10, + "format": "int64", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "columnFloat": { "description": "ColumnFloat", "type": "object", @@ -62934,6 +65517,89 @@ "isAdmin": false } }, + "presence": { + "description": "Presence", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Presence ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "string", + "description": "Presence sequence ID.", + "x-example": "1", + "readOnly": true + }, + "$createdAt": { + "type": "string", + "description": "Presence creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Presence update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Presence permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "674af8f3e12a5f9ac0be" + }, + "status": { + "type": "string", + "description": "Presence status.", + "x-example": "online", + "x-nullable": true + }, + "source": { + "type": "string", + "description": "Presence source.", + "x-example": "HTTP" + }, + "expiresAt": { + "type": "string", + "description": "Presence expiry date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "additionalProperties": true, + "x-additional-properties-key": "metadata", + "required": [ + "$id", + "$sequence", + "$createdAt", + "$updatedAt", + "$permissions", + "userId", + "source" + ], + "example": { + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "userId": "674af8f3e12a5f9ac0be", + "status": "online", + "source": "HTTP", + "expiresAt": "2020-10-15T06:38:00.000+00:00" + } + }, "log": { "description": "Log", "type": "object", @@ -65524,217 +68190,14 @@ "description": "Project name.", "x-example": "New Project" }, - "description": { - "type": "string", - "description": "Project description.", - "x-example": "This is a new project." - }, "teamId": { "type": "string", "description": "Project team ID.", "x-example": "1592981250" }, - "logo": { - "type": "string", - "description": "Project logo file ID.", - "x-example": "5f5c451b403cb" - }, - "url": { - "type": "string", - "description": "Project website URL.", - "x-example": "5f5c451b403cb" - }, - "legalName": { - "type": "string", - "description": "Company legal name.", - "x-example": "Company LTD." - }, - "legalCountry": { - "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", - "x-example": "US" - }, - "legalState": { - "type": "string", - "description": "State name.", - "x-example": "New York" - }, - "legalCity": { - "type": "string", - "description": "City name.", - "x-example": "New York City." - }, - "legalAddress": { - "type": "string", - "description": "Company Address.", - "x-example": "620 Eighth Avenue, New York, NY 10018" - }, - "legalTaxId": { - "type": "string", - "description": "Company Tax ID.", - "x-example": "131102020" - }, - "authDuration": { - "type": "integer", - "description": "Session duration in seconds.", - "x-example": 60, - "format": "int32" - }, - "authLimit": { - "type": "integer", - "description": "Max users allowed. 0 is unlimited.", - "x-example": 100, - "format": "int32" - }, - "authSessionsLimit": { - "type": "integer", - "description": "Max sessions allowed per user. 100 maximum.", - "x-example": 10, - "format": "int32" - }, - "authPasswordHistory": { - "type": "integer", - "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", - "x-example": 5, - "format": "int32" - }, - "authPasswordDictionary": { - "type": "boolean", - "description": "Whether or not to check user's password against most commonly used passwords.", - "x-example": true - }, - "authPersonalDataCheck": { - "type": "boolean", - "description": "Whether or not to check the user password for similarity with their personal data.", - "x-example": true - }, - "authDisposableEmails": { - "type": "boolean", - "description": "Whether or not to disallow disposable email addresses during signup and email updates.", - "x-example": true - }, - "authCanonicalEmails": { - "type": "boolean", - "description": "Whether or not to require canonical email addresses during signup and email updates.", - "x-example": true - }, - "authFreeEmails": { - "type": "boolean", - "description": "Whether or not to disallow free email addresses during signup and email updates.", - "x-example": true - }, - "authMockNumbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs).", - "items": { - "type": "object", - "$ref": "#\/definitions\/mockNumber" - }, - "x-example": [ - {} - ] - }, - "authSessionAlerts": { - "type": "boolean", - "description": "Whether or not to send session alert emails to users.", - "x-example": true - }, - "authMembershipsUserName": { - "type": "boolean", - "description": "Whether or not to show user names in the teams membership response.", - "x-example": true - }, - "authMembershipsUserEmail": { - "type": "boolean", - "description": "Whether or not to show user emails in the teams membership response.", - "x-example": true - }, - "authMembershipsMfa": { - "type": "boolean", - "description": "Whether or not to show user MFA status in the teams membership response.", - "x-example": true - }, - "authMembershipsUserId": { - "type": "boolean", - "description": "Whether or not to show user IDs in the teams membership response.", - "x-example": true - }, - "authMembershipsUserPhone": { - "type": "boolean", - "description": "Whether or not to show user phone numbers in the teams membership response.", - "x-example": true - }, - "authInvalidateSessions": { - "type": "boolean", - "description": "Whether or not all existing sessions should be invalidated on password change", - "x-example": true - }, - "oAuthProviders": { - "type": "array", - "description": "List of Auth Providers.", - "items": { - "type": "object", - "$ref": "#\/definitions\/authProvider" - }, - "x-example": [ - {} - ] - }, - "platforms": { - "type": "array", - "description": "List of Platforms.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/platformWeb" - }, - { - "$ref": "#\/definitions\/platformApple" - }, - { - "$ref": "#\/definitions\/platformAndroid" - }, - { - "$ref": "#\/definitions\/platformWindows" - }, - { - "$ref": "#\/definitions\/platformLinux" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/definitions\/platformWeb", - "apple": "#\/definitions\/platformApple", - "android": "#\/definitions\/platformAndroid", - "windows": "#\/definitions\/platformWindows", - "linux": "#\/definitions\/platformLinux" - } - } - }, - "x-example": {} - }, - "webhooks": { - "type": "array", - "description": "List of Webhooks.", - "items": { - "type": "object", - "$ref": "#\/definitions\/webhook" - }, - "x-example": {} - }, - "keys": { - "type": "array", - "description": "List of API Keys.", - "items": { - "type": "object", - "$ref": "#\/definitions\/key" - }, - "x-example": {} - }, "devKeys": { "type": "array", - "description": "List of dev keys.", + "description": "Deprecated since 1.9.5: List of dev keys.", "items": { "type": "object", "$ref": "#\/definitions\/devKey" @@ -65818,140 +68281,32 @@ "description": "Project status", "x-example": "active" }, - "authEmailPassword": { - "type": "boolean", - "description": "Email\/Password auth method status", - "x-example": true - }, - "authUsersAuthMagicURL": { - "type": "boolean", - "description": "Magic URL auth method status", - "x-example": true - }, - "authEmailOtp": { - "type": "boolean", - "description": "Email (OTP) auth method status", - "x-example": true - }, - "authAnonymous": { - "type": "boolean", - "description": "Anonymous auth method status", - "x-example": true - }, - "authInvites": { - "type": "boolean", - "description": "Invites auth method status", - "x-example": true - }, - "authJWT": { - "type": "boolean", - "description": "JWT auth method status", - "x-example": true - }, - "authPhone": { - "type": "boolean", - "description": "Phone auth method status", - "x-example": true - }, - "serviceStatusForAccount": { - "type": "boolean", - "description": "Account service status", - "x-example": true - }, - "serviceStatusForAvatars": { - "type": "boolean", - "description": "Avatars service status", - "x-example": true - }, - "serviceStatusForDatabases": { - "type": "boolean", - "description": "Databases (legacy) service status", - "x-example": true - }, - "serviceStatusForTablesdb": { - "type": "boolean", - "description": "TablesDB service status", - "x-example": true - }, - "serviceStatusForLocale": { - "type": "boolean", - "description": "Locale service status", - "x-example": true - }, - "serviceStatusForHealth": { - "type": "boolean", - "description": "Health service status", - "x-example": true - }, - "serviceStatusForProject": { - "type": "boolean", - "description": "Project service status", - "x-example": true - }, - "serviceStatusForStorage": { - "type": "boolean", - "description": "Storage service status", - "x-example": true - }, - "serviceStatusForTeams": { - "type": "boolean", - "description": "Teams service status", - "x-example": true - }, - "serviceStatusForUsers": { - "type": "boolean", - "description": "Users service status", - "x-example": true - }, - "serviceStatusForVcs": { - "type": "boolean", - "description": "VCS service status", - "x-example": true - }, - "serviceStatusForSites": { - "type": "boolean", - "description": "Sites service status", - "x-example": true - }, - "serviceStatusForFunctions": { - "type": "boolean", - "description": "Functions service status", - "x-example": true - }, - "serviceStatusForProxy": { - "type": "boolean", - "description": "Proxy service status", - "x-example": true - }, - "serviceStatusForGraphql": { - "type": "boolean", - "description": "GraphQL service status", - "x-example": true - }, - "serviceStatusForMigrations": { - "type": "boolean", - "description": "Migrations service status", - "x-example": true - }, - "serviceStatusForMessaging": { - "type": "boolean", - "description": "Messaging service status", - "x-example": true - }, - "protocolStatusForRest": { - "type": "boolean", - "description": "REST protocol status", - "x-example": true + "authMethods": { + "type": "array", + "description": "List of auth methods.", + "items": { + "type": "object", + "$ref": "#\/definitions\/projectAuthMethod" + }, + "x-example": {} }, - "protocolStatusForGraphql": { - "type": "boolean", - "description": "GraphQL protocol status", - "x-example": true + "services": { + "type": "array", + "description": "List of services.", + "items": { + "type": "object", + "$ref": "#\/definitions\/projectService" + }, + "x-example": {} }, - "protocolStatusForWebsocket": { - "type": "boolean", - "description": "Websocket protocol status", - "x-example": true + "protocols": { + "type": "array", + "description": "List of protocols.", + "items": { + "type": "object", + "$ref": "#\/definitions\/projectProtocol" + }, + "x-example": {} }, "region": { "type": "string", @@ -65987,37 +68342,7 @@ "$createdAt", "$updatedAt", "name", - "description", "teamId", - "logo", - "url", - "legalName", - "legalCountry", - "legalState", - "legalCity", - "legalAddress", - "legalTaxId", - "authDuration", - "authLimit", - "authSessionsLimit", - "authPasswordHistory", - "authPasswordDictionary", - "authPersonalDataCheck", - "authDisposableEmails", - "authCanonicalEmails", - "authFreeEmails", - "authMockNumbers", - "authSessionAlerts", - "authMembershipsUserName", - "authMembershipsUserEmail", - "authMembershipsMfa", - "authMembershipsUserId", - "authMembershipsUserPhone", - "authInvalidateSessions", - "oAuthProviders", - "platforms", - "webhooks", - "keys", "devKeys", "smtpEnabled", "smtpSenderName", @@ -66033,33 +68358,9 @@ "pingedAt", "labels", "status", - "authEmailPassword", - "authUsersAuthMagicURL", - "authEmailOtp", - "authAnonymous", - "authInvites", - "authJWT", - "authPhone", - "serviceStatusForAccount", - "serviceStatusForAvatars", - "serviceStatusForDatabases", - "serviceStatusForTablesdb", - "serviceStatusForLocale", - "serviceStatusForHealth", - "serviceStatusForProject", - "serviceStatusForStorage", - "serviceStatusForTeams", - "serviceStatusForUsers", - "serviceStatusForVcs", - "serviceStatusForSites", - "serviceStatusForFunctions", - "serviceStatusForProxy", - "serviceStatusForGraphql", - "serviceStatusForMigrations", - "serviceStatusForMessaging", - "protocolStatusForRest", - "protocolStatusForGraphql", - "protocolStatusForWebsocket", + "authMethods", + "services", + "protocols", "region", "billingLimits", "blocks", @@ -66070,41 +68371,7 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "New Project", - "description": "This is a new project.", "teamId": "1592981250", - "logo": "5f5c451b403cb", - "url": "5f5c451b403cb", - "legalName": "Company LTD.", - "legalCountry": "US", - "legalState": "New York", - "legalCity": "New York City.", - "legalAddress": "620 Eighth Avenue, New York, NY 10018", - "legalTaxId": "131102020", - "authDuration": 60, - "authLimit": 100, - "authSessionsLimit": 10, - "authPasswordHistory": 5, - "authPasswordDictionary": true, - "authPersonalDataCheck": true, - "authDisposableEmails": true, - "authCanonicalEmails": true, - "authFreeEmails": true, - "authMockNumbers": [ - {} - ], - "authSessionAlerts": true, - "authMembershipsUserName": true, - "authMembershipsUserEmail": true, - "authMembershipsMfa": true, - "authMembershipsUserId": true, - "authMembershipsUserPhone": true, - "authInvalidateSessions": true, - "oAuthProviders": [ - {} - ], - "platforms": {}, - "webhooks": {}, - "keys": {}, "devKeys": {}, "smtpEnabled": false, "smtpSenderName": "John Appwrite", @@ -66122,39 +68389,124 @@ "vip" ], "status": "active", - "authEmailPassword": true, - "authUsersAuthMagicURL": true, - "authEmailOtp": true, - "authAnonymous": true, - "authInvites": true, - "authJWT": true, - "authPhone": true, - "serviceStatusForAccount": true, - "serviceStatusForAvatars": true, - "serviceStatusForDatabases": true, - "serviceStatusForTablesdb": true, - "serviceStatusForLocale": true, - "serviceStatusForHealth": true, - "serviceStatusForProject": true, - "serviceStatusForStorage": true, - "serviceStatusForTeams": true, - "serviceStatusForUsers": true, - "serviceStatusForVcs": true, - "serviceStatusForSites": true, - "serviceStatusForFunctions": true, - "serviceStatusForProxy": true, - "serviceStatusForGraphql": true, - "serviceStatusForMigrations": true, - "serviceStatusForMessaging": true, - "protocolStatusForRest": true, - "protocolStatusForGraphql": true, - "protocolStatusForWebsocket": true, + "authMethods": {}, + "services": {}, + "protocols": {}, "region": "fra", "billingLimits": "", "blocks": "", "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, + "projectAuthMethod": { + "description": "ProjectAuthMethod", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Auth method ID.", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "ProjectAuthMethodId" + }, + "enabled": { + "type": "boolean", + "description": "Auth method status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "email-password", + "enabled": false + } + }, + "projectService": { + "description": "ProjectService", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Service ID.", + "x-example": "sites", + "enum": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging", + "advisor" + ], + "x-enum-name": "ProjectServiceId" + }, + "enabled": { + "type": "boolean", + "description": "Service status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "sites", + "enabled": false + } + }, + "projectProtocol": { + "description": "ProjectProtocol", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Protocol ID.", + "x-example": "graphql", + "enum": [ + "rest", + "graphql", + "websocket" + ], + "x-enum-name": "ProjectProtocolId" + }, + "enabled": { + "type": "boolean", + "description": "Protocol status.", + "x-example": false + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "graphql", + "enabled": false + } + }, "webhook": { "description": "Webhook", "type": "object", @@ -66896,19 +69248,38 @@ "type": "string", "description": "Google OAuth2 client secret.", "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" + }, + "prompt": { + "type": "array", + "description": "Google OAuth2 prompt values.", + "items": { + "type": "string", + "enum": [ + "none", + "consent", + "select_account" + ] + }, + "x-example": [ + "consent" + ] } }, "required": [ "$id", "enabled", "clientId", - "clientSecret" + "clientSecret", + "prompt" ], "example": { "$id": "github", "enabled": false, "clientId": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", - "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj" + "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj", + "prompt": [ + "consent" + ] } }, "oAuth2Zoom": { @@ -67937,12 +70308,12 @@ "description": "OpenID Connect authorization endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" }, - "tokenUrl": { + "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/token" }, - "userInfoUrl": { + "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL.", "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" @@ -67955,8 +70326,8 @@ "clientSecret", "wellKnownURL", "authorizationURL", - "tokenUrl", - "userInfoUrl" + "tokenURL", + "userInfoURL" ], "example": { "$id": "github", @@ -67965,8 +70336,8 @@ "clientSecret": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", "wellKnownURL": "https:\/\/myoauth.com\/.well-known\/openid-configuration", "authorizationURL": "https:\/\/myoauth.com\/oauth2\/authorize", - "tokenUrl": "https:\/\/myoauth.com\/oauth2\/token", - "userInfoUrl": "https:\/\/myoauth.com\/oauth2\/userinfo" + "tokenURL": "https:\/\/myoauth.com\/oauth2\/token", + "userInfoURL": "https:\/\/myoauth.com\/oauth2\/userinfo" } }, "oAuth2Okta": { @@ -68600,51 +70971,6 @@ "userMFA": true } }, - "authProvider": { - "description": "AuthProvider", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Auth Provider.", - "x-example": "github" - }, - "name": { - "type": "string", - "description": "Auth Provider name.", - "x-example": "GitHub" - }, - "appId": { - "type": "string", - "description": "OAuth 2.0 application ID.", - "x-example": "259125845563242502" - }, - "secret": { - "type": "string", - "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Auth Provider is active and can be used to create session.", - "x-example": "" - } - }, - "required": [ - "key", - "name", - "appId", - "secret", - "enabled" - ], - "example": { - "key": "github", - "name": "GitHub", - "appId": "259125845563242502", - "secret": "", - "enabled": "" - } - }, "platformWeb": { "description": "Platform Web", "type": "object", @@ -69471,6 +71797,131 @@ "slug": "s-1vcpu-512mb" } }, + "proxyRule": { + "description": "Rule", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Rule ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Rule creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Rule update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": "appwrite.company.com" + }, + "type": { + "type": "string", + "description": "Action definition for the rule. Possible values are \"api\", \"deployment\", or \"redirect\"", + "x-example": "deployment" + }, + "trigger": { + "type": "string", + "description": "Defines how the rule was created. Possible values are \"manual\" or \"deployment\"", + "x-example": "manual" + }, + "redirectUrl": { + "type": "string", + "description": "URL to redirect to. Used if type is \"redirect\"", + "x-example": "https:\/\/appwrite.io\/docs" + }, + "redirectStatusCode": { + "type": "integer", + "description": "Status code to apply during redirect. Used if type is \"redirect\"", + "x-example": 301, + "format": "int32" + }, + "deploymentId": { + "type": "string", + "description": "ID of deployment. Used if type is \"deployment\"", + "x-example": "n3u9feiwmf" + }, + "deploymentResourceType": { + "type": "string", + "description": "Type of deployment. Possible values are \"function\", \"site\". Used if rule's type is \"deployment\".", + "x-example": "function", + "enum": [ + "function", + "site" + ], + "x-nullable": true + }, + "deploymentResourceId": { + "type": "string", + "description": "ID of deployment's resource (site or function ID). Used if type is \"deployment\"", + "x-example": "n3u9feiwmf" + }, + "deploymentVcsProviderBranch": { + "type": "string", + "description": "Name of Git branch that updates rule. Used if type is \"deployment\"", + "x-example": "main" + }, + "status": { + "type": "string", + "description": "Domain verification status. Possible values are \"unverified\", \"verifying\", \"verified\"", + "x-example": "verified", + "enum": [ + "unverified", + "verifying", + "verified" + ] + }, + "logs": { + "type": "string", + "description": "Logs from rule verification or certificate generation. Certificate generation logs are prioritized if both are available.", + "x-example": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record." + }, + "renewAt": { + "type": "string", + "description": "Certificate auto-renewal date in ISO 8601 format.", + "x-example": "datetime" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "domain", + "type", + "trigger", + "redirectUrl", + "redirectStatusCode", + "deploymentId", + "deploymentResourceId", + "deploymentVcsProviderBranch", + "status", + "logs", + "renewAt" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "domain": "appwrite.company.com", + "type": "deployment", + "trigger": "manual", + "redirectUrl": "https:\/\/appwrite.io\/docs", + "redirectStatusCode": 301, + "deploymentId": "n3u9feiwmf", + "deploymentResourceType": "function", + "deploymentResourceId": "n3u9feiwmf", + "deploymentVcsProviderBranch": "main", + "status": "verified", + "logs": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record.", + "renewAt": "datetime" + } + }, "emailTemplate": { "description": "EmailTemplate", "type": "object", @@ -70182,6 +72633,301 @@ "expired": false } }, + "insight": { + "description": "Insight", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Insight ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Insight creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Insight update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "reportId": { + "type": "string", + "description": "Parent report ID. Insights always belong to a report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).", + "x-example": "tablesDBIndex" + }, + "severity": { + "type": "string", + "description": "Insight severity. One of info, warning, critical.", + "x-example": "warning" + }, + "status": { + "type": "string", + "description": "Insight status. One of active, dismissed.", + "x-example": "active" + }, + "resourceType": { + "type": "string", + "description": "Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.", + "x-example": "databases" + }, + "resourceId": { + "type": "string", + "description": "ID of the resource the insight is about.", + "x-example": "main" + }, + "parentResourceType": { + "type": "string", + "description": "Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table \u2192 resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.", + "x-example": "tables" + }, + "parentResourceId": { + "type": "string", + "description": "ID of the parent resource. Empty when the resource has no parent.", + "x-example": "orders" + }, + "title": { + "type": "string", + "description": "Insight title.", + "x-example": "Missing index on collection orders" + }, + "summary": { + "type": "string", + "description": "Short markdown summary describing the insight.", + "x-example": "Queries against `orders.status` are scanning the full collection." + }, + "ctas": { + "type": "array", + "description": "List of call-to-action buttons attached to this insight.", + "items": { + "type": "object", + "$ref": "#\/definitions\/insightCTA" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the insight was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + }, + "dismissedAt": { + "type": "string", + "description": "Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + }, + "dismissedBy": { + "type": "string", + "description": "User ID that dismissed the insight. Empty when not dismissed.", + "x-example": "5e5ea5c16897e", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "reportId", + "type", + "severity", + "status", + "resourceType", + "resourceId", + "parentResourceType", + "parentResourceId", + "title", + "summary", + "ctas" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "reportId": "5e5ea5c16897e", + "type": "tablesDBIndex", + "severity": "warning", + "status": "active", + "resourceType": "databases", + "resourceId": "main", + "parentResourceType": "tables", + "parentResourceId": "orders", + "title": "Missing index on collection orders", + "summary": "Queries against `orders.status` are scanning the full collection.", + "ctas": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedAt": "2020-10-15T06:38:00.000+00:00", + "dismissedBy": "5e5ea5c16897e" + } + }, + "insightCTA": { + "description": "InsightCTA", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Human-readable label for the CTA, used in UI.", + "x-example": "Create missing index" + }, + "service": { + "type": "string", + "description": "Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource \u2014 for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.", + "x-example": "tablesDB" + }, + "method": { + "type": "string", + "description": "Public API method on the chosen service the client should invoke when this CTA is triggered.", + "x-example": "createIndex" + }, + "params": { + "type": "object", + "additionalProperties": true, + "description": "Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId\/tableId\/columns for tablesDB, databaseId\/collectionId\/attributes for the legacy Databases API).", + "x-example": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "required": [ + "label", + "service", + "method", + "params" + ], + "example": { + "label": "Create missing index", + "service": "tablesDB", + "method": "createIndex", + "params": { + "databaseId": "main", + "tableId": "orders", + "key": "_idx_status", + "type": "key", + "columns": [ + "status" + ] + } + } + }, + "report": { + "description": "Report", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Report ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Report creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Report update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "appId": { + "type": "string", + "description": "ID of the third-party app that submitted the report.", + "x-example": "5e5ea5c16897e" + }, + "type": { + "type": "string", + "description": "Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.", + "x-example": "lighthouse" + }, + "title": { + "type": "string", + "description": "Short, human-readable title for the report.", + "x-example": "Lighthouse audit for https:\/\/appwrite.io\/" + }, + "summary": { + "type": "string", + "description": "Markdown summary describing the report.", + "x-example": "Performance score 78. 4 opportunities found." + }, + "targetType": { + "type": "string", + "description": "Plural noun describing what the report analyzes, e.g. databases, sites, urls.", + "x-example": "urls" + }, + "target": { + "type": "string", + "description": "Free-form target identifier (URL for lighthouse, resource ID for db).", + "x-example": "https:\/\/appwrite.io\/" + }, + "categories": { + "type": "array", + "description": "Categories covered by the report, e.g. performance, accessibility.", + "items": { + "type": "string" + }, + "x-example": [ + "performance", + "accessibility" + ] + }, + "insights": { + "type": "array", + "description": "Insights nested under this report.", + "items": { + "type": "object", + "$ref": "#\/definitions\/insight" + }, + "x-example": [] + }, + "analyzedAt": { + "type": "string", + "description": "Time the report was analyzed in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "appId", + "type", + "title", + "summary", + "targetType", + "target", + "categories", + "insights" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "appId": "5e5ea5c16897e", + "type": "lighthouse", + "title": "Lighthouse audit for https:\/\/appwrite.io\/", + "summary": "Performance score 78. 4 opportunities found.", + "targetType": "urls", + "target": "https:\/\/appwrite.io\/", + "categories": [ + "performance", + "accessibility" + ], + "insights": [], + "analyzedAt": "2020-10-15T06:38:00.000+00:00" + } + }, "activityEvent": { "description": "ActivityEvent", "type": "object", @@ -70448,7 +73194,7 @@ }, "status": { "type": "string", - "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed.", + "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.", "x-example": "completed" }, "startedAt": {