@appwrite.io/console 18.1.0 → 18.3.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/sdk.js +1876 -259
  3. package/dist/cjs/sdk.js.map +1 -1
  4. package/dist/esm/sdk.js +1872 -257
  5. package/dist/esm/sdk.js.map +1 -1
  6. package/dist/iife/sdk.js +6294 -4654
  7. package/package.json +2 -2
  8. package/types/client.d.ts +4 -1
  9. package/types/enums/analytics-dimension.d.ts +24 -0
  10. package/types/enums/analytics-interval.d.ts +6 -0
  11. package/types/enums/build-runtime.d.ts +3 -0
  12. package/types/enums/o-auth-provider.d.ts +1 -0
  13. package/types/enums/project-key-scopes.d.ts +4 -1
  14. package/types/enums/project-o-auth-provider-id.d.ts +1 -0
  15. package/types/enums/proxy-rule-deployment-resource-type.d.ts +2 -1
  16. package/types/enums/query-suggestion-resource.d.ts +1 -0
  17. package/types/enums/runtime.d.ts +3 -0
  18. package/types/enums/usage-event-dimension.d.ts +9 -0
  19. package/types/enums/usage-event-metric.d.ts +4 -0
  20. package/types/enums/usage-gauge-metric.d.ts +1 -0
  21. package/types/index.d.ts +5 -0
  22. package/types/models.d.ts +285 -15
  23. package/types/services/account.d.ts +37 -10
  24. package/types/services/analytics-tracking.d.ts +211 -0
  25. package/types/services/analytics.d.ts +254 -0
  26. package/types/services/avatars.d.ts +33 -5
  27. package/types/services/console.d.ts +39 -3
  28. package/types/services/databases.d.ts +4 -1
  29. package/types/services/documents-db.d.ts +4 -1
  30. package/types/services/functions.d.ts +17 -2
  31. package/types/services/locale.d.ts +91 -7
  32. package/types/services/messaging.d.ts +40 -34
  33. package/types/services/notifications.d.ts +4 -1
  34. package/types/services/project.d.ts +29 -4
  35. package/types/services/proxy.d.ts +4 -0
  36. package/types/services/push.d.ts +26 -4
  37. package/types/services/sites.d.ts +21 -3
  38. package/types/services/tables-db.d.ts +4 -1
  39. package/types/services/teams.d.ts +2 -2
  40. package/types/services/usage.d.ts +4 -4
  41. package/types/services/vcs.d.ts +12 -3
  42. package/types/services/vectors-db.d.ts +4 -1
  43. package/types/services/webhooks.d.ts +2 -2
  44. package/types/service.d.ts +0 -11
@@ -39,6 +39,7 @@ export declare class Vcs {
39
39
  * @param {VCSDetectionType} params.type - Detector type. Must be one of the following: runtime, framework
40
40
  * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
41
41
  * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit, offset, and equal on namespace.
42
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
42
43
  * @throws {AppwriteException}
43
44
  * @returns {Promise<Models.ProviderRepositoryRuntimeList | Models.ProviderRepositoryFrameworkList>}
44
45
  */
@@ -47,6 +48,7 @@ export declare class Vcs {
47
48
  type: VCSDetectionType;
48
49
  search?: string;
49
50
  queries?: string[];
51
+ total?: boolean;
50
52
  }): Promise<Models.ProviderRepositoryRuntimeList | Models.ProviderRepositoryFrameworkList>;
51
53
  /**
52
54
  * Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
@@ -55,11 +57,12 @@ export declare class Vcs {
55
57
  * @param {VCSDetectionType} type - Detector type. Must be one of the following: runtime, framework
56
58
  * @param {string} search - Search term to filter your list results. Max length: 256 chars.
57
59
  * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit, offset, and equal on namespace.
60
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
58
61
  * @throws {AppwriteException}
59
62
  * @returns {Promise<Models.ProviderRepositoryRuntimeList | Models.ProviderRepositoryFrameworkList>}
60
63
  * @deprecated Use the object parameter style method for a better developer experience.
61
64
  */
62
- listRepositories(installationId: string, type: VCSDetectionType, search?: string, queries?: string[]): Promise<Models.ProviderRepositoryRuntimeList | Models.ProviderRepositoryFrameworkList>;
65
+ listRepositories(installationId: string, type: VCSDetectionType, search?: string, queries?: string[], total?: boolean): Promise<Models.ProviderRepositoryRuntimeList | Models.ProviderRepositoryFrameworkList>;
63
66
  /**
64
67
  * Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
65
68
  *
@@ -118,6 +121,7 @@ export declare class Vcs {
118
121
  * @param {string} params.providerRepositoryId - Repository Id
119
122
  * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
120
123
  * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit, offset, cursorAfter, and cursorBefore
124
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
121
125
  * @throws {AppwriteException}
122
126
  * @returns {Promise<Models.BranchList>}
123
127
  */
@@ -126,6 +130,7 @@ export declare class Vcs {
126
130
  providerRepositoryId: string;
127
131
  search?: string;
128
132
  queries?: string[];
133
+ total?: boolean;
129
134
  }): Promise<Models.BranchList>;
