You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/commands/account.js
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1679,13 +1679,13 @@ account
1679
1679
1680
1680
account
1681
1681
.command(`createMfaAuthenticator`)
1682
-
.description(`Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator) method.`)
1682
+
.description(`Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) method.`)
1683
1683
.requiredOption(`--type <type>`,`Type of authenticator. Must be 'totp'`)
.description(`Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#addAuthenticator) method.`)
1688
+
.description(`Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method. add `)
1689
1689
.requiredOption(`--type <type>`,`Type of authenticator.`)
* @property {number} width Image width. Pass an integer between 0 to 2000. Defaults to 100.
94
94
* @property {number} height Image height. Pass an integer between 0 to 2000. Defaults to 100.
95
95
* @property {number} quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
@@ -384,7 +384,7 @@ avatars
384
384
avatars
385
385
.command(`getCreditCard`)
386
386
.description(`The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings. When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px. `)
* @property {string[]} targets List of Targets IDs.
86
86
* @property {string[]} cc Array of target IDs to be added as CC.
87
87
* @property {string[]} bcc Array of target IDs to be added as BCC.
88
-
* @property {string[]} attachments Array of compound bucket IDs to file IDs to be attached to the email.
88
+
* @property {string[]} attachments Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
89
89
* @property {boolean} draft Is message a draft
90
90
* @property {boolean} html Is content of type HTML
91
91
* @property {string} scheduledAt Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
* @property {string[]} cc Array of target IDs to be added as CC.
171
171
* @property {string[]} bcc Array of target IDs to be added as BCC.
172
172
* @property {string} scheduledAt Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
173
+
* @property {string[]} attachments Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
* @property {string[]} targets List of Targets IDs.
242
247
* @property {object} data Additional Data for push notification.
243
248
* @property {string} action Action for push notification.
244
-
* @property {string} image Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage.
249
+
* @property {string} image Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
245
250
* @property {string} icon Icon for push notification. Available only for Android and Web Platform.
246
251
* @property {string} sound Sound for push notification. Available only for Android and IOS Platform.
247
252
* @property {string} color Color for push notification. Available only for Android Platform.
* @property {string} body Body for push notification.
337
342
* @property {object} data Additional Data for push notification.
338
343
* @property {string} action Action for push notification.
339
-
* @property {string} image Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage.
344
+
* @property {string} image Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
340
345
* @property {string} icon Icon for push notification. Available only for Android and Web platforms.
341
346
* @property {string} sound Sound for push notification. Available only for Android and iOS platforms.
342
347
* @property {string} color Color for push notification. Available only for Android platforms.
* @property {string} providerId Provider 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.
1034
1039
* @property {string} name Provider name.
1035
-
* @property {string} from Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
.option(`--targets [targets...]`,`List of Targets IDs.`)
2298
2303
.option(`--cc [cc...]`,`Array of target IDs to be added as CC.`)
2299
2304
.option(`--bcc [bcc...]`,`Array of target IDs to be added as BCC.`)
2300
-
.option(`--attachments [attachments...]`,`Array of compound bucket IDs to file IDs to be attached to the email.`)
2305
+
.option(`--attachments [attachments...]`,`Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.`)
2301
2306
.option(`--draft <draft>`,`Is message a draft`,parseBool)
2302
2307
.option(`--html <html>`,`Is content of type HTML`,parseBool)
2303
2308
.option(`--scheduledAt <scheduledAt>`,`Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.`)
@@ -2317,6 +2322,7 @@ messaging
2317
2322
.option(`--cc [cc...]`,`Array of target IDs to be added as CC.`)
2318
2323
.option(`--bcc [bcc...]`,`Array of target IDs to be added as BCC.`)
2319
2324
.option(`--scheduledAt <scheduledAt>`,`Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.`)
2325
+
.option(`--attachments [attachments...]`,`Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.`)
2320
2326
.action(actionRunner(messagingUpdateEmail))
2321
2327
2322
2328
messaging
@@ -2330,7 +2336,7 @@ messaging
2330
2336
.option(`--targets [targets...]`,`List of Targets IDs.`)
2331
2337
.option(`--data <data>`,`Additional Data for push notification.`)
2332
2338
.option(`--action <action>`,`Action for push notification.`)
2333
-
.option(`--image <image>`,`Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage.`)
2339
+
.option(`--image <image>`,`Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.`)
2334
2340
.option(`--icon <icon>`,`Icon for push notification. Available only for Android and Web Platform.`)
2335
2341
.option(`--sound <sound>`,`Sound for push notification. Available only for Android and IOS Platform.`)
2336
2342
.option(`--color <color>`,`Color for push notification. Available only for Android Platform.`)
@@ -2351,7 +2357,7 @@ messaging
2351
2357
.option(`--body <body>`,`Body for push notification.`)
2352
2358
.option(`--data <data>`,`Additional Data for push notification.`)
2353
2359
.option(`--action <action>`,`Action for push notification.`)
2354
-
.option(`--image <image>`,`Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage.`)
2360
+
.option(`--image <image>`,`Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.`)
2355
2361
.option(`--icon <icon>`,`Icon for push notification. Available only for Android and Web platforms.`)
2356
2362
.option(`--sound <sound>`,`Sound for push notification. Available only for Android and iOS platforms.`)
2357
2363
.option(`--color <color>`,`Color for push notification. Available only for Android platforms.`)
@@ -2497,9 +2503,9 @@ messaging
2497
2503
.description(`Create a new MSG91 provider.`)
2498
2504
.requiredOption(`--providerId <providerId>`,`Provider 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.`)
2499
2505
.requiredOption(`--name <name>`,`Provider name.`)
2500
-
.option(`--from <from>`,`Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
Copy file name to clipboardExpand all lines: lib/commands/users.js
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1823,7 +1823,7 @@ users
1823
1823
1824
1824
users
1825
1825
.command(`createToken`)
1826
-
.description(`Returns a token with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [PUT /account/sessions/custom](https://appwrite.io/docs/references/cloud/client-web/account#updateCustomSession) endpoint to complete the login process.`)
1826
+
.description(`Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process.`)
1827
1827
.requiredOption(`--userId <userId>`,`User ID.`)
1828
1828
.option(`--length <length>`,`Token length in characters. The default length is 6 characters`,parseInteger)
1829
1829
.option(`--expire <expire>`,`Token expiration period in seconds. The default expiration is 15 minutes.`,parseInteger)
0 commit comments