@appwrite.io/console 7.0.0 → 8.1.0

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 (150) hide show
  1. package/.github/workflows/publish.yml +1 -1
  2. package/CHANGELOG.md +30 -6
  3. package/README.md +2 -2
  4. package/dist/cjs/sdk.js +222 -303
  5. package/docs/examples/databases/create-index.md +2 -2
  6. package/docs/examples/domains/create-purchase.md +2 -1
  7. package/docs/examples/domains/create-transfer-in.md +2 -1
  8. package/docs/examples/domains/update-auto-renewal.md +16 -0
  9. package/docs/examples/project/create-variable.md +1 -0
  10. package/docs/examples/project/list-variables.md +4 -1
  11. package/docs/examples/project/update-variable.md +1 -1
  12. package/docs/examples/tablesdb/create-index.md +2 -2
  13. package/docs/examples/users/update-impersonator.md +16 -0
  14. package/package.json +7 -7
  15. package/rollup.config.js +2 -1
  16. package/src/client.ts +61 -1
  17. package/src/enums/appwrite-migration-resource.ts +2 -0
  18. package/src/enums/backup-services.ts +3 -0
  19. package/src/enums/build-runtime.ts +0 -86
  20. package/src/enums/database-type.ts +2 -0
  21. package/src/enums/databases-index-type.ts +6 -0
  22. package/src/enums/runtime.ts +0 -86
  23. package/src/enums/runtimes.ts +0 -86
  24. package/src/enums/scopes.ts +13 -2
  25. package/src/enums/{index-type.ts → tables-db-index-type.ts} +1 -1
  26. package/src/enums/template-reference-type.ts +1 -1
  27. package/src/enums/use-cases.ts +7 -2
  28. package/src/index.ts +2 -1
  29. package/src/models.ts +172 -4
  30. package/src/services/databases.ts +10 -10
  31. package/src/services/domains.ts +103 -26
  32. package/src/services/project.ts +76 -33
  33. package/src/services/tables-db.ts +10 -10
  34. package/src/services/users.ts +67 -2
  35. package/src/services/vcs.ts +10 -10
  36. package/dist/cjs/sdk.js.map +0 -1
  37. package/dist/esm/sdk.js +0 -29782
  38. package/dist/esm/sdk.js.map +0 -1
  39. package/dist/iife/sdk.js +0 -33583
  40. package/types/channel.d.ts +0 -74
  41. package/types/client.d.ts +0 -260
  42. package/types/enums/adapter.d.ts +0 -4
  43. package/types/enums/api-service.d.ts +0 -15
  44. package/types/enums/api.d.ts +0 -5
  45. package/types/enums/appwrite-migration-resource.d.ts +0 -25
  46. package/types/enums/attribute-status.d.ts +0 -7
  47. package/types/enums/auth-method.d.ts +0 -9
  48. package/types/enums/authentication-factor.d.ts +0 -6
  49. package/types/enums/authenticator-type.d.ts +0 -3
  50. package/types/enums/backup-services.d.ts +0 -5
  51. package/types/enums/billing-plan-group.d.ts +0 -5
  52. package/types/enums/browser-permission.d.ts +0 -22
  53. package/types/enums/browser.d.ts +0 -16
  54. package/types/enums/build-runtime.d.ts +0 -174
  55. package/types/enums/column-status.d.ts +0 -7
  56. package/types/enums/compression.d.ts +0 -5
  57. package/types/enums/console-resource-type.d.ts +0 -3
  58. package/types/enums/credit-card.d.ts +0 -19
  59. package/types/enums/database-type.d.ts +0 -4
  60. package/types/enums/deployment-download-type.d.ts +0 -4
  61. package/types/enums/deployment-status.d.ts +0 -8
  62. package/types/enums/domain-purchase-status.d.ts +0 -6
  63. package/types/enums/domain-transfer-status-enum.d.ts +0 -10
  64. package/types/enums/email-template-locale.d.ts +0 -133
  65. package/types/enums/email-template-type.d.ts +0 -9
  66. package/types/enums/execution-method.d.ts +0 -9
  67. package/types/enums/execution-status.d.ts +0 -7
  68. package/types/enums/execution-trigger.d.ts +0 -5
  69. package/types/enums/filter-type.d.ts +0 -4
  70. package/types/enums/firebase-migration-resource.d.ts +0 -12
  71. package/types/enums/flag.d.ts +0 -197
  72. package/types/enums/framework.d.ts +0 -17
  73. package/types/enums/frameworks.d.ts +0 -17
  74. package/types/enums/health-antivirus-status.d.ts +0 -5
  75. package/types/enums/health-check-status.d.ts +0 -4
  76. package/types/enums/image-format.d.ts +0 -9
  77. package/types/enums/image-gravity.d.ts +0 -11
  78. package/types/enums/index-status.d.ts +0 -7
  79. package/types/enums/index-type.d.ts +0 -6
  80. package/types/enums/message-priority.d.ts +0 -4
  81. package/types/enums/message-status.d.ts +0 -7
  82. package/types/enums/messaging-provider-type.d.ts +0 -5
  83. package/types/enums/n-host-migration-resource.d.ts +0 -13
  84. package/types/enums/name.d.ts +0 -15
  85. package/types/enums/o-auth-provider.d.ts +0 -41
  86. package/types/enums/order-by.d.ts +0 -4
  87. package/types/enums/password-hash.d.ts +0 -13
  88. package/types/enums/platform-type.d.ts +0 -17
  89. package/types/enums/platform.d.ts +0 -4
  90. package/types/enums/project-usage-range.d.ts +0 -4
  91. package/types/enums/proxy-resource-type.d.ts +0 -4
  92. package/types/enums/proxy-rule-deployment-resource-type.d.ts +0 -4
  93. package/types/enums/proxy-rule-status.d.ts +0 -6
  94. package/types/enums/region.d.ts +0 -8
  95. package/types/enums/registration-type.d.ts +0 -6
  96. package/types/enums/relation-mutate.d.ts +0 -5
  97. package/types/enums/relationship-type.d.ts +0 -6
  98. package/types/enums/resource-type.d.ts +0 -6
  99. package/types/enums/runtime.d.ts +0 -174
  100. package/types/enums/runtimes.d.ts +0 -174
  101. package/types/enums/scopes.d.ts +0 -70
  102. package/types/enums/sms-template-locale.d.ts +0 -133
  103. package/types/enums/sms-template-type.d.ts +0 -6
  104. package/types/enums/smtp-encryption.d.ts +0 -5
  105. package/types/enums/smtp-secure.d.ts +0 -4
  106. package/types/enums/status-code.d.ts +0 -6
  107. package/types/enums/status.d.ts +0 -3
  108. package/types/enums/supabase-migration-resource.d.ts +0 -13
  109. package/types/enums/template-reference-type.d.ts +0 -5
  110. package/types/enums/theme.d.ts +0 -4
  111. package/types/enums/timezone.d.ts +0 -421
  112. package/types/enums/usage-range.d.ts +0 -5
  113. package/types/enums/use-cases.d.ts +0 -11
  114. package/types/enums/vcs-detection-type.d.ts +0 -4
  115. package/types/enums/vcs-reference-type.d.ts +0 -5
  116. package/types/id.d.ts +0 -20
  117. package/types/index.d.ts +0 -117
  118. package/types/models.d.ts +0 -9071
  119. package/types/operator.d.ts +0 -180
  120. package/types/permission.d.ts +0 -43
  121. package/types/query.d.ts +0 -442
  122. package/types/role.d.ts +0 -70
  123. package/types/service.d.ts +0 -11
  124. package/types/services/account.d.ts +0 -1536
  125. package/types/services/activities.d.ts +0 -46
  126. package/types/services/assistant.d.ts +0 -24
  127. package/types/services/avatars.d.ts +0 -320
  128. package/types/services/backups.d.ts +0 -277
  129. package/types/services/console.d.ts +0 -248
  130. package/types/services/databases.d.ts +0 -2435
  131. package/types/services/domains.d.ts +0 -1499
  132. package/types/services/functions.d.ts +0 -842
  133. package/types/services/graphql.d.ts +0 -43
  134. package/types/services/health.d.ts +0 -475
  135. package/types/services/locale.d.ts +0 -64
  136. package/types/services/messaging.d.ts +0 -1989
  137. package/types/services/migrations.d.ts +0 -417
  138. package/types/services/organizations.d.ts +0 -1009
  139. package/types/services/project.d.ts +0 -130
  140. package/types/services/projects.d.ts +0 -1626
  141. package/types/services/proxy.d.ts +0 -190
  142. package/types/services/realtime.d.ts +0 -134
  143. package/types/services/sites.d.ts +0 -800
  144. package/types/services/storage.d.ts +0 -467
  145. package/types/services/tables-db.d.ts +0 -2352
  146. package/types/services/teams.d.ts +0 -366
  147. package/types/services/tokens.d.ts +0 -119
  148. package/types/services/users.d.ts +0 -1184
  149. package/types/services/vcs.d.ts +0 -252
  150. package/types/services/webhooks.d.ts +0 -165
