@appwrite.io/console 1.0.1 → 1.1.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/cjs/sdk.js +3565 -2411
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +3564 -2412
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +3565 -2411
- package/docs/examples/{functions/list-specifications.md → account/create-payment-method.md} +3 -3
- package/docs/examples/account/delete-mfa-authenticator.md +2 -1
- package/docs/examples/account/delete-payment-method.md +13 -0
- package/docs/examples/account/get-billing-address.md +13 -0
- package/docs/examples/account/get-payment-method.md +13 -0
- package/docs/examples/{functions/get-template.md → account/list-billing-addresses.md} +4 -4
- package/docs/examples/account/list-credits.md +14 -0
- package/docs/examples/account/list-invoices.md +13 -0
- package/docs/examples/account/list-payment-methods.md +13 -0
- package/docs/examples/account/update-payment-method-mandate-options.md +13 -0
- package/docs/examples/account/update-payment-method-provider.md +15 -0
- package/docs/examples/account/update-payment-method.md +15 -0
- package/docs/examples/backups/create-archive.md +14 -0
- package/docs/examples/backups/create-policy.md +19 -0
- package/docs/examples/backups/create-restoration.md +16 -0
- package/docs/examples/backups/delete-archive.md +13 -0
- package/docs/examples/backups/delete-policy.md +13 -0
- package/docs/examples/backups/get-archive.md +13 -0
- package/docs/examples/backups/get-policy.md +13 -0
- package/docs/examples/backups/get-restoration.md +13 -0
- package/docs/examples/backups/list-archives.md +13 -0
- package/docs/examples/backups/list-policies.md +13 -0
- package/docs/examples/backups/list-restorations.md +13 -0
- package/docs/examples/backups/update-policy.md +17 -0
- package/docs/examples/console/create-source.md +17 -0
- package/docs/examples/console/get-copon.md +13 -0
- package/docs/examples/console/plans.md +11 -0
- package/docs/examples/console/regions.md +11 -0
- package/docs/examples/functions/create-build.md +1 -1
- package/docs/examples/functions/create-execution.md +1 -2
- package/docs/examples/functions/create.md +1 -3
- package/docs/examples/functions/{get-deployment-download.md → download-deployment.md} +1 -1
- package/docs/examples/functions/update.md +1 -3
- package/docs/examples/organizations/add-credit.md +14 -0
- package/docs/examples/organizations/create-invoice-payment.md +15 -0
- package/docs/examples/organizations/create.md +17 -0
- package/docs/examples/organizations/delete-backup-payment-method.md +13 -0
- package/docs/examples/organizations/delete-billing-address.md +13 -0
- package/docs/examples/organizations/delete-default-payment-method.md +13 -0
- package/docs/examples/organizations/delete.md +13 -0
- package/docs/examples/organizations/get-aggregation.md +14 -0
- package/docs/examples/organizations/get-billing-address.md +14 -0
- package/docs/examples/organizations/get-credit.md +14 -0
- package/docs/examples/organizations/get-invoice-download.md +14 -0
- package/docs/examples/organizations/get-invoice-view.md +14 -0
- package/docs/examples/organizations/get-invoice.md +14 -0
- package/docs/examples/organizations/get-payment-method.md +14 -0
- package/docs/examples/organizations/get-plan.md +13 -0
- package/docs/examples/organizations/get-usage.md +15 -0
- package/docs/examples/organizations/list-aggregations.md +14 -0
- package/docs/examples/organizations/list-invoices.md +14 -0
- package/docs/examples/organizations/list.md +14 -0
- package/docs/examples/organizations/set-backup-payment-method.md +14 -0
- package/docs/examples/organizations/set-billing-address.md +14 -0
- package/docs/examples/organizations/set-billing-email.md +14 -0
- package/docs/examples/organizations/set-billing-tax-id.md +14 -0
- package/docs/examples/organizations/set-default-payment-method.md +14 -0
- package/docs/examples/organizations/update-budget.md +15 -0
- package/docs/examples/organizations/update-plan.md +16 -0
- package/package.json +1 -1
- package/src/client.ts +2 -2
- package/src/enums/billing-plan.ts +5 -0
- package/src/enums/email-template-type.ts +0 -2
- package/src/enums/platform-type.ts +0 -2
- package/src/enums/runtime.ts +0 -1
- package/src/index.ts +4 -1
- package/src/models.ts +956 -282
- package/src/services/account.ts +345 -2
- package/src/services/backups.ts +425 -0
- package/src/services/console.ts +120 -0
- package/src/services/functions.ts +14 -195
- package/src/services/organizations.ts +896 -0
- package/src/services/projects.ts +1 -110
- package/src/services/users.ts +0 -37
- package/src/services/vcs.ts +0 -36
- package/types/enums/billing-plan.d.ts +5 -0
- package/types/enums/email-template-type.d.ts +1 -3
- package/types/enums/platform-type.d.ts +1 -3
- package/types/enums/runtime.d.ts +1 -2
- package/types/index.d.ts +4 -1
- package/types/models.d.ts +956 -282
- package/types/services/account.d.ts +105 -1
- package/types/services/backups.d.ts +128 -0
- package/types/services/console.d.ts +38 -0
- package/types/services/functions.d.ts +8 -67
- package/types/services/organizations.d.ts +273 -0
- package/types/services/projects.d.ts +1 -32
- package/types/services/users.d.ts +0 -12
- package/types/services/vcs.d.ts +0 -11
- package/docs/examples/functions/delete-execution.md +0 -14
- package/docs/examples/functions/list-templates.md +0 -16
- package/docs/examples/functions/update-deployment-build.md +0 -14
- package/docs/examples/projects/create-j-w-t.md +0 -15
- package/docs/examples/projects/update-mock-numbers.md +0 -14
- package/docs/examples/projects/update-session-alerts.md +0 -14
- package/docs/examples/users/create-j-w-t.md +0 -15
- package/docs/examples/vcs/get-repository-contents.md +0 -15
|
@@ -37,6 +37,24 @@ export declare class Account {
|
|
|
37
37
|
* @returns {Promise<{}>}
|
|
38
38
|
*/
|
|
39
39
|
delete(): Promise<{}>;
|
|
40
|
+
/**
|
|
41
|
+
* List billing addresses
|
|
42
|
+
*
|
|
43
|
+
*
|
|
44
|
+
* @param {string[]} queries
|
|
45
|
+
* @throws {AppwriteException}
|
|
46
|
+
* @returns {Promise<Models.BillingAddress>}
|
|
47
|
+
*/
|
|
48
|
+
listBillingAddresses(queries?: string[]): Promise<Models.BillingAddress>;
|
|
49
|
+
/**
|
|
50
|
+
* Get billing address
|
|
51
|
+
*
|
|
52
|
+
*
|
|
53
|
+
* @param {string} billingAddressId
|
|
54
|
+
* @throws {AppwriteException}
|
|
55
|
+
* @returns {Promise<Models.BillingAddress>}
|
|
56
|
+
*/
|
|
57
|
+
getBillingAddress(billingAddressId: string): Promise<Models.BillingAddress>;
|
|
40
58
|
/**
|
|
41
59
|
* Update email
|
|
42
60
|
*
|
|
@@ -70,6 +88,15 @@ This endpoint can also be used to convert an anonymous account to a normal one,
|
|
|
70
88
|
* @returns {Promise<{}>}
|
|
71
89
|
*/
|
|
72
90
|
deleteIdentity(identityId: string): Promise<{}>;
|
|
91
|
+
/**
|
|
92
|
+
* List invoices
|
|
93
|
+
*
|
|
94
|
+
*
|
|
95
|
+
* @param {string[]} queries
|
|
96
|
+
* @throws {AppwriteException}
|
|
97
|
+
* @returns {Promise<Models.InvoiceList>}
|
|
98
|
+
*/
|
|
99
|
+
listInvoices(queries?: string[]): Promise<Models.InvoiceList>;
|
|
73
100
|
/**
|
|
74
101
|
* Create JWT
|
|
75
102
|
*
|
|
@@ -126,10 +153,11 @@ This endpoint can also be used to convert an anonymous account to a normal one,
|
|
|
126
153
|
* Delete an authenticator for a user by ID.
|
|
127
154
|
*
|
|
128
155
|
* @param {AuthenticatorType} type
|
|
156
|
+
* @param {string} otp
|
|
129
157
|
* @throws {AppwriteException}
|
|
130
158
|
* @returns {Promise<{}>}
|
|
131
159
|
*/
|
|
132
|
-
deleteMfaAuthenticator(type: AuthenticatorType): Promise<{}>;
|
|
160
|
+
deleteMfaAuthenticator(type: AuthenticatorType, otp: string): Promise<{}>;
|
|
133
161
|
/**
|
|
134
162
|
* Create MFA Challenge
|
|
135
163
|
*
|
|
@@ -208,6 +236,72 @@ This endpoint can also be used to convert an anonymous account to a normal one,
|
|
|
208
236
|
* @returns {Promise<Models.User<Preferences>>}
|
|
209
237
|
*/
|
|
210
238
|
updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>>;
|
|
239
|
+
/**
|
|
240
|
+
* List payment methods
|
|
241
|
+
*
|
|
242
|
+
*
|
|
243
|
+
* @param {string[]} queries
|
|
244
|
+
* @throws {AppwriteException}
|
|
245
|
+
* @returns {Promise<Models.PaymentMethodList>}
|
|
246
|
+
*/
|
|
247
|
+
listPaymentMethods(queries?: string[]): Promise<Models.PaymentMethodList>;
|
|
248
|
+
/**
|
|
249
|
+
* Create new payment method
|
|
250
|
+
*
|
|
251
|
+
*
|
|
252
|
+
* @throws {AppwriteException}
|
|
253
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
254
|
+
*/
|
|
255
|
+
createPaymentMethod(): Promise<Models.PaymentMethod>;
|
|
256
|
+
/**
|
|
257
|
+
* Get payment method
|
|
258
|
+
*
|
|
259
|
+
*
|
|
260
|
+
* @param {string} paymentMethodId
|
|
261
|
+
* @throws {AppwriteException}
|
|
262
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
263
|
+
*/
|
|
264
|
+
getPaymentMethod(paymentMethodId: string): Promise<Models.PaymentMethod>;
|
|
265
|
+
/**
|
|
266
|
+
* Update payment method
|
|
267
|
+
*
|
|
268
|
+
*
|
|
269
|
+
* @param {string} paymentMethodId
|
|
270
|
+
* @param {number} expiryMonth
|
|
271
|
+
* @param {number} expiryYear
|
|
272
|
+
* @throws {AppwriteException}
|
|
273
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
274
|
+
*/
|
|
275
|
+
updatePaymentMethod(paymentMethodId: string, expiryMonth: number, expiryYear: number): Promise<Models.PaymentMethod>;
|
|
276
|
+
/**
|
|
277
|
+
* Delete payment method
|
|
278
|
+
*
|
|
279
|
+
*
|
|
280
|
+
* @param {string} paymentMethodId
|
|
281
|
+
* @throws {AppwriteException}
|
|
282
|
+
* @returns {Promise<{}>}
|
|
283
|
+
*/
|
|
284
|
+
deletePaymentMethod(paymentMethodId: string): Promise<{}>;
|
|
285
|
+
/**
|
|
286
|
+
* Update payment method provider id
|
|
287
|
+
*
|
|
288
|
+
*
|
|
289
|
+
* @param {string} paymentMethodId
|
|
290
|
+
* @param {string} providerMethodId
|
|
291
|
+
* @param {string} name
|
|
292
|
+
* @throws {AppwriteException}
|
|
293
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
294
|
+
*/
|
|
295
|
+
updatePaymentMethodProvider(paymentMethodId: string, providerMethodId: string, name: string): Promise<Models.PaymentMethod>;
|
|
296
|
+
/**
|
|
297
|
+
* Update payment method with new setup with mandates for indian cards
|
|
298
|
+
*
|
|
299
|
+
*
|
|
300
|
+
* @param {string} paymentMethodId
|
|
301
|
+
* @throws {AppwriteException}
|
|
302
|
+
* @returns {Promise<Models.PaymentMethod>}
|
|
303
|
+
*/
|
|
304
|
+
updatePaymentMethodMandateOptions(paymentMethodId: string): Promise<Models.PaymentMethod>;
|
|
211
305
|
/**
|
|
212
306
|
* Update phone
|
|
213
307
|
*
|
|
@@ -527,4 +621,14 @@ Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/
|
|
|
527
621
|
* @returns {Promise<Models.Token>}
|
|
528
622
|
*/
|
|
529
623
|
updatePhoneVerification(userId: string, secret: string): Promise<Models.Token>;
|
|
624
|
+
/**
|
|
625
|
+
* List credits
|
|
626
|
+
*
|
|
627
|
+
*
|
|
628
|
+
* @param {string} organizationId
|
|
629
|
+
* @param {string[]} queries
|
|
630
|
+
* @throws {AppwriteException}
|
|
631
|
+
* @returns {Promise<Models.CreditList>}
|
|
632
|
+
*/
|
|
633
|
+
listCredits(organizationId: string, queries?: string[]): Promise<Models.CreditList>;
|
|
530
634
|
}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
export declare class Backups {
|
|
4
|
+
client: Client;
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* Create archive
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* @param {string[]} services
|
|
11
|
+
* @param {string} resourceId
|
|
12
|
+
* @throws {AppwriteException}
|
|
13
|
+
* @returns {Promise<Models.BackupArchive>}
|
|
14
|
+
*/
|
|
15
|
+
createArchive(services: string[], resourceId?: string): Promise<Models.BackupArchive>;
|
|
16
|
+
/**
|
|
17
|
+
* Delete archive
|
|
18
|
+
*
|
|
19
|
+
*
|
|
20
|
+
* @param {string} archiveId
|
|
21
|
+
* @throws {AppwriteException}
|
|
22
|
+
* @returns {Promise<{}>}
|
|
23
|
+
*/
|
|
24
|
+
deleteArchive(archiveId: string): Promise<{}>;
|
|
25
|
+
/**
|
|
26
|
+
* List archives
|
|
27
|
+
*
|
|
28
|
+
*
|
|
29
|
+
* @param {string[]} queries
|
|
30
|
+
* @throws {AppwriteException}
|
|
31
|
+
* @returns {Promise<Models.BackupArchiveList>}
|
|
32
|
+
*/
|
|
33
|
+
listArchives(queries?: string[]): Promise<Models.BackupArchiveList>;
|
|
34
|
+
/**
|
|
35
|
+
* Get backup archive
|
|
36
|
+
*
|
|
37
|
+
*
|
|
38
|
+
* @param {string} archiveId
|
|
39
|
+
* @throws {AppwriteException}
|
|
40
|
+
* @returns {Promise<Models.BackupArchive>}
|
|
41
|
+
*/
|
|
42
|
+
getArchive(archiveId: string): Promise<Models.BackupArchive>;
|
|
43
|
+
/**
|
|
44
|
+
* List backup policies
|
|
45
|
+
*
|
|
46
|
+
*
|
|
47
|
+
* @param {string[]} queries
|
|
48
|
+
* @throws {AppwriteException}
|
|
49
|
+
* @returns {Promise<Models.BackupPolicyList>}
|
|
50
|
+
*/
|
|
51
|
+
listPolicies(queries?: string[]): Promise<Models.BackupPolicyList>;
|
|
52
|
+
/**
|
|
53
|
+
* Create backup policy
|
|
54
|
+
*
|
|
55
|
+
*
|
|
56
|
+
* @param {string} policyId
|
|
57
|
+
* @param {string[]} services
|
|
58
|
+
* @param {number} retention
|
|
59
|
+
* @param {string} schedule
|
|
60
|
+
* @param {string} name
|
|
61
|
+
* @param {string} resourceId
|
|
62
|
+
* @param {boolean} enabled
|
|
63
|
+
* @throws {AppwriteException}
|
|
64
|
+
* @returns {Promise<Models.BackupPolicy>}
|
|
65
|
+
*/
|
|
66
|
+
createPolicy(policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
|
|
67
|
+
/**
|
|
68
|
+
* Get backup policy
|
|
69
|
+
*
|
|
70
|
+
*
|
|
71
|
+
* @param {string} policyId
|
|
72
|
+
* @throws {AppwriteException}
|
|
73
|
+
* @returns {Promise<Models.BackupPolicy>}
|
|
74
|
+
*/
|
|
75
|
+
getPolicy(policyId: string): Promise<Models.BackupPolicy>;
|
|
76
|
+
/**
|
|
77
|
+
* Update backup policy
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* @param {string} policyId
|
|
81
|
+
* @param {string} name
|
|
82
|
+
* @param {number} retention
|
|
83
|
+
* @param {string} schedule
|
|
84
|
+
* @param {boolean} enabled
|
|
85
|
+
* @throws {AppwriteException}
|
|
86
|
+
* @returns {Promise<Models.BackupPolicy>}
|
|
87
|
+
*/
|
|
88
|
+
updatePolicy(policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
|
|
89
|
+
/**
|
|
90
|
+
* Delete backup policy
|
|
91
|
+
*
|
|
92
|
+
*
|
|
93
|
+
* @param {string} policyId
|
|
94
|
+
* @throws {AppwriteException}
|
|
95
|
+
* @returns {Promise<{}>}
|
|
96
|
+
*/
|
|
97
|
+
deletePolicy(policyId: string): Promise<{}>;
|
|
98
|
+
/**
|
|
99
|
+
* Create restoration
|
|
100
|
+
*
|
|
101
|
+
*
|
|
102
|
+
* @param {string} archiveId
|
|
103
|
+
* @param {string[]} services
|
|
104
|
+
* @param {string} newResourceId
|
|
105
|
+
* @param {string} newResourceName
|
|
106
|
+
* @throws {AppwriteException}
|
|
107
|
+
* @returns {Promise<Models.BackupRestoration>}
|
|
108
|
+
*/
|
|
109
|
+
createRestoration(archiveId: string, services: string[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
|
|
110
|
+
/**
|
|
111
|
+
* List restorations
|
|
112
|
+
*
|
|
113
|
+
*
|
|
114
|
+
* @param {string[]} queries
|
|
115
|
+
* @throws {AppwriteException}
|
|
116
|
+
* @returns {Promise<Models.BackupRestorationList>}
|
|
117
|
+
*/
|
|
118
|
+
listRestorations(queries?: string[]): Promise<Models.BackupRestorationList>;
|
|
119
|
+
/**
|
|
120
|
+
* Get backup restoration
|
|
121
|
+
*
|
|
122
|
+
*
|
|
123
|
+
* @param {string} restorationId
|
|
124
|
+
* @throws {AppwriteException}
|
|
125
|
+
* @returns {Promise<Models.BackupArchive>}
|
|
126
|
+
*/
|
|
127
|
+
getRestoration(restorationId: string): Promise<Models.BackupArchive>;
|
|
128
|
+
}
|
|
@@ -3,6 +3,44 @@ import type { Models } from '../models';
|
|
|
3
3
|
export declare class Console {
|
|
4
4
|
client: Client;
|
|
5
5
|
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* Get coupon details
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* @param {string} couponId
|
|
11
|
+
* @throws {AppwriteException}
|
|
12
|
+
* @returns {Promise<Models.Coupon>}
|
|
13
|
+
*/
|
|
14
|
+
getCopon(couponId: string): Promise<Models.Coupon>;
|
|
15
|
+
/**
|
|
16
|
+
* Get plans
|
|
17
|
+
*
|
|
18
|
+
*
|
|
19
|
+
* @throws {AppwriteException}
|
|
20
|
+
* @returns {Promise<Models.BillingPlanList>}
|
|
21
|
+
*/
|
|
22
|
+
plans(): Promise<Models.BillingPlanList>;
|
|
23
|
+
/**
|
|
24
|
+
* Get Regions
|
|
25
|
+
*
|
|
26
|
+
*
|
|
27
|
+
* @throws {AppwriteException}
|
|
28
|
+
* @returns {Promise<Models.ConsoleRegionList>}
|
|
29
|
+
*/
|
|
30
|
+
regions(): Promise<Models.ConsoleRegionList>;
|
|
31
|
+
/**
|
|
32
|
+
* Create source
|
|
33
|
+
*
|
|
34
|
+
*
|
|
35
|
+
* @param {string} ref
|
|
36
|
+
* @param {string} referrer
|
|
37
|
+
* @param {string} utmSource
|
|
38
|
+
* @param {string} utmCampaign
|
|
39
|
+
* @param {string} utmMedium
|
|
40
|
+
* @throws {AppwriteException}
|
|
41
|
+
* @returns {Promise<{}>}
|
|
42
|
+
*/
|
|
43
|
+
createSource(ref?: string, referrer?: string, utmSource?: string, utmCampaign?: string, utmMedium?: string): Promise<{}>;
|
|
6
44
|
/**
|
|
7
45
|
* Get variables
|
|
8
46
|
*
|
|
@@ -33,7 +33,6 @@ export declare class Functions {
|
|
|
33
33
|
* @param {boolean} logging
|
|
34
34
|
* @param {string} entrypoint
|
|
35
35
|
* @param {string} commands
|
|
36
|
-
* @param {string[]} scopes
|
|
37
36
|
* @param {string} installationId
|
|
38
37
|
* @param {string} providerRepositoryId
|
|
39
38
|
* @param {string} providerBranch
|
|
@@ -42,12 +41,11 @@ export declare class Functions {
|
|
|
42
41
|
* @param {string} templateRepository
|
|
43
42
|
* @param {string} templateOwner
|
|
44
43
|
* @param {string} templateRootDirectory
|
|
45
|
-
* @param {string}
|
|
46
|
-
* @param {string} specification
|
|
44
|
+
* @param {string} templateBranch
|
|
47
45
|
* @throws {AppwriteException}
|
|
48
46
|
* @returns {Promise<Models.Function>}
|
|
49
47
|
*/
|
|
50
|
-
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string,
|
|
48
|
+
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string): Promise<Models.Function>;
|
|
51
49
|
/**
|
|
52
50
|
* List runtimes
|
|
53
51
|
*
|
|
@@ -57,39 +55,6 @@ export declare class Functions {
|
|
|
57
55
|
* @returns {Promise<Models.RuntimeList>}
|
|
58
56
|
*/
|
|
59
57
|
listRuntimes(): Promise<Models.RuntimeList>;
|
|
60
|
-
/**
|
|
61
|
-
* List available function runtime specifications
|
|
62
|
-
*
|
|
63
|
-
* List allowed function specifications for this instance.
|
|
64
|
-
|
|
65
|
-
*
|
|
66
|
-
* @throws {AppwriteException}
|
|
67
|
-
* @returns {Promise<Models.SpecificationList>}
|
|
68
|
-
*/
|
|
69
|
-
listSpecifications(): Promise<Models.SpecificationList>;
|
|
70
|
-
/**
|
|
71
|
-
* List function templates
|
|
72
|
-
*
|
|
73
|
-
* List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
74
|
-
*
|
|
75
|
-
* @param {string[]} runtimes
|
|
76
|
-
* @param {string[]} useCases
|
|
77
|
-
* @param {number} limit
|
|
78
|
-
* @param {number} offset
|
|
79
|
-
* @throws {AppwriteException}
|
|
80
|
-
* @returns {Promise<Models.TemplateFunctionList>}
|
|
81
|
-
*/
|
|
82
|
-
listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateFunctionList>;
|
|
83
|
-
/**
|
|
84
|
-
* Get function template
|
|
85
|
-
*
|
|
86
|
-
* Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
87
|
-
*
|
|
88
|
-
* @param {string} templateId
|
|
89
|
-
* @throws {AppwriteException}
|
|
90
|
-
* @returns {Promise<Models.TemplateFunction>}
|
|
91
|
-
*/
|
|
92
|
-
getTemplate(templateId: string): Promise<Models.TemplateFunction>;
|
|
93
58
|
/**
|
|
94
59
|
* Get functions usage
|
|
95
60
|
*
|
|
@@ -125,17 +90,15 @@ export declare class Functions {
|
|
|
125
90
|
* @param {boolean} logging
|
|
126
91
|
* @param {string} entrypoint
|
|
127
92
|
* @param {string} commands
|
|
128
|
-
* @param {string[]} scopes
|
|
129
93
|
* @param {string} installationId
|
|
130
94
|
* @param {string} providerRepositoryId
|
|
131
95
|
* @param {string} providerBranch
|
|
132
96
|
* @param {boolean} providerSilentMode
|
|
133
97
|
* @param {string} providerRootDirectory
|
|
134
|
-
* @param {string} specification
|
|
135
98
|
* @throws {AppwriteException}
|
|
136
99
|
* @returns {Promise<Models.Function>}
|
|
137
100
|
*/
|
|
138
|
-
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string,
|
|
101
|
+
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
|
|
139
102
|
/**
|
|
140
103
|
* Delete function
|
|
141
104
|
*
|
|
@@ -210,8 +173,9 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
210
173
|
*/
|
|
211
174
|
deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
|
|
212
175
|
/**
|
|
213
|
-
*
|
|
176
|
+
* Create build
|
|
214
177
|
*
|
|
178
|
+
* Create a new build for an Appwrite Function deployment. This endpoint can be used to retry a failed build.
|
|
215
179
|
*
|
|
216
180
|
* @param {string} functionId
|
|
217
181
|
* @param {string} deploymentId
|
|
@@ -219,17 +183,7 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
219
183
|
* @throws {AppwriteException}
|
|
220
184
|
* @returns {Promise<{}>}
|
|
221
185
|
*/
|
|
222
|
-
createBuild(functionId: string, deploymentId: string, buildId
|
|
223
|
-
/**
|
|
224
|
-
* Cancel deployment
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
* @param {string} functionId
|
|
228
|
-
* @param {string} deploymentId
|
|
229
|
-
* @throws {AppwriteException}
|
|
230
|
-
* @returns {Promise<Models.Build>}
|
|
231
|
-
*/
|
|
232
|
-
updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
|
|
186
|
+
createBuild(functionId: string, deploymentId: string, buildId: string): Promise<{}>;
|
|
233
187
|
/**
|
|
234
188
|
* Download deployment
|
|
235
189
|
*
|
|
@@ -240,7 +194,7 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
240
194
|
* @throws {AppwriteException}
|
|
241
195
|
* @returns {string}
|
|
242
196
|
*/
|
|
243
|
-
|
|
197
|
+
downloadDeployment(functionId: string, deploymentId: string): string;
|
|
244
198
|
/**
|
|
245
199
|
* List executions
|
|
246
200
|
*
|
|
@@ -264,11 +218,10 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
264
218
|
* @param {string} xpath
|
|
265
219
|
* @param {ExecutionMethod} method
|
|
266
220
|
* @param {object} headers
|
|
267
|
-
* @param {string} scheduledAt
|
|
268
221
|
* @throws {AppwriteException}
|
|
269
222
|
* @returns {Promise<Models.Execution>}
|
|
270
223
|
*/
|
|
271
|
-
createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object
|
|
224
|
+
createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution>;
|
|
272
225
|
/**
|
|
273
226
|
* Get execution
|
|
274
227
|
*
|
|
@@ -280,18 +233,6 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
280
233
|
* @returns {Promise<Models.Execution>}
|
|
281
234
|
*/
|
|
282
235
|
getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
|
|
283
|
-
/**
|
|
284
|
-
* Delete execution
|
|
285
|
-
*
|
|
286
|
-
* Delete a function execution by its unique ID.
|
|
287
|
-
|
|
288
|
-
*
|
|
289
|
-
* @param {string} functionId
|
|
290
|
-
* @param {string} executionId
|
|
291
|
-
* @throws {AppwriteException}
|
|
292
|
-
* @returns {Promise<{}>}
|
|
293
|
-
*/
|
|
294
|
-
deleteExecution(functionId: string, executionId: string): Promise<{}>;
|
|
295
236
|
/**
|
|
296
237
|
* Get function usage
|
|
297
238
|
*
|