@appwrite.io/console 1.0.0 → 1.1.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 (116) hide show
  1. package/README.md +3 -3
  2. package/dist/cjs/sdk.js +4844 -3627
  3. package/dist/cjs/sdk.js.map +1 -1
  4. package/dist/esm/sdk.js +4843 -3628
  5. package/dist/esm/sdk.js.map +1 -1
  6. package/dist/iife/sdk.js +4844 -3627
  7. package/docs/examples/{functions/list-specifications.md → account/create-payment-method.md} +3 -3
  8. package/docs/examples/account/delete-mfa-authenticator.md +2 -1
  9. package/docs/examples/account/delete-payment-method.md +13 -0
  10. package/docs/examples/account/get-billing-address.md +13 -0
  11. package/docs/examples/account/get-payment-method.md +13 -0
  12. package/docs/examples/{functions/get-template.md → account/list-billing-addresses.md} +4 -4
  13. package/docs/examples/account/list-credits.md +14 -0
  14. package/docs/examples/account/list-invoices.md +13 -0
  15. package/docs/examples/account/list-payment-methods.md +13 -0
  16. package/docs/examples/account/update-payment-method-mandate-options.md +13 -0
  17. package/docs/examples/account/update-payment-method-provider.md +15 -0
  18. package/docs/examples/account/update-payment-method.md +15 -0
  19. package/docs/examples/backups/create-archive.md +14 -0
  20. package/docs/examples/backups/create-policy.md +19 -0
  21. package/docs/examples/backups/create-restoration.md +16 -0
  22. package/docs/examples/backups/delete-archive.md +13 -0
  23. package/docs/examples/backups/delete-policy.md +13 -0
  24. package/docs/examples/backups/get-archive.md +13 -0
  25. package/docs/examples/backups/get-policy.md +13 -0
  26. package/docs/examples/backups/get-restoration.md +13 -0
  27. package/docs/examples/backups/list-archives.md +13 -0
  28. package/docs/examples/backups/list-policies.md +13 -0
  29. package/docs/examples/backups/list-restorations.md +13 -0
  30. package/docs/examples/backups/update-policy.md +17 -0
  31. package/docs/examples/console/create-source.md +17 -0
  32. package/docs/examples/console/get-copon.md +13 -0
  33. package/docs/examples/console/plans.md +11 -0
  34. package/docs/examples/console/regions.md +11 -0
  35. package/docs/examples/functions/create-build.md +1 -1
  36. package/docs/examples/functions/create-execution.md +1 -2
  37. package/docs/examples/functions/create.md +1 -3
  38. package/docs/examples/functions/{get-deployment-download.md → download-deployment.md} +1 -1
  39. package/docs/examples/functions/update.md +1 -3
  40. package/docs/examples/organizations/add-credit.md +14 -0
  41. package/docs/examples/organizations/create-invoice-payment.md +15 -0
  42. package/docs/examples/organizations/create.md +17 -0
  43. package/docs/examples/organizations/delete-backup-payment-method.md +13 -0
  44. package/docs/examples/organizations/delete-billing-address.md +13 -0
  45. package/docs/examples/organizations/delete-default-payment-method.md +13 -0
  46. package/docs/examples/organizations/delete.md +13 -0
  47. package/docs/examples/organizations/get-aggregation.md +14 -0
  48. package/docs/examples/organizations/get-billing-address.md +14 -0
  49. package/docs/examples/organizations/get-credit.md +14 -0
  50. package/docs/examples/organizations/get-invoice-download.md +14 -0
  51. package/docs/examples/organizations/get-invoice-view.md +14 -0
  52. package/docs/examples/organizations/get-invoice.md +14 -0
  53. package/docs/examples/organizations/get-payment-method.md +14 -0
  54. package/docs/examples/organizations/get-plan.md +13 -0
  55. package/docs/examples/organizations/get-usage.md +15 -0
  56. package/docs/examples/organizations/list-aggregations.md +14 -0
  57. package/docs/examples/organizations/list-invoices.md +14 -0
  58. package/docs/examples/organizations/list.md +14 -0
  59. package/docs/examples/organizations/set-backup-payment-method.md +14 -0
  60. package/docs/examples/organizations/set-billing-address.md +14 -0
  61. package/docs/examples/organizations/set-billing-email.md +14 -0
  62. package/docs/examples/organizations/set-billing-tax-id.md +14 -0
  63. package/docs/examples/organizations/set-default-payment-method.md +14 -0
  64. package/docs/examples/organizations/update-budget.md +15 -0
  65. package/docs/examples/organizations/update-plan.md +16 -0
  66. package/package.json +1 -1
  67. package/src/client.ts +5 -20
  68. package/src/enums/billing-plan.ts +5 -0
  69. package/src/enums/email-template-type.ts +0 -2
  70. package/src/enums/platform-type.ts +0 -2
  71. package/src/enums/runtime.ts +0 -1
  72. package/src/index.ts +4 -1
  73. package/src/models.ts +956 -282
  74. package/src/services/account.ts +412 -20
  75. package/src/services/assistant.ts +2 -0
  76. package/src/services/avatars.ts +36 -0
  77. package/src/services/backups.ts +425 -0
  78. package/src/services/console.ts +122 -0
  79. package/src/services/databases.ts +49 -0
  80. package/src/services/functions.ts +41 -189
  81. package/src/services/graphql.ts +3 -0
  82. package/src/services/health.ts +24 -0
  83. package/src/services/locale.ts +9 -0
  84. package/src/services/messaging.ts +47 -0
  85. package/src/services/migrations.ts +17 -0
  86. package/src/services/organizations.ts +896 -0
  87. package/src/services/project.ts +7 -0
  88. package/src/services/projects.ts +42 -105
  89. package/src/services/proxy.ts +6 -0
  90. package/src/services/storage.ts +28 -0
  91. package/src/services/teams.ts +15 -0
  92. package/src/services/users.ts +43 -36
  93. package/src/services/vcs.ts +9 -34
  94. package/types/client.d.ts +0 -1
  95. package/types/enums/billing-plan.d.ts +5 -0
  96. package/types/enums/email-template-type.d.ts +1 -3
  97. package/types/enums/platform-type.d.ts +1 -3
  98. package/types/enums/runtime.d.ts +1 -2
  99. package/types/index.d.ts +4 -1
  100. package/types/models.d.ts +956 -282
  101. package/types/services/account.d.ts +105 -1
  102. package/types/services/backups.d.ts +128 -0
  103. package/types/services/console.d.ts +38 -0
  104. package/types/services/functions.d.ts +8 -67
  105. package/types/services/organizations.d.ts +273 -0
  106. package/types/services/projects.d.ts +1 -32
  107. package/types/services/users.d.ts +0 -12
  108. package/types/services/vcs.d.ts +0 -11
  109. package/docs/examples/functions/delete-execution.md +0 -14
  110. package/docs/examples/functions/list-templates.md +0 -16
  111. package/docs/examples/functions/update-deployment-build.md +0 -14
  112. package/docs/examples/projects/create-j-w-t.md +0 -15
  113. package/docs/examples/projects/update-mock-numbers.md +0 -14
  114. package/docs/examples/projects/update-session-alerts.md +0 -14
  115. package/docs/examples/users/create-j-w-t.md +0 -15
  116. package/docs/examples/vcs/get-repository-contents.md +0 -15
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.getCredit(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '<CREDIT_ID>' // creditId
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.getInvoiceDownload(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '<INVOICE_ID>' // invoiceId
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.getInvoiceView(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '<INVOICE_ID>' // invoiceId
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.getInvoice(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '<INVOICE_ID>' // invoiceId
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.getPaymentMethod(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '<PAYMENT_METHOD_ID>' // paymentMethodId
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,13 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.getPlan(
10
+ '<ORGANIZATION_ID>' // organizationId
11
+ );
12
+
13
+ console.log(result);
@@ -0,0 +1,15 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.getUsage(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '', // startDate (optional)
12
+ '' // endDate (optional)
13
+ );
14
+
15
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.listAggregations(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '' // queries (optional)
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.listInvoices(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '' // queries (optional)
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.list(
10
+ '', // queries (optional)
11
+ '<SEARCH>' // search (optional)
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.setBackupPaymentMethod(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '<PAYMENT_METHOD_ID>' // paymentMethodId
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.setBillingAddress(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '<BILLING_ADDRESS_ID>' // billingAddressId
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.setBillingEmail(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ 'email@example.com' // billingEmail
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.setBillingTaxId(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '<TAX_ID>' // taxId
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,14 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.setDefaultPaymentMethod(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ '<PAYMENT_METHOD_ID>' // paymentMethodId
12
+ );
13
+
14
+ console.log(result);
@@ -0,0 +1,15 @@
1
+ import { Client, Organizations } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.updateBudget(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ 0, // budget
12
+ [] // alerts (optional)
13
+ );
14
+
15
+ console.log(result);
@@ -0,0 +1,16 @@
1
+ import { Client, Organizations, } from "@appwrite.io/console";
2
+
3
+ const client = new Client()
4
+ .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
5
+ .setProject('<YOUR_PROJECT_ID>'); // Your project ID
6
+
7
+ const organizations = new Organizations(client);
8
+
9
+ const result = await organizations.updatePlan(
10
+ '<ORGANIZATION_ID>', // organizationId
11
+ .Tier0, // billingPlan
12
+ '<PAYMENT_METHOD_ID>', // paymentMethodId (optional)
13
+ '<BILLING_ADDRESS_ID>' // billingAddressId (optional)
14
+ );
15
+
16
+ console.log(result);
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@appwrite.io/console",
3
3
  "homepage": "https://appwrite.io/support",
4
4
  "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
5
- "version": "1.0.0",
5
+ "version": "1.1.0-rc.1",
6
6
  "license": "BSD-3-Clause",
7
7
  "main": "dist/cjs/sdk.js",
8
8
  "exports": {
package/src/client.ts CHANGED
@@ -304,8 +304,8 @@ class Client {
304
304
  'x-sdk-name': 'Console',
305
305
  'x-sdk-platform': 'console',
306
306
  'x-sdk-language': 'web',
307
- 'x-sdk-version': '1.0.0',
308
- 'X-Appwrite-Response-Format': '1.6.0',
307
+ 'x-sdk-version': '1.1.0-rc.1',
308
+ 'X-Appwrite-Response-Format': '1.5.0',
309
309
  };
310
310
 
311
311
  /**
@@ -545,10 +545,10 @@ class Client {
545
545
 
546
546
  /**
547
547
  * Subscribes to Appwrite events and passes you the payload in realtime.
548
- *
549
- * @param {string|string[]} channels
548
+ *
549
+ * @param {string|string[]} channels
550
550
  * Channel to subscribe - pass a single channel as a string or multiple with an array of strings.
551
- *
551
+ *
552
552
  * Possible channels are:
553
553
  * - account
554
554
  * - collections
@@ -681,21 +681,6 @@ class Client {
681
681
  return response;
682
682
  }
683
683
 
684
- async redirect(method: string, url: URL, headers: Headers = {}, params: Payload = {}): Promise<string> {
685
- const { uri, options } = this.prepareRequest(method, url, headers, params);
686
-
687
- const response = await fetch(uri, {
688
- ...options,
689
- redirect: 'manual'
690
- });
691
-
692
- if (response.status !== 301 && response.status !== 302) {
693
- throw new AppwriteException('Invalid redirect', response.status);
694
- }
695
-
696
- return response.headers.get('location') || '';
697
- }
698
-
699
684
  async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}, responseType = 'json'): Promise<any> {
700
685
  const { uri, options } = this.prepareRequest(method, url, headers, params);
701
686
 
@@ -0,0 +1,5 @@
1
+ export enum BillingPlan {
2
+ Tier0 = 'tier-0',
3
+ Tier1 = 'tier-1',
4
+ Tier2 = 'tier-2',
5
+ }
@@ -4,6 +4,4 @@ export enum EmailTemplateType {
4
4
  Recovery = 'recovery',
5
5
  Invitation = 'invitation',
6
6
  Mfachallenge = 'mfachallenge',
7
- Sessionalert = 'sessionalert',
8
- Otpsession = 'otpsession',
9
7
  }
@@ -12,6 +12,4 @@ export enum PlatformType {
12
12
  Appletvos = 'apple-tvos',
13
13
  Android = 'android',
14
14
  Unity = 'unity',
15
- Reactnativeios = 'react-native-ios',
16
- Reactnativeandroid = 'react-native-android',
17
15
  }
@@ -44,5 +44,4 @@ export enum Runtime {
44
44
  Cpp17 = 'cpp-17',
45
45
  Cpp20 = 'cpp-20',
46
46
  Bun10 = 'bun-1.0',
47
- Go123 = 'go-1.23',
48
47
  }
package/src/index.ts CHANGED
@@ -1,13 +1,14 @@
1
1
  /**
2
2
  * Appwrite Console SDK
3
3
  *
4
- * This SDK is compatible with Appwrite server version 1.6.x.
4
+ * This SDK is compatible with Appwrite server version 1.5.x.
5
5
  * For older versions, please check
6
6
  * [previous releases](https://github.com/appwrite/sdk-for-console/releases).
7
7
  */
8
8
  export { Client, Query, AppwriteException } from './client';
9
9
  export { Account } from './services/account';
10
10
  export { Avatars } from './services/avatars';
11
+ export { Backups } from './services/backups';
11
12
  export { Assistant } from './services/assistant';
12
13
  export { Console } from './services/console';
13
14
  export { Databases } from './services/databases';
@@ -17,6 +18,7 @@ export { Health } from './services/health';
17
18
  export { Locale } from './services/locale';
18
19
  export { Messaging } from './services/messaging';
19
20
  export { Migrations } from './services/migrations';
21
+ export { Organizations } from './services/organizations';
20
22
  export { Project } from './services/project';
21
23
  export { Projects } from './services/projects';
22
24
  export { Proxy } from './services/proxy';
@@ -44,6 +46,7 @@ export { FunctionUsageRange } from './enums/function-usage-range';
44
46
  export { ExecutionMethod } from './enums/execution-method';
45
47
  export { Name } from './enums/name';
46
48
  export { SmtpEncryption } from './enums/smtp-encryption';
49
+ export { BillingPlan } from './enums/billing-plan';
47
50
  export { ProjectUsageRange } from './enums/project-usage-range';
48
51
  export { Region } from './enums/region';
49
52
  export { Api } from './enums/api';