@@ -1,1009 +0,0 @@
1
- import { Client } from '../client';
2
- import type { Models } from '../models';
3
- import { Platform } from '../enums/platform';
4
- import { Scopes } from '../enums/scopes';
5
- export declare class Organizations {
6
- client: Client;
7
- constructor(client: Client);
8
- /**
9
- * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
10
- *
11
- * @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). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan, paymentMethodId, backupPaymentMethodId, platform
12
- * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
13
- * @throws {AppwriteException}
14
- * @returns {Promise<Models.OrganizationList<Preferences>>}
15
- */
16
- list<Preferences extends Models.Preferences = Models.DefaultPreferences>(params?: {
17
- queries?: string[];
18
- search?: string;
19
- }): Promise<Models.OrganizationList<Preferences>>;
20
- /**
21
- * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
22
- *
23
- * @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). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan, paymentMethodId, backupPaymentMethodId, platform
24
- * @param {string} search - Search term to filter your list results. Max length: 256 chars.
25
- * @throws {AppwriteException}
26
- * @returns {Promise<Models.OrganizationList<Preferences>>}
27
- * @deprecated Use the object parameter style method for a better developer experience.
28
- */
29
- list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences>>;
30
- /**
31
- * Create a new organization.
32
- *
33
- *
34
- * @param {string} params.organizationId - Organization 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.
35
- * @param {string} params.name - Organization name. Max length: 128 chars.
36
- * @param {string} params.billingPlan - Organization billing plan chosen
37
- * @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
38
- * @param {string} params.billingAddressId - Unique ID of billing address
39
- * @param {string[]} params.invites - Additional member invites
40
- * @param {string} params.couponId - Coupon id
41
- * @param {string} params.taxId - Tax Id associated to billing.
42
- * @param {number} params.budget - Budget limit for additional usage set for the organization
43
- * @param {Platform} params.platform - Platform type
44
- * @throws {AppwriteException}
45
- * @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
46
- */
47
- create<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
48
- organizationId: string;
49
- name: string;
50
- billingPlan: string;
51
- paymentMethodId?: string;
52
- billingAddressId?: string;
53
- invites?: string[];
54
- couponId?: string;
55
- taxId?: string;
56
- budget?: number;
57
- platform?: Platform;
58
- }): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>;
59
- /**
60
- * Create a new organization.
61
- *
62
- *
63
- * @param {string} organizationId - Organization 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.
64
- * @param {string} name - Organization name. Max length: 128 chars.
65
- * @param {string} billingPlan - Organization billing plan chosen
66
- * @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
67
- * @param {string} billingAddressId - Unique ID of billing address
68
- * @param {string[]} invites - Additional member invites
69
- * @param {string} couponId - Coupon id
70
- * @param {string} taxId - Tax Id associated to billing.
71
- * @param {number} budget - Budget limit for additional usage set for the organization
72
- * @param {Platform} platform - Platform type
73
- * @throws {AppwriteException}
74
- * @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
75
- * @deprecated Use the object parameter style method for a better developer experience.
76
- */
77
- create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number, platform?: Platform): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>;
78
- /**
79
- * Get estimation for creating an organization.
80
- *
81
- * @param {string} params.billingPlan - Organization billing plan chosen
82
- * @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
83
- * @param {string[]} params.invites - Additional member invites
84
- * @param {string} params.couponId - Coupon id
85
- * @param {Platform} params.platform - Platform type
86
- * @throws {AppwriteException}
87
- * @returns {Promise<Models.Estimation>}
88
- */
89
- estimationCreateOrganization(params: {
90
- billingPlan: string;
91
- paymentMethodId?: string;
92
- invites?: string[];
93
- couponId?: string;
94
- platform?: Platform;
95
- }): Promise<Models.Estimation>;
96
- /**
97
- * Get estimation for creating an organization.
98
- *
99
- * @param {string} billingPlan - Organization billing plan chosen
100
- * @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
101
- * @param {string[]} invites - Additional member invites
102
- * @param {string} couponId - Coupon id
103
- * @param {Platform} platform - Platform type
104
- * @throws {AppwriteException}
105
- * @returns {Promise<Models.Estimation>}
106
- * @deprecated Use the object parameter style method for a better developer experience.
107
- */
108
- estimationCreateOrganization(billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform): Promise<Models.Estimation>;
109
- /**
110
- * Delete an organization.
111
- *
112
- * @param {string} params.organizationId - Team ID.
113
- * @throws {AppwriteException}
114
- * @returns {Promise<{}>}
115
- */
116
- delete(params: {
117
- organizationId: string;
118
- }): Promise<{}>;
119
- /**
120
- * Delete an organization.
121
- *
122
- * @param {string} organizationId - Team ID.
123
- * @throws {AppwriteException}
124
- * @returns {Promise<{}>}
125
- * @deprecated Use the object parameter style method for a better developer experience.
126
- */
127
- delete(organizationId: string): Promise<{}>;
128
- /**
129
- * Get a list of all aggregations for an organization.
130
- *
131
- * @param {string} params.organizationId - Organization ID
132
- * @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, from, to
133
- * @throws {AppwriteException}
134
- * @returns {Promise<Models.AggregationTeamList>}
135
- */
136
- listAggregations(params: {
137
- organizationId: string;
138
- queries?: string[];
139
- }): Promise<Models.AggregationTeamList>;
140
- /**
141
- * Get a list of all aggregations for an organization.
142
- *
143
- * @param {string} organizationId - Organization ID
144
- * @param {string[]} queries - 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: teamId, aggregationId, from, to
145
- * @throws {AppwriteException}
146
- * @returns {Promise<Models.AggregationTeamList>}
147
- * @deprecated Use the object parameter style method for a better developer experience.
148
- */
149
- listAggregations(organizationId: string, queries?: string[]): Promise<Models.AggregationTeamList>;
150
- /**
151
- * Get a specific aggregation using it's aggregation ID.
152
- *
153
- * @param {string} params.organizationId - Organization ID
154
- * @param {string} params.aggregationId - Invoice unique ID
155
- * @param {number} params.limit - Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.
156
- * @param {number} params.offset - Offset value. The default value is 0. Use this param to manage pagination.
157
- * @throws {AppwriteException}
158
- * @returns {Promise<Models.AggregationTeam>}
159
- */
160
- getAggregation(params: {
161
- organizationId: string;
162
- aggregationId: string;
163
- limit?: number;
164
- offset?: number;
165
- }): Promise<Models.AggregationTeam>;
166
- /**
167
- * Get a specific aggregation using it's aggregation ID.
168
- *
169
- * @param {string} organizationId - Organization ID
170
- * @param {string} aggregationId - Invoice unique ID
171
- * @param {number} limit - Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.
172
- * @param {number} offset - Offset value. The default value is 0. Use this param to manage pagination.
173
- * @throws {AppwriteException}
174
- * @returns {Promise<Models.AggregationTeam>}
175
- * @deprecated Use the object parameter style method for a better developer experience.
176
- */
177
- getAggregation(organizationId: string, aggregationId: string, limit?: number, offset?: number): Promise<Models.AggregationTeam>;
178
- /**
179
- * Set a billing address for an organization.
180
- *
181
- * @param {string} params.organizationId - Organization ID
182
- * @param {string} params.billingAddressId - Unique ID of billing address
183
- * @throws {AppwriteException}
184
- * @returns {Promise<Models.Organization<Preferences>>}
185
- */
186
- setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
187
- organizationId: string;
188
- billingAddressId: string;
189
- }): Promise<Models.Organization<Preferences>>;
190
- /**
191
- * Set a billing address for an organization.
192
- *
193
- * @param {string} organizationId - Organization ID
194
- * @param {string} billingAddressId - Unique ID of billing address
195
- * @throws {AppwriteException}
196
- * @returns {Promise<Models.Organization<Preferences>>}
197
- * @deprecated Use the object parameter style method for a better developer experience.
198
- */
199
- setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>>;
200
- /**
201
- * Delete a team's billing address.
202
- *
203
- * @param {string} params.organizationId - Organization ID
204
- * @throws {AppwriteException}
205
- * @returns {Promise<{}>}
206
- */
207
- deleteBillingAddress(params: {
208
- organizationId: string;
209
- }): Promise<{}>;
210
- /**
211
- * Delete a team's billing address.
212
- *
213
- * @param {string} organizationId - Organization ID
214
- * @throws {AppwriteException}
215
- * @returns {Promise<{}>}
216
- * @deprecated Use the object parameter style method for a better developer experience.
217
- */
218
- deleteBillingAddress(organizationId: string): Promise<{}>;
219
- /**
220
- * Get a billing address using it's ID.
221
- *
222
- * @param {string} params.organizationId - Organization ID
223
- * @param {string} params.billingAddressId - Unique ID of billing address
224
- * @throws {AppwriteException}
225
- * @returns {Promise<Models.BillingAddress>}
226
- */
227
- getBillingAddress(params: {
228
- organizationId: string;
229
- billingAddressId: string;
230
- }): Promise<Models.BillingAddress>;
231
- /**
232
- * Get a billing address using it's ID.
233
- *
234
- * @param {string} organizationId - Organization ID
235
- * @param {string} billingAddressId - Unique ID of billing address
236
- * @throws {AppwriteException}
237
- * @returns {Promise<Models.BillingAddress>}
238
- * @deprecated Use the object parameter style method for a better developer experience.
239
- */
240
- getBillingAddress(organizationId: string, billingAddressId: string): Promise<Models.BillingAddress>;
241
- /**
242
- * Set the current billing email for the organization.
243
- *
244
- * @param {string} params.organizationId - Organization ID
245
- * @param {string} params.billingEmail - Billing email for the organization.
246
- * @throws {AppwriteException}
247
- * @returns {Promise<Models.Organization<Preferences>>}
248
- */
249
- setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
250
- organizationId: string;
251
- billingEmail: string;
252
- }): Promise<Models.Organization<Preferences>>;
253
- /**
254
- * Set the current billing email for the organization.
255
- *
256
- * @param {string} organizationId - Organization ID
257
- * @param {string} billingEmail - Billing email for the organization.
258
- * @throws {AppwriteException}
259
- * @returns {Promise<Models.Organization<Preferences>>}
260
- * @deprecated Use the object parameter style method for a better developer experience.
261
- */
262
- setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>>;
263
- /**
264
- * Update the budget limit for an organization.
265
- *
266
- * @param {string} params.organizationId - Organization Unique ID
267
- * @param {number} params.budget - Budget limit for additional usage set for the organization
268
- * @param {number[]} params.alerts - Budget alert limit percentage
269
- * @throws {AppwriteException}
270
- * @returns {Promise<Models.Organization<Preferences>>}
271
- */
272
- updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
273
- organizationId: string;
274
- budget?: number;
275
- alerts?: number[];
276
- }): Promise<Models.Organization<Preferences>>;
277
- /**
278
- * Update the budget limit for an organization.
279
- *
280
- * @param {string} organizationId - Organization Unique ID
281
- * @param {number} budget - Budget limit for additional usage set for the organization
282
- * @param {number[]} alerts - Budget alert limit percentage
283
- * @throws {AppwriteException}
284
- * @returns {Promise<Models.Organization<Preferences>>}
285
- * @deprecated Use the object parameter style method for a better developer experience.
286
- */
287
- updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences>>;
288
- /**
289
- * List all credits for an organization.
290
- *
291
- *
292
- * @param {string} params.organizationId - Organization ID
293
- * @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, couponId, credits, expiration, status
294
- * @throws {AppwriteException}
295
- * @returns {Promise<Models.CreditList>}
296
- */
297
- listCredits(params: {
298
- organizationId: string;
299
- queries?: string[];
300
- }): Promise<Models.CreditList>;
301
- /**
302
- * List all credits for an organization.
303
- *
304
- *
305
- * @param {string} organizationId - Organization ID
306
- * @param {string[]} queries - 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: teamId, couponId, credits, expiration, status
307
- * @throws {AppwriteException}
308
- * @returns {Promise<Models.CreditList>}
309
- * @deprecated Use the object parameter style method for a better developer experience.
310
- */
311
- listCredits(organizationId: string, queries?: string[]): Promise<Models.CreditList>;
312
- /**
313
- * Add credit to an organization using a coupon.
314
- *
315
- * @param {string} params.organizationId - Organization ID
316
- * @param {string} params.couponId - ID of the coupon
317
- * @throws {AppwriteException}
318
- * @returns {Promise<Models.Credit>}
319
- */
320
- addCredit(params: {
321
- organizationId: string;
322
- couponId: string;
323
- }): Promise<Models.Credit>;
324
- /**
325
- * Add credit to an organization using a coupon.
326
- *
327
- * @param {string} organizationId - Organization ID
328
- * @param {string} couponId - ID of the coupon
329
- * @throws {AppwriteException}
330
- * @returns {Promise<Models.Credit>}
331
- * @deprecated Use the object parameter style method for a better developer experience.
332
- */
333
- addCredit(organizationId: string, couponId: string): Promise<Models.Credit>;
334
- /**
335
- * Get total available valid credits for an organization.
336
- *
337
- * @param {string} params.organizationId - Organization ID
338
- * @throws {AppwriteException}
339
- * @returns {Promise<Models.CreditAvailable>}
340
- */
341
- getAvailableCredits(params: {
342
- organizationId: string;
343
- }): Promise<Models.CreditAvailable>;
344
- /**
345
- * Get total available valid credits for an organization.
346
- *
347
- * @param {string} organizationId - Organization ID
348
- * @throws {AppwriteException}
349
- * @returns {Promise<Models.CreditAvailable>}
350
- * @deprecated Use the object parameter style method for a better developer experience.
351
- */
352
- getAvailableCredits(organizationId: string): Promise<Models.CreditAvailable>;
353
- /**
354
- * Get credit details.
355
- *
356
- * @param {string} params.organizationId - Organization ID
357
- * @param {string} params.creditId - Credit Unique ID
358
- * @throws {AppwriteException}
359
- * @returns {Promise<Models.Credit>}
360
- */
361
- getCredit(params: {
362
- organizationId: string;
363
- creditId: string;
364
- }): Promise<Models.Credit>;
365
- /**
366
- * Get credit details.
367
- *
368
- * @param {string} organizationId - Organization ID
369
- * @param {string} creditId - Credit Unique ID
370
- * @throws {AppwriteException}
371
- * @returns {Promise<Models.Credit>}
372
- * @deprecated Use the object parameter style method for a better developer experience.
373
- */
374
- getCredit(organizationId: string, creditId: string): Promise<Models.Credit>;
375
- /**
376
- * Get estimation for deleting an organization.
377
- *
378
- * @param {string} params.organizationId - Team ID.
379
- * @throws {AppwriteException}
380
- * @returns {Promise<Models.EstimationDeleteOrganization>}
381
- */
382
- estimationDeleteOrganization(params: {
383
- organizationId: string;
384
- }): Promise<Models.EstimationDeleteOrganization>;
385
- /**
386
- * Get estimation for deleting an organization.
387
- *
388
- * @param {string} organizationId - Team ID.
389
- * @throws {AppwriteException}
390
- * @returns {Promise<Models.EstimationDeleteOrganization>}
391
- * @deprecated Use the object parameter style method for a better developer experience.
392
- */
393
- estimationDeleteOrganization(organizationId: string): Promise<Models.EstimationDeleteOrganization>;
394
- /**
395
- * Get estimation for updating the organization plan.
396
- *
397
- * @param {string} params.organizationId - Organization ID
398
- * @param {string} params.billingPlan - Organization billing plan chosen
399
- * @param {string[]} params.invites - Additional member invites
400
- * @param {string} params.couponId - Coupon id
401
- * @throws {AppwriteException}
402
- * @returns {Promise<Models.EstimationUpdatePlan>}
403
- */
404
- estimationUpdatePlan(params: {
405
- organizationId: string;
406
- billingPlan: string;
407
- invites?: string[];
408
- couponId?: string;
409
- }): Promise<Models.EstimationUpdatePlan>;
410
- /**
411
- * Get estimation for updating the organization plan.
412
- *
413
- * @param {string} organizationId - Organization ID
414
- * @param {string} billingPlan - Organization billing plan chosen
415
- * @param {string[]} invites - Additional member invites
416
- * @param {string} couponId - Coupon id
417
- * @throws {AppwriteException}
418
- * @returns {Promise<Models.EstimationUpdatePlan>}
419
- * @deprecated Use the object parameter style method for a better developer experience.
420
- */
421
- estimationUpdatePlan(organizationId: string, billingPlan: string, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan>;
422
- /**
423
- * Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
424
- *
425
- *
426
- * @param {string} params.organizationId - Organization Unique ID
427
- * @param {string} params.reason - Feedback reason
428
- * @param {string} params.message - Feedback message
429
- * @param {string} params.fromPlanId - Plan downgrading from
430
- * @param {string} params.toPlanId - Plan downgrading to
431
- * @throws {AppwriteException}
432
- * @returns {Promise<Models.DowngradeFeedback>}
433
- */
434
- createDowngradeFeedback(params: {
435
- organizationId: string;
436
- reason: string;
437
- message: string;
438
- fromPlanId: string;
439
- toPlanId: string;
440
- }): Promise<Models.DowngradeFeedback>;
441
- /**
442
- * Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
443
- *
444
- *
445
- * @param {string} organizationId - Organization Unique ID
446
- * @param {string} reason - Feedback reason
447
- * @param {string} message - Feedback message
448
- * @param {string} fromPlanId - Plan downgrading from
449
- * @param {string} toPlanId - Plan downgrading to
450
- * @throws {AppwriteException}
451
- * @returns {Promise<Models.DowngradeFeedback>}
452
- * @deprecated Use the object parameter style method for a better developer experience.
453
- */
454
- createDowngradeFeedback(organizationId: string, reason: string, message: string, fromPlanId: string, toPlanId: string): Promise<Models.DowngradeFeedback>;
455
- /**
456
- * List all invoices for an organization.
457
- *
458
- * @param {string} params.organizationId - Organization ID
459
- * @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount
460
- * @throws {AppwriteException}
461
- * @returns {Promise<Models.InvoiceList>}
462
- */
463
- listInvoices(params: {
464
- organizationId: string;
465
- queries?: string[];
466
- }): Promise<Models.InvoiceList>;
467
- /**
468
- * List all invoices for an organization.
469
- *
470
- * @param {string} organizationId - Organization ID
471
- * @param {string[]} queries - 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: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount
472
- * @throws {AppwriteException}
473
- * @returns {Promise<Models.InvoiceList>}
474
- * @deprecated Use the object parameter style method for a better developer experience.
475
- */
476
- listInvoices(organizationId: string, queries?: string[]): Promise<Models.InvoiceList>;
477
- /**
478
- * Get an invoice by its unique ID.
479
- *
480
- * @param {string} params.organizationId - Organization ID
481
- * @param {string} params.invoiceId - Invoice unique ID
482
- * @throws {AppwriteException}
483
- * @returns {Promise<Models.Invoice>}
484
- */
485
- getInvoice(params: {
486
- organizationId: string;
487
- invoiceId: string;
488
- }): Promise<Models.Invoice>;
489
- /**
490
- * Get an invoice by its unique ID.
491
- *
492
- * @param {string} organizationId - Organization ID
493
- * @param {string} invoiceId - Invoice unique ID
494
- * @throws {AppwriteException}
495
- * @returns {Promise<Models.Invoice>}
496
- * @deprecated Use the object parameter style method for a better developer experience.
497
- */
498
- getInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
499
- /**
500
- * Download invoice in PDF
501
- *
502
- * @param {string} params.organizationId - Organization ID
503
- * @param {string} params.invoiceId - Invoice unique ID
504
- * @throws {AppwriteException}
505
- * @returns {Promise<Models.PaymentMethod>}
506
- */
507
- getInvoiceDownload(params: {
508
- organizationId: string;
509
- invoiceId: string;
510
- }): Promise<Models.PaymentMethod>;
511
- /**
512
- * Download invoice in PDF
513
- *
514
- * @param {string} organizationId - Organization ID
515
- * @param {string} invoiceId - Invoice unique ID
516
- * @throws {AppwriteException}
517
- * @returns {Promise<Models.PaymentMethod>}
518
- * @deprecated Use the object parameter style method for a better developer experience.
519
- */
520
- getInvoiceDownload(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
521
- /**
522
- * Initiate payment for failed invoice to pay live from console
523
- *
524
- * @param {string} params.organizationId - Organization ID
525
- * @param {string} params.invoiceId - Invoice unique ID
526
- * @param {string} params.paymentMethodId - Payment method ID
527
- * @throws {AppwriteException}
528
- * @returns {Promise<Models.Invoice>}
529
- */
530
- createInvoicePayment(params: {
531
- organizationId: string;
532
- invoiceId: string;
533
- paymentMethodId: string;
534
- }): Promise<Models.Invoice>;
535
- /**
536
- * Initiate payment for failed invoice to pay live from console
537
- *
538
- * @param {string} organizationId - Organization ID
539
- * @param {string} invoiceId - Invoice unique ID
540
- * @param {string} paymentMethodId - Payment method ID
541
- * @throws {AppwriteException}
542
- * @returns {Promise<Models.Invoice>}
543
- * @deprecated Use the object parameter style method for a better developer experience.
544
- */
545
- createInvoicePayment(organizationId: string, invoiceId: string, paymentMethodId: string): Promise<Models.Invoice>;
546
- /**
547
- * Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
548
- *
549
- * @param {string} params.organizationId - Organization ID
550
- * @param {string} params.invoiceId - Invoice unique ID
551
- * @throws {AppwriteException}
552
- * @returns {Promise<Models.Invoice>}
553
- */
554
- validateInvoice(params: {
555
- organizationId: string;
556
- invoiceId: string;
557
- }): Promise<Models.Invoice>;
558
- /**
559
- * Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
560
- *
561
- * @param {string} organizationId - Organization ID
562
- * @param {string} invoiceId - Invoice unique ID
563
- * @throws {AppwriteException}
564
- * @returns {Promise<Models.Invoice>}
565
- * @deprecated Use the object parameter style method for a better developer experience.
566
- */
567
- validateInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
568
- /**
569
- * View invoice in PDF
570
- *
571
- * @param {string} params.organizationId - Organization ID
572
- * @param {string} params.invoiceId - Invoice unique ID
573
- * @throws {AppwriteException}
574
- * @returns {Promise<Models.PaymentMethod>}
575
- */
576
- getInvoiceView(params: {
577
- organizationId: string;
578
- invoiceId: string;
579
- }): Promise<Models.PaymentMethod>;
580
- /**
581
- * View invoice in PDF
582
- *
583
- * @param {string} organizationId - Organization ID
584
- * @param {string} invoiceId - Invoice unique ID
585
- * @throws {AppwriteException}
586
- * @returns {Promise<Models.PaymentMethod>}
587
- * @deprecated Use the object parameter style method for a better developer experience.
588
- */
589
- getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
590
- /**
591
- * Get a list of all API keys from the current organization.
592
- *
593
- * @param {string} params.organizationId - Organization Unique ID
594
- * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
595
- * @throws {AppwriteException}
596
- * @returns {Promise<Models.KeyList>}
597
- */
598
- listKeys(params: {
599
- organizationId: string;
600
- total?: boolean;
601
- }): Promise<Models.KeyList>;
602
- /**
603
- * Get a list of all API keys from the current organization.
604
- *
605
- * @param {string} organizationId - Organization Unique ID
606
- * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
607
- * @throws {AppwriteException}
608
- * @returns {Promise<Models.KeyList>}
609
- * @deprecated Use the object parameter style method for a better developer experience.
610
- */
611
- listKeys(organizationId: string, total?: boolean): Promise<Models.KeyList>;
612
- /**
613
- * Create a new organization API key.
614
- *
615
- * @param {string} params.organizationId - Organization Unique ID
616
- * @param {string} params.name - Key name. Max length: 128 chars.
617
- * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
618
- * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
619
- * @throws {AppwriteException}
620
- * @returns {Promise<Models.Key>}
621
- */
622
- createKey(params: {
623
- organizationId: string;
624
- name: string;
625
- scopes: Scopes[];
626
- expire?: string;
627
- }): Promise<Models.Key>;
628
- /**
629
- * Create a new organization API key.
630
- *
631
- * @param {string} organizationId - Organization Unique ID
632
- * @param {string} name - Key name. Max length: 128 chars.
633
- * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
634
- * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
635
- * @throws {AppwriteException}
636
- * @returns {Promise<Models.Key>}
637
- * @deprecated Use the object parameter style method for a better developer experience.
638
- */
639
- createKey(organizationId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
640
- /**
641
- * Get a key by its unique ID. This endpoint returns details about a specific API key in your organization including it's scopes.
642
- *
643
- * @param {string} params.organizationId - Organization Unique ID
644
- * @param {string} params.keyId - Key unique ID.
645
- * @throws {AppwriteException}
646
- * @returns {Promise<Models.Key>}
647
- */
648
- getKey(params: {
649
- organizationId: string;
650
- keyId: string;
651
- }): Promise<Models.Key>;
652
- /**
653
- * Get a key by its unique ID. This endpoint returns details about a specific API key in your organization including it's scopes.
654
- *
655
- * @param {string} organizationId - Organization Unique ID
656
- * @param {string} keyId - Key unique ID.
657
- * @throws {AppwriteException}
658
- * @returns {Promise<Models.Key>}
659
- * @deprecated Use the object parameter style method for a better developer experience.
660
- */
661
- getKey(organizationId: string, keyId: string): Promise<Models.Key>;
662
- /**
663
- * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
664
- *
665
- * @param {string} params.organizationId - Organization Unique ID
666
- * @param {string} params.keyId - Key unique ID.
667
- * @param {string} params.name - Key name. Max length: 128 chars.
668
- * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
669
- * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
670
- * @throws {AppwriteException}
671
- * @returns {Promise<Models.Key>}
672
- */
673
- updateKey(params: {
674
- organizationId: string;
675
- keyId: string;
676
- name: string;
677
- scopes: Scopes[];
678
- expire?: string;
679
- }): Promise<Models.Key>;
680
- /**
681
- * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
682
- *
683
- * @param {string} organizationId - Organization Unique ID
684
- * @param {string} keyId - Key unique ID.
685
- * @param {string} name - Key name. Max length: 128 chars.
686
- * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
687
- * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
688
- * @throws {AppwriteException}
689
- * @returns {Promise<Models.Key>}
690
- * @deprecated Use the object parameter style method for a better developer experience.
691
- */
692
- updateKey(organizationId: string, keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
693
- /**
694
- * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
695
- *
696
- * @param {string} params.organizationId - Organization Unique ID
697
- * @param {string} params.keyId - Key unique ID.
698
- * @throws {AppwriteException}
699
- * @returns {Promise<{}>}
700
- */
701
- deleteKey(params: {
702
- organizationId: string;
703
- keyId: string;
704
- }): Promise<{}>;
705
- /**
706
- * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
707
- *
708
- * @param {string} organizationId - Organization Unique ID
709
- * @param {string} keyId - Key unique ID.
710
- * @throws {AppwriteException}
711
- * @returns {Promise<{}>}
712
- * @deprecated Use the object parameter style method for a better developer experience.
713
- */
714
- deleteKey(organizationId: string, keyId: string): Promise<{}>;
715
- /**
716
- * Set a organization's default payment method.
717
- *
718
- * @param {string} params.organizationId - Organization ID
719
- * @param {string} params.paymentMethodId - Unique ID of payment method
720
- * @throws {AppwriteException}
721
- * @returns {Promise<Models.Organization<Preferences>>}
722
- */
723
- setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
724
- organizationId: string;
725
- paymentMethodId: string;
726
- }): Promise<Models.Organization<Preferences>>;
727
- /**
728
- * Set a organization's default payment method.
729
- *
730
- * @param {string} organizationId - Organization ID
731
- * @param {string} paymentMethodId - Unique ID of payment method
732
- * @throws {AppwriteException}
733
- * @returns {Promise<Models.Organization<Preferences>>}
734
- * @deprecated Use the object parameter style method for a better developer experience.
735
- */
736
- setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
737
- /**
738
- * Delete the default payment method for an organization.
739
- *
740
- * @param {string} params.organizationId - Organization ID
741
- * @throws {AppwriteException}
742
- * @returns {Promise<Models.Organization<Preferences>>}
743
- */
744
- deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
745
- organizationId: string;
746
- }): Promise<Models.Organization<Preferences>>;
747
- /**
748
- * Delete the default payment method for an organization.
749
- *
750
- * @param {string} organizationId - Organization ID
751
- * @throws {AppwriteException}
752
- * @returns {Promise<Models.Organization<Preferences>>}
753
- * @deprecated Use the object parameter style method for a better developer experience.
754
- */
755
- deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
756
- /**
757
- * Set an organization's backup payment method.
758
- *
759
- *
760
- * @param {string} params.organizationId - Organization ID
761
- * @param {string} params.paymentMethodId - Unique ID of payment method
762
- * @throws {AppwriteException}
763
- * @returns {Promise<Models.Organization<Preferences>>}
764
- */
765
- setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
766
- organizationId: string;
767
- paymentMethodId: string;
768
- }): Promise<Models.Organization<Preferences>>;
769
- /**
770
- * Set an organization's backup payment method.
771
- *
772
- *
773
- * @param {string} organizationId - Organization ID
774
- * @param {string} paymentMethodId - Unique ID of payment method
775
- * @throws {AppwriteException}
776
- * @returns {Promise<Models.Organization<Preferences>>}
777
- * @deprecated Use the object parameter style method for a better developer experience.
778
- */
779
- setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
780
- /**
781
- * Delete a backup payment method for an organization.
782
- *
783
- * @param {string} params.organizationId - Organization ID
784
- * @throws {AppwriteException}
785
- * @returns {Promise<Models.Organization<Preferences>>}
786
- */
787
- deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
788
- organizationId: string;
789
- }): Promise<Models.Organization<Preferences>>;
790
- /**
791
- * Delete a backup payment method for an organization.
792
- *
793
- * @param {string} organizationId - Organization ID
794
- * @throws {AppwriteException}
795
- * @returns {Promise<Models.Organization<Preferences>>}
796
- * @deprecated Use the object parameter style method for a better developer experience.
797
- */
798
- deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
799
- /**
800
- * Get an organization's payment method using it's payment method ID.
801
- *
802
- * @param {string} params.organizationId - Organization ID
803
- * @param {string} params.paymentMethodId - Unique ID of payment method
804
- * @throws {AppwriteException}
805
- * @returns {Promise<Models.PaymentMethod>}
806
- */
807
- getPaymentMethod(params: {
808
- organizationId: string;
809
- paymentMethodId: string;
810
- }): Promise<Models.PaymentMethod>;
811
- /**
812
- * Get an organization's payment method using it's payment method ID.
813
- *
814
- * @param {string} organizationId - Organization ID
815
- * @param {string} paymentMethodId - Unique ID of payment method
816
- * @throws {AppwriteException}
817
- * @returns {Promise<Models.PaymentMethod>}
818
- * @deprecated Use the object parameter style method for a better developer experience.
819
- */
820
- getPaymentMethod(organizationId: string, paymentMethodId: string): Promise<Models.PaymentMethod>;
821
- /**
822
- * Get the details of the current billing plan for an organization.
823
- *
824
- * @param {string} params.organizationId - Organization Unique ID
825
- * @throws {AppwriteException}
826
- * @returns {Promise<Models.BillingPlan>}
827
- */
828
- getPlan(params: {
829
- organizationId: string;
830
- }): Promise<Models.BillingPlan>;
831
- /**
832
- * Get the details of the current billing plan for an organization.
833
- *
834
- * @param {string} organizationId - Organization Unique ID
835
- * @throws {AppwriteException}
836
- * @returns {Promise<Models.BillingPlan>}
837
- * @deprecated Use the object parameter style method for a better developer experience.
838
- */
839
- getPlan(organizationId: string): Promise<Models.BillingPlan>;
840
- /**
841
- * Update the billing plan for an organization.
842
- *
843
- * @param {string} params.organizationId - Organization Unique ID
844
- * @param {string} params.billingPlan - Organization billing plan chosen
845
- * @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
846
- * @param {string} params.billingAddressId - Unique ID of billing address
847
- * @param {string[]} params.invites - Additional member invites
848
- * @param {string} params.couponId - Coupon id
849
- * @param {string} params.taxId - Tax Id associated to billing.
850
- * @param {number} params.budget - Budget limit for additional usage set for the organization
851
- * @throws {AppwriteException}
852
- * @returns {Promise<Models.Organization<Preferences>>}
853
- */
854
- updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
855
- organizationId: string;
856
- billingPlan: string;
857
- paymentMethodId?: string;
858
- billingAddressId?: string;
859
- invites?: string[];
860
- couponId?: string;
861
- taxId?: string;
862
- budget?: number;
863
- }): Promise<Models.Organization<Preferences>>;
864
- /**
865
- * Update the billing plan for an organization.
866
- *
867
- * @param {string} organizationId - Organization Unique ID
868
- * @param {string} billingPlan - Organization billing plan chosen
869
- * @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
870
- * @param {string} billingAddressId - Unique ID of billing address
871
- * @param {string[]} invites - Additional member invites
872
- * @param {string} couponId - Coupon id
873
- * @param {string} taxId - Tax Id associated to billing.
874
- * @param {number} budget - Budget limit for additional usage set for the organization
875
- * @throws {AppwriteException}
876
- * @returns {Promise<Models.Organization<Preferences>>}
877
- * @deprecated Use the object parameter style method for a better developer experience.
878
- */
879
- updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
880
- /**
881
- * Cancel the downgrade initiated for an organization.
882
- *
883
- * @param {string} params.organizationId - Organization Unique ID
884
- * @throws {AppwriteException}
885
- * @returns {Promise<Models.Organization<Preferences>>}
886
- */
887
- cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
888
- organizationId: string;
889
- }): Promise<Models.Organization<Preferences>>;
890
- /**
891
- * Cancel the downgrade initiated for an organization.
892
- *
893
- * @param {string} organizationId - Organization Unique ID
894
- * @throws {AppwriteException}
895
- * @returns {Promise<Models.Organization<Preferences>>}
896
- * @deprecated Use the object parameter style method for a better developer experience.
897
- */
898
- cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
899
- /**
900
- * Get all available regions for an organization.
901
- *
902
- * @param {string} params.organizationId - Team ID.
903
- * @throws {AppwriteException}
904
- * @returns {Promise<Models.ConsoleRegionList>}
905
- */
906
- listRegions(params: {
907
- organizationId: string;
908
- }): Promise<Models.ConsoleRegionList>;
909
- /**
910
- * Get all available regions for an organization.
911
- *
912
- * @param {string} organizationId - Team ID.
913
- * @throws {AppwriteException}
914
- * @returns {Promise<Models.ConsoleRegionList>}
915
- * @deprecated Use the object parameter style method for a better developer experience.
916
- */
917
- listRegions(organizationId: string): Promise<Models.ConsoleRegionList>;
918
- /**
919
- * Get Scopes
920
- *
921
- * @param {string} params.organizationId - Organization id
922
- * @param {string} params.projectId - Project id
923
- * @throws {AppwriteException}
924
- * @returns {Promise<Models.Roles>}
925
- */
926
- getScopes(params: {
927
- organizationId: string;
928
- projectId?: string;
929
- }): Promise<Models.Roles>;
930
- /**
931
- * Get Scopes
932
- *
933
- * @param {string} organizationId - Organization id
934
- * @param {string} projectId - Project id
935
- * @throws {AppwriteException}
936
- * @returns {Promise<Models.Roles>}
937
- * @deprecated Use the object parameter style method for a better developer experience.
938
- */
939
- getScopes(organizationId: string, projectId?: string): Promise<Models.Roles>;
940
- /**
941
- * Set an organization's billing tax ID.
942
- *
943
- * @param {string} params.organizationId - Organization ID
944
- * @param {string} params.taxId - Tax Id associated to billing.
945
- * @throws {AppwriteException}
946
- * @returns {Promise<Models.Organization<Preferences>>}
947
- */
948
- setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
949
- organizationId: string;
950
- taxId: string;
951
- }): Promise<Models.Organization<Preferences>>;
952
- /**
953
- * Set an organization's billing tax ID.
954
- *
955
- * @param {string} organizationId - Organization ID
956
- * @param {string} taxId - Tax Id associated to billing.
957
- * @throws {AppwriteException}
958
- * @returns {Promise<Models.Organization<Preferences>>}
959
- * @deprecated Use the object parameter style method for a better developer experience.
960
- */
961
- setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
962
- /**
963
- * Get the usage data for an organization.
964
- *
965
- * @param {string} params.organizationId - Organization ID
966
- * @param {string} params.startDate - Starting date for the usage
967
- * @param {string} params.endDate - End date for the usage
968
- * @throws {AppwriteException}
969
- * @returns {Promise<Models.UsageOrganization>}
970
- */
971
- getUsage(params: {
972
- organizationId: string;
973
- startDate?: string;
974
- endDate?: string;
975
- }): Promise<Models.UsageOrganization>;
976
- /**
977
- * Get the usage data for an organization.
978
- *
979
- * @param {string} organizationId - Organization ID
980
- * @param {string} startDate - Starting date for the usage
981
- * @param {string} endDate - End date for the usage
982
- * @throws {AppwriteException}
983
- * @returns {Promise<Models.UsageOrganization>}
984
- * @deprecated Use the object parameter style method for a better developer experience.
985
- */
986
- getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization>;
987
- /**
988
- * Validate payment for team after creation or upgrade.
989
- *
990
- * @param {string} params.organizationId - Organization ID
991
- * @param {string[]} params.invites - Additional member invites
992
- * @throws {AppwriteException}
993
- * @returns {Promise<Models.Organization<Preferences>>}
994
- */
995
- validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
996
- organizationId: string;
997
- invites?: string[];
998
- }): Promise<Models.Organization<Preferences>>;
999
- /**
1000
- * Validate payment for team after creation or upgrade.
1001
- *
1002
- * @param {string} organizationId - Organization ID
1003
- * @param {string[]} invites - Additional member invites
1004
- * @throws {AppwriteException}
1005
- * @returns {Promise<Models.Organization<Preferences>>}
1006
- * @deprecated Use the object parameter style method for a better developer experience.
1007
- */
1008
- validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>>;
1009
- }