130
135
  /**
131
136
  * 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.
@@ -135,11 +140,12 @@ export declare class Vcs {
135
140
  * @param {string} providerRepositoryId - Repository Id
136
141
  * @param {string} search - Search term to filter your list results. Max length: 256 chars.
137
142
  * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit, offset, cursorAfter, and cursorBefore
143
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
138
144
  * @throws {AppwriteException}
139
145
  * @returns {Promise<Models.BranchList>}
140
146
  * @deprecated Use the object parameter style method for a better developer experience.
141
147
  */
142
- listRepositoryBranches(installationId: string, providerRepositoryId: string, search?: string, queries?: string[]): Promise<Models.BranchList>;
148
+ listRepositoryBranches(installationId: string, providerRepositoryId: string, search?: string, queries?: string[], total?: boolean): Promise<Models.BranchList>;
143
149
  /**
144
150
  * Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
145
151
  *
@@ -264,6 +270,7 @@ export declare class Vcs {
264
270
  * @param {string} params.installationId - Installation Id
265
271
  * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
266
272
  * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
273
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
267
274
  * @throws {AppwriteException}
268
275
  * @returns {Promise<Models.VcsNamespaceList>}
269
276
  */
@@ -271,6 +278,7 @@ export declare class Vcs {
271
278
  installationId: string;
272
279
  search?: string;
273
280
  queries?: string[];
281
+ total?: boolean;
274
282
  }): Promise<Models.VcsNamespaceList>;
275
283
  /**
276
284
  * List provider namespaces available to a VCS installation. This can include the user personal namespace and any groups or organizations the installation can browse.
@@ -278,9 +286,10 @@ export declare class Vcs {
278
286
  * @param {string} installationId - Installation Id
279
287
  * @param {string} search - Search term to filter your list results. Max length: 256 chars.
280
288
  * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
289
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
281
290
  * @throws {AppwriteException}
282
291
  * @returns {Promise<Models.VcsNamespaceList>}
283
292
  * @deprecated Use the object parameter style method for a better developer experience.
284
293
  */
285
- listNamespaces(installationId: string, search?: string, queries?: string[]): Promise<Models.VcsNamespaceList>;
294
+ listNamespaces(installationId: string, search?: string, queries?: string[], total?: boolean): Promise<Models.VcsNamespaceList>;
286
295
  }
@@ -74,21 +74,24 @@ export declare class VectorsDB {
74
74
  * List transactions across all databases.
75
75
  *
76
76
  * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries).
77
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
77
78
  * @throws {AppwriteException}
78
79
  * @returns {Promise<Models.TransactionList>}
79
80
  */
80
81
  listTransactions(params?: {
81
82
  queries?: string[];
83
+ total?: boolean;
82
84
  }): Promise<Models.TransactionList>;
83
85
  /**
84
86
  * List transactions across all databases.
85
87
  *
86
88
  * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries).
89
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
87
90
  * @throws {AppwriteException}
88
91
  * @returns {Promise<Models.TransactionList>}
89
92
  * @deprecated Use the object parameter style method for a better developer experience.
90
93
  */
91
- listTransactions(queries?: string[]): Promise<Models.TransactionList>;
94
+ listTransactions(queries?: string[], total?: boolean): Promise<Models.TransactionList>;
92
95
  /**
93
96
  * Create a new transaction.
94
97
  *
@@ -97,7 +97,7 @@ export declare class Webhooks {
97
97
  * @param {boolean} params.enabled - Enable or disable a webhook.
98
98
  * @param {boolean} params.tls - Certificate verification, false for disabled or true for enabled.
99
99
  * @param {string} params.authUsername - Webhook HTTP user. Max length: 256 chars.
100
- * @param {string} params.authPassword - Webhook HTTP password. Max length: 256 chars.
100
+ * @param {string} params.authPassword - Webhook HTTP password. Max length: 256 chars. Omit to keep the current password; it is cleared when the URL changes or TLS verification is disabled.
101
101
  * @throws {AppwriteException}
102
102
  * @returns {Promise<Models.Webhook>}
103
103
  */
@@ -121,7 +121,7 @@ export declare class Webhooks {
121
121
  * @param {boolean} enabled - Enable or disable a webhook.
122
122
  * @param {boolean} tls - Certificate verification, false for disabled or true for enabled.
123
123
  * @param {string} authUsername - Webhook HTTP user. Max length: 256 chars.
124
- * @param {string} authPassword - Webhook HTTP password. Max length: 256 chars.
124
+ * @param {string} authPassword - Webhook HTTP password. Max length: 256 chars. Omit to keep the current password; it is cleared when the URL changes or TLS verification is disabled.
125
125
  * @throws {AppwriteException}
126
126
  * @returns {Promise<Models.Webhook>}
127
127
  * @deprecated Use the object parameter style method for a better developer experience.
@@ -1,11 +0,0 @@
1
- import { Client } from './client';
2
- import type { Payload } from './client';
3
- export declare class Service {
4
- /**
5
- * The size for chunked uploads in bytes.
6
- */
7
- static CHUNK_SIZE: number;
8
- client: Client;
9
- constructor(client: Client);
10
- static flatten(data: Payload, prefix?: string): Payload;
11
